Documentation
HomeAPISign In
  • Getting Started
    • Overview
      • Core Concepts
      • Building your First Workflow
    • API Reference
  • Your Data
    • Brand Kits
    • Knowledge Bases
      • Add Data
        • Upload Files
        • Web Scrape
        • Import from Google Drive
        • Import from SQL Database
        • Import from Shopify
      • Knowledge Base Search
      • Knowledge Base Metadata
      • Knowledge Base API
  • Building Workflows
    • Workflow Concepts
      • Workflow Inputs
        • Input Types
      • Workflow Outputs
      • Variable Referencing
      • Liquid Templating
    • Workflow Steps
      • AI
        • Prompt LLM
          • Model Selection Guide
          • Prompting Guide
        • Transcribe Audio File
      • Web Research
        • Google Search
        • Perplexity Deep Research
        • Web Page Scrape
      • Code
        • Run Code
        • Call API
        • Format JSON
        • Run SQL Query
        • Write Liquid Text
      • Flow
        • Condition
        • Iteration
        • Human Review
        • Content Comparison
        • Error
      • Data
        • Read from Grid
        • Add Rows in Grid
        • Search Knowledge Base
        • Write to Knowledge Base
        • Get Knowledge Base File
      • AirOps
        • Workflow
        • Agent
      • Image & Video
        • Generate Image with API
        • Search Stock Images
        • Fetch Stock Image with ID
        • Resize Image
        • Screenshot from URL
        • Create OpenGraph Image
        • Create Video Avatar
      • SEO Research
        • Semrush
        • Data4SEO
      • Content Quality
        • Detect AI Content
        • Scan Content for Plagiarism
      • Content Processing
        • Convert Markdown to HTML
        • Convert PDF URL to Text
        • Group Keywords into Clusters
      • B2B Enrichment
        • Hunter.io
        • People Data Labs
      • CMS Integrations
        • Webflow
        • WordPress
        • Shopify
        • Contentful
        • Sanity
        • Strapi
      • Analytics Integrations
        • Google Search Console
      • Collaboration Integrations
        • Gmail
        • Google Docs
        • Google Sheets
        • Notion
        • Slack
    • Power Steps
    • Testing and Iteration
    • Publishing and Versioning
    • Logs
    • Studio Toolbar
  • Running Workflows
    • Run Once
    • Run in Bulk (Grid)
    • Run via API
    • Run via Trigger
      • Incoming Webhook Trigger
      • Zapier
    • Run on a Schedule
    • Error Handling
  • Grids
    • Create a Grid
      • Import from Webflow
      • Import from Wordpress
      • Import from Semrush
      • Import from Google Search Console
    • Add Columns in the Grid
    • Run Workflows in the Grid
      • Add Workflow Column
      • Run Workflow Column
      • Schedule Workflow Column
      • Map Workflow Outputs
      • Review Workflow Run Metadata
    • Review Content in the Grid
      • Review Markdown Content
      • Review HTML Content
      • Compare Content Difference
    • Publish to CMS from Grid
    • Pull Analytics in the Grid
    • Searching and Filtering
    • Export as CSV
  • Copilot
    • Chat with Copilot
    • Edit Workflows with Copilot
    • Fix Errors with Copilot
  • Monitoring
    • Task Usage
    • Analytics
    • Alerts
    • Execution History
  • Your Workspace
    • Create a Workspace
    • Folders
    • Settings
    • Billing
    • Use your own LLM API Keys
    • Secrets
    • Team and Permissions
  • Chat Agents (Legacy)
    • Agent Quick Start
    • Chat Agents
    • Integrate Agents
      • Widget
      • Client Web SDK
  • About
    • Ethical AI and IP Production
    • Principles
    • Security and Compliance
Powered by GitBook
On this page
  • 1. Configure your Knowledge Base
  • 2. Create an Agent
  • i. Add a Memory Search Step
  • ii. Configure the Agent
  • 3. Test and Publish Your Agent

Was this helpful?

  1. Chat Agents (Legacy)

Agent Quick Start

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

Last updated 3 months ago

Was this helpful?

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
  1. 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. 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.

For more detail on the differences between the models, check out our doc page.

Choosing a Model