Agent Quick Start

A step-by-step guide on how to chat to your docs

In this guide, we'll show how you can quickly create an Agent to talk about our very own AirOps docs using a Knowledge Base.

1. Configure your Knowledge Base

What's a chatbot without unique knowledge? To get started let's create a simple Knowledge Base populated with some of our documentation pages:

1. Click Your Data on the left hand tab

2. Click Create Knowledge Base

3. Name your Knowledge Base

4. Click Add Data

5. Add desired docs to the Knowledge Base

   1. Upload a .pdf, .csv, .txt

   2. Sync to a Google Doc or Google Sheet

   3. Sync a SQL Database

   4. Import from URL (we'll use this option)

   5. Import Sitemap

Your content will now be added to a Knowledge Base. After a few minutes, we'll be ready to build our agent using this Knowledge Base.

2. Create an Agent

Next, we'll set up the agent by navigating to "Templates" on the left-hand tab and selecting "Blank Agent." We'll have to customize the parameters of our Agent to make sure it provides results in the exact format we want:

i. Add a Memory Search Step

1. Select a Knowledge Base: select the name of your knowledge base from the dropdown, let's use the one we just created.

2. Max Results: choose the number of Knowledge Base results to return. We recommend 5.

3. Description: tell the AI how to use the Memory Search step. For example:

Use the memory search tool to answer the user's questions about their docs

4. Filter: use the Metadata present in your uploaded sources to narrow down the search results.

Now that we've defined the input parameters for our Agent, we'll focus on customizing the Agent itself.

ii. Configure the Agent

1. Select the AI Model

   1. As of February 2024, we recommend using GPT-4 Turbo for Agents

   2. For more detail on the differences between the models, check out our Choosing a Model doc page.

2. System

   1. The System Prompt defines the AI's persona, objective, specific tasks or rules. What is it's role? What should it's tone of voice be? What should it refuse to answer?

   2. Modify the existing prompt for your needs. As an example, replace AirOps with your company name in the following prompt:

You are a helpful assistant for AirOps, and your task is to answer the user's question about AirOps docs using the memory search function. Your knowledge is limited to the context provided. If the user's question is vague, you ask clarifying questions. Never hallucinate an answer. You are encouraging, engaging and helpful. Your responses must be brief, summarized, and concise. 

3. Test and Publish Your Agent

1. Click Test All to ask your agent a question about your docs

2. Tweak the System prompt, add a User prompt, or add a User-Assistant pair

3. Save Draft and give your Agent a name

4. Once you're satisfied with the output, Publish Agent

And that's it! You now have a fully functional chat Agent that will save you the time of looking through our documentation for specific answers.

We encourage you to test out different use-cases for your Agents, and please don't hesitate to reach out to us with any questions as you dive deeper into AirOps.