TUTORIAL_BUILD_A_RAG_AGENT

TUTORIAL

Learn how to give your agent long-term memory and access to private documentation using Vector Stores.

INTRODUCTION#

Retrieval-Augmented Generation (RAG) combines the power of LLMs with external knowledge. In this tutorial, we will build a "Knowledge Base Agent" that can answer questions about a fictional product manual.

Vector Database: To store and retrieve document embeddings.
Tooling: A custom tool to query the database.
Agent: To synthesize the retrieved information.

SETUP_KNOWLEDGE_BASE

First, we need a way to store and retrieve documents. We'll define a simple VectorStore interface.

typescript

import { Tool } from '@AKIOS/core'
import { z } from 'zod'

// Mock vector store (in production, use Pinecone/Weaviate)
const knowledgeBase = [
  { id: 1, text: "The ACME 2000 has a battery life of 12 hours.", vector: [...] },
  { id: 2, text: "To reset the device, hold the power button for 5s.", vector: [...] },
]

async function search(query: string) {
  // Simulate semantic search
  console.log(`Searching for: ${query}`)
  return knowledgeBase.map(k => k.text).join('\n')
}

CREATE_RETRIEVAL_TOOL

We wrap our search function in a Tool so the agent knows how and when to use it.

typescript

const retrievalTool = new Tool({
  name: 'search_manual',
  description: 'Search the product manual for technical specifications and troubleshooting.',
  schema: z.object({
    query: z.string().describe('The semantic search query')
  }),
  handler: async ({ query }) => {
    const results = await search(query)
    return results || "No relevant information found."
  }
})

INITIALIZE_AGENT

Now we give the tool to the agent. Notice the system prompt encourages using the tool.

typescript

const agent = new Agent({
  name: 'SupportBot',
  model: 'gpt-4-turbo',
  tools: [retrievalTool],
  systemPrompt: `
    You are a technical support assistant for ACME Corp.
    ALWAYS search the manual before answering technical questions.
    If the answer isn't in the manual, say "I don't know".
  `
})

TEST_IT

Run the agent with a question that requires external knowledge.

typescript

const response = await agent.run("How do I perform a hard reset?")
console.log(response.text)

> Searching for: perform a hard reset

> Tool Output: "To reset the device, hold the power button for 5s."

> Agent: You can perform a hard reset by holding the power button for 5 seconds.

PRO_TIP

For large datasets, use the @AKIOS/rag package (coming soon) which handles chunking, embedding, and re-ranking automatically.