Struct Document 

pub struct Document {
    pub id: Option<String>,
    pub content: String,
    pub metadata: HashMap<String, Value>,
}

A piece of text that flows through loaders → splitters → embeddings → vector store → retrievers.

Fields

id: Option<String>

Optional ID — set by stores once persisted, by loaders that have a natural key (e.g. file path), or left None for ephemeral chunks.

content: String

The text content. Loaders fill this from the source; splitters carve it into chunks.

metadata: HashMap<String, Value>

Free-form metadata (e.g. { "source": "file.txt", "page": 3 }).

Implementations

impl Document

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

Construct from text only.

pub fn with_id(self, id: impl Into<String>) -> Self

Set the ID (builder-style).

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Insert one metadata key (builder-style).

pub fn with_metadata_map(self, m: HashMap<String, Value>) -> Self

Replace metadata wholesale (builder-style).

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 From<&str> for Document

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Document

fn from(s: String) -> Self

Converts to this type from the input type.

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