Skip to content

Setting Up Prompts

Before you Begin

Before you create or edit Prompts, make sure you have the following in place:

  • A Knowledge Base (for certain Prompt types) — Pre-Processing Prompts can search the Knowledge Base, and Answer Generation Prompts turn Knowledge Base content into customer responses. Confirm the relevant Knowledge Base is set up before configuring Prompts that depend on it.
  • The details each Prompt requires — Have the Prompt's name, description, type, API, and model ready before you start, so you can complete the configuration in one pass.
  • An understanding of Prompt types — Decide whether you're building a Pre-Processing Prompt (to collect information, ask follow-up questions, detect intent, or search the Knowledge Base) or an Answer Generation Prompt (to generate customer-facing responses).
  • Familiarity with prompt engineering — For guidance on writing effective Prompts, review the Prompt engineering overview.

Limits and Constraints

Keep the following in mind when working with Prompts:

  • Version limit — You can have up to 50 versions of a Prompt at one time.
  • Template dependency — Creating a Prompt requires selecting a Prompt Template as a starting point, which then populates the Prompt Template box for editing.
  • Templates must be YAML — The Prompt Template has to be valid YAML. If it isn't, the Prompt won't save.
  • Supported models only — The Model dropdown lists only the models Q in Connect currently accepts. If a Prompt is still on a model that has since been retired, the Model dropdown reads "[model] (retired) - select a model" and the Prompt can't be saved until you choose a supported model.

Step-by-Step Instructions

Create a Prompt

  1. In the left menu, expand Q in Connect.
  2. Click Prompts.
  3. Click Create Prompt.
  4. Enter the Prompt Name and Description.
  5. Choose the Prompt Type, API, and Model.
  6. Choose a Prompt Template. The template automatically populates in the Prompt Template box.
  7. Edit the Prompt to match the needed functionality.
  8. Click Save Prompt to apply your changes. The new Prompt is created and you return to the Prompt list.

Edit a Prompt

  1. In the left menu, expand Q in Connect.
  2. Click Prompts.
  3. On the Prompt list, click the Pencil icon in the Actions column.
  4. Edit the text in the Prompt Template box as needed.
  5. Select the Model you want the Prompt to use. A Model is required, so if the Prompt is on a retired model you have to choose a supported one before the Prompt will save.
  6. Click Save Prompt to apply your changes.
  7. (Optional) Click the prompt version dropdown at the top of the page to see all versions of the Prompt.
  8. Click Manage Versions to compare versions and see inline differences. Lines highlighted in red are removed, and lines highlighted in green are added or modified. Note: You can have up to 50 versions of a Prompt at one time.

Delete a Prompt

  1. In the left menu, expand Q in Connect.
  2. Click Prompts.
  3. On the Prompt list, click the Trash icon in the Actions column.
  4. Click Delete Prompt.