Back to Documentation

Knowledge Base Guide and API Overview

This guide explains how to create, manage, and use a Knowledge Base (KB) to improve your AI agents’ responses. Our system currently supports adding content via hosted URLs only. This document is written for users who are not technical experts.

Table of Contents

  1. Introduction
  2. What is a Knowledge Base?
  3. Creating a Knowledge Base Using Hosted URLs
  4. Managing Your Knowledge Base
  5. Integrating Your Knowledge Base with AI Agents
  6. Knowledge Base API Platform Overview
  7. Examples
  8. Troubleshooting and Tips
  9. Conclusion

Introduction

This document explains how our system lets you build a Knowledge Base from hosted URLs. The KB then enhances your AI agents by providing them with accurate, contextual information when needed.

What is a Knowledge Base?

A Knowledge Base (KB) is simply a collection of information gathered from web pages. It acts as a reference library that your AI agents can use to provide better, more precise responses.

Creating a Knowledge Base Using Hosted URLs

Basic Setup

  1. Access the Knowledge Base Section:
    Log in to our platform and navigate to the Knowledge Bases area.
  2. Create a New Knowledge Base:
    Click "Create New Knowledge Base."
  3. Enter Basic Information:
    • Name: Provide a clear title (e.g., "Product Documentation").
    • Description: Write a short summary of the content.
    • Access Permissions: Choose who can view or use this KB.

Adding Content Using URLs

  1. Select a Hosted URL:
    Choose a URL from a publicly hosted site that contains the content you want (e.g., your product website or a blog post).
  2. Submit the URL:
    The system will automatically crawl the site, extract the important content, and add it to your KB.
  3. Review the Content:
    Once processed, the content is available for your agents to reference.

Note: Our system supports hosted URLs only.

Managing Your Knowledge Base

After you have created your KB, you can manage it easily:

Integrating Your Knowledge Base with AI Agents

To use your KB with an AI agent:

  1. Connect the KB to an Agent:
    In the agent's settings, select the KB you created.
  2. Set Usage Parameters:
    Define when the KB should be used. For example, specify in the agent’s prompt:

    "For product setup questions, use the 'Product Documentation' knowledge base."

  3. Function Call Integration:
    This inclusion acts like a function call so that, when the prompt is detected, the agent retrieves and uses the KB content automatically.

Knowledge Base API Platform Overview

Our API Platform processes, stores, and retrieves content for your KB, making it available for your agents.

How It Works

  1. Content Processing:
    • Users submit a hosted URL.
    • The platform crawls the URL and extracts the key content.
  2. Vector Transformation:
    • The extracted content is transformed into vector embeddings that capture its meaning.
  3. Storage and Organization:
    • The embeddings are stored in a vector database (using unique KB IDs for organization).
  4. Intelligent Retrieval:
    • When an agent queries the KB using natural language, the system searches for the most relevant content and returns it.

Key Features