Citations

Track sources in agent responses

Agents can cite their sources – show where information comes from.

Quick Start

1. Simple Usage

   import { Agent } from 'praisonai';
   
   const agent = new Agent({
     instructions: 'Answer using the provided documents',
     knowledge: './docs/',
     citations: true
   });
   
   const result = await agent.chat('What is the return policy?');
   console.log(result.content);
   // "You can return items within 30 days [1]"
   console.log(result.citations);
   // [{ id: 1, source: 'returns.md', text: '...' }]

2. With Configuration

   const agent = new Agent({
     citations: {
       format: 'inline',  // or 'footnote', 'endnotes'
       includePageNumbers: true
     }
   });

User Interaction Flow

Configuration Levels

// Level 1: Bool - Enable citations
const agent = new Agent({
  citations: true
});

// Level 2: String - Citation style
const agent = new Agent({
  citations: 'inline'  // 'inline', 'footnote', 'endnotes'
});

// Level 3: Dict - Full options
const agent = new Agent({
  citations: {
    format: 'footnote',
    includePageNumbers: true,
    maxCitations: 5,
    minRelevanceScore: 0.7
  }
});

Citation Formats

API Reference

Best Practices

Related