Struct Document 

pub struct Document {
    pub content: String,
    pub source: Option<String>,
    pub score: Option<f32>,
}

Represents a piece of retrieved content from a knowledge source.

This is typically returned by retriever agents (agents with Output = Vec<Document>). Documents can be attached to payloads and will be formatted by PersonaAgent into a “Retrieved Context” section in the prompt.

Examples

use llm_toolkit::retrieval::Document;

let doc = Document {
    content: "Rust is a systems programming language.".to_string(),
    source: Some("rust_intro.md".to_string()),
    score: Some(0.92),
};

Fields

content: String

The textual content of the document

source: Option<String>

Optional source identifier (e.g., file path, URL, document ID)

score: Option<f32>

Optional relevance or similarity score (higher = more relevant)

Implementations

impl Document

pub fn new(content: impl Into<String>) -> Self

Creates a new document with the given content.

pub fn with_source(self, source: impl Into<String>) -> Self

Sets the source identifier for this document.

pub fn with_score(self, score: f32) -> Self

Sets the relevance score for this document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Document