Skip to main content

Provenance

Struct Provenance 

Source
pub struct Provenance {
    pub parents: Vec<ObjectId>,
    pub operation: String,
    pub agent: String,
    pub timestamp: u64,
    pub metadata: HashMap<String, SochValue>,
}
Expand description

Records how a Knowledge Object was derived.

Provenance enables auditable lineage tracking: “Where did this fact come from?” “What transformations produced this summary?” Each provenance record forms a node in a DAG (Directed Acyclic Graph) of derivations.

The provenance chain is hash-linked — each object’s OID is derived from its content (which includes parent OIDs), creating a tamper-evident lineage.

Fields§

§parents: Vec<ObjectId>

OIDs of the parent objects this was derived from. Empty for root/original objects.

§operation: String

The transformation or operation that produced this object. Examples: “chunk”, “summarize”, “extract_entities”, “merge”, “user_input”

§agent: String

The agent or system that performed the transformation. Examples: “gpt-4”, “user:alice”, “sochdb:compaction”

§timestamp: u64

Timestamp when the derivation occurred (HLC-encoded microseconds).

§metadata: HashMap<String, SochValue>

Optional metadata about the transformation.

Implementations§

Source§

impl Provenance

Source

pub fn root(agent: impl Into<String>, timestamp: u64) -> Self

Create a root provenance (no parents — this is an original object).

Source

pub fn derived( parents: Vec<ObjectId>, operation: impl Into<String>, agent: impl Into<String>, timestamp: u64, ) -> Self

Create a derived provenance with parent objects.

Source

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

Add metadata to this provenance record.

Source

pub fn is_root(&self) -> bool

Check if this is a root provenance (no parents).

Trait Implementations§

Source§

impl Clone for Provenance

Source§

fn clone(&self) -> Provenance

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Provenance

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Provenance

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Provenance

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.