Retrieval

Find relevant information for agents

Agents can search and retrieve relevant information from your documents.

Quick Start

1. Simple Usage

   import { Agent } from 'praisonai';
   
   const agent = new Agent({
     instructions: 'Answer questions using the provided documents',
     knowledge: './docs/'  // Folder of documents
   });
   
   await agent.chat('What is the return policy?');
   // Agent searches docs and answers accurately

2. With Configuration

   const agent = new Agent({
     knowledge: {
       path: './docs/',
       strategy: 'semantic',  // or 'keyword', 'hybrid'
       topK: 5
     }
   });

User Interaction Flow

Configuration Levels

// Level 1: String - Path to documents
const agent = new Agent({
  knowledge: './docs/'
});

// Level 2: Array - Multiple sources
const agent = new Agent({
  knowledge: ['./policies/', './faq/', './guides/']
});

// Level 3: Dict - Full options
const agent = new Agent({
  knowledge: {
    path: './docs/',
    strategy: 'hybrid',
    topK: 10,
    minScore: 0.7,
    chunkSize: 500
  }
});

Retrieval Strategies

API Reference

Best Practices

Related