search

vectara / create-ui

Generate a working React codebase for a range of generative and semantic search UIs
https://vectara.github.io/create-ui
Apache License 2.0
69 stars 12 forks source link

Improve usability of CL prompts #1

Closed cjcenizal closed 10 months ago

cjcenizal commented 1 year ago

Language

Can we use the term "UI" instead of "application"? I think this will reinforce the purpose of this tool.

Introduction and options

? Welcome to Vectara's UI Creator!
Press Enter to continue.

This initial intro seems like it slows me down without providing a ton of value. Is there any way to dive right into a prompt?

Additionally, I liked having all of the options shown up-front instead of having to choose between "Custom" and "Sample". Seeing those two options made me pause and ask myself, "What's the difference between these two?" By presenting all options up-front I can make a decision by comparing options. It's analogous to someone at a restaurant asking, "Would you like the breakfast menu or the brunch menu?" -- I'd rather see both and then choose the option that looks best.

Ideally, this is what the prompt would look like:

? Welcome to Vectara's UI Creator! What kind of UI do you want to create? (Use arrow keys)
❯ Custom Search and Summarization UI
  Sample UI: Docs - Answer questions about Vectara's technical documentation
  Sample UI: Corporate Q&A - Answer questions about Vectara as a company
  Sample UI: Academic Q&A - Answer questions about Richard Feynman's lectures

If it's not possible to ask a question right out of the gate, then maybe we can add more information to the intro:

? Welcome to Vectara's UI Creator! This is a tool for rapidly building and trying out UIs that are powered by the Vectara Platform.
Press Enter to continue.

Custom application

? Custom Application
? What directory name would you like to use? myui
? What would you like to name your application? myui
? What's your Vectara Customer ID? 6
? What Vectara Corpus ID is associated with your data? 6
? What is your Vectara QueryService API Key (This can be safely shared)? 56
? Would you like to add sample questions for your users? No

This felt like a lot to me. Can we condense this a bit and leverage defaults so folks can just skip through? For example:

? Custom Search and Summarization UI
? What's the human-readable name of this UI? // We can convert this name to snake-case and use it for the directory name. The user can always rename it if they want.
? What's your Vectara Customer ID? Defaults to a placeholder value. // Let the user skip this if they want to manually fill it in
? What's the Corpus ID of your data store? Defaults to a placeholder value. // Let the user skip this if they want to manually fill it in
? What's the API Key for this data store and has QueryService permissions? Defaults to a placeholder value. // Let the user skip this if they want to manually fill it in

I think we can skip the "Sample questions" bit and expect the user to manually edit them.

The phrasing with these parentheses looks weird to me. I'm guessing there's no way to split this into two sentences?

? What is your Vectara QueryService API Key (This can be safely shared)?

If you don't like my phrasing in the preceding suggestion, maybe we can hack this one a bit by reversing the order of the info:

? API Keys with QueryService permission can be used in public-facing UIs, as long as the data isn't sensitive. What's the API Key for this data store?