Struct DocumentSource 

#[non_exhaustive]
pub struct DocumentSource {
    pub title: Option<String>,
    pub author: Option<String>,
    pub creation_date: Option<String>,
    pub filename: Option<String>,
    pub doc_hash: Option<String>,
    pub total_pages: Option<u32>,
}

Metadata about the source document a chunk came from.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

Document title from the info dictionary, if present.

author: Option<String>

Document author from the info dictionary, if present.

creation_date: Option<String>

Creation date string from the info dictionary, if present.

filename: Option<String>

Originating file name (caller-supplied — the pipeline does not know it).

doc_hash: Option<String>

Stable document hash (caller-supplied; used as the chunk_id prefix).

total_pages: Option<u32>

Total page count of the source document.

Implementations

impl DocumentSource

pub fn with_file(filename: Option<String>, doc_hash: Option<String>) -> Self

Construct a source from the two caller-supplied fields (filename, doc_hash); the rest (title/author/creation_date/total_pages) are left None for rag_chunks_with_source to auto-fill from the info dictionary. Provided because DocumentSource is #[non_exhaustive], so external callers cannot use a struct literal.

Trait Implementations

impl Clone for DocumentSource

fn clone(&self) -> DocumentSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSource

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

Formats the value using the given formatter.

impl Default for DocumentSource

fn default() -> DocumentSource

Returns the “default value” for a type.

impl Eq for DocumentSource

impl PartialEq for DocumentSource

fn eq(&self, other: &DocumentSource) -> 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 StructuralPartialEq for DocumentSource