Struct ImportDocument 

#[non_exhaustive]
pub struct ImportDocument {
    pub id: String,
    pub title: String,
    pub body: String,
    pub metadata: Value,
    pub entity_hints: Vec<EntityRef>,
    pub valid_from: Option<DateTime<Utc>>,
}

One document fetched from an ImportSource.

Wrapped as a Fact by KnowledgeIngestionPipeline::run: body becomes Fact.text; entity_hints, valid_from, id, and title land under reserved keys in Fact.metadata; caller-supplied metadata is merged (pipeline writes reserved keys LAST, so they overwrite any collision — callers MUST NOT use reserved key names).

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.

id: String

Stable external identifier (Confluence page id, Jira key, file hash, …). Persisted as Fact.metadata.import_source_id.

title: String

Display name. Persisted as Fact.metadata.title.

body: String

Document body — becomes Fact.text.

metadata: Value

Caller-supplied opaque metadata. Merged with pipeline-reserved keys (valid_from, entities, import_source_id, title).

entity_hints: Vec<EntityRef>

Pre-known entities (Article, Obligation, etc. for DORA; owners for Confluence pages, …). Persisted as Fact.metadata.entities so GraphAwareLongTerm::remember surfaces them via the extractor’s hint path.

valid_from: Option<DateTime<Utc>>

When the document is valid in the world (regulation effective date, contract start, …). Persisted as Fact.metadata.valid_from in RFC-3339; GraphAwareLongTerm parses it back.

Implementations

impl ImportDocument

pub fn new( id: impl Into<String>, title: impl Into<String>, body: impl Into<String>, ) -> Self

Build a document from required fields. Optional fields use their Default values; set them via the builder-style with_* methods.

pub fn with_metadata(self, metadata: Value) -> Self

Attach caller-supplied metadata (merged into Fact.metadata by KnowledgeIngestionPipeline::run).

pub fn with_entity_hints(self, hints: Vec<EntityRef>) -> Self

Pre-seed entities the extractor should treat as authoritative.

pub fn with_valid_from(self, valid_from: DateTime<Utc>) -> Self

Bi-temporal valid_from (e.g. regulation effective date).

Trait Implementations

impl Clone for ImportDocument

fn clone(&self) -> ImportDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImportDocument

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

Formats the value using the given formatter.