Skip to main content

AttributionReport

Struct AttributionReport 

Source
pub struct AttributionReport {
    pub uses: Vec<ContextUse>,
    pub usage: UsageReport,
}
Expand description

Every ContextUse for one request, alongside the UsageReport that says what those frames cost.

Cost and outcome are kept in one place on purpose: separately, each is nearly useless. “This frame cost 400 tokens” prompts no decision, and “this frame was never cited” prompts the wrong one if it cost four. Together they give value_per_token — the ranking signal #31 and the token-cost work (#8) each supply half of.

Fields§

§uses: Vec<ContextUse>

One record per frame the host selected, keyed by the same identity the usage report bills.

§usage: UsageReport

The cost side of the ledger for the same request.

Implementations§

Source§

impl AttributionReport

Source

pub fn new(uses: Vec<ContextUse>, usage: UsageReport) -> Self

Pair outcome records with the cost report for the same request.

Source

pub fn use_of(&self, frame: &FrameId) -> Option<&ContextUse>

The record for one frame identity, if the host observed it.

Source

pub fn cited_tokens(&self) -> u64

Summed token_cost of frames that reached the prompt and were cited.

Source

pub fn uncited_rendered_tokens(&self) -> u64

Summed token_cost of frames that reached the prompt and were not cited — the budget retrieval spent without visible return.

Source

pub fn cited_token_share(&self) -> Option<f64>

The share of rendered budget that earned a citation, in [0, 1].

None when nothing was rendered — a request that retrieved nothing has no retrieval quality to report, and returning 0.0 would drag an average down with a turn that never asked anything of retrieval.

Source

pub fn is_reconcilable(&self) -> bool

Whether every record is internally coherent and names a frame the usage report actually billed.

The second half is what makes attribution auditable: a record about a frame nobody was charged for cannot be reconciled against the bill, and is the shape a mis-keyed identity takes.

Trait Implementations§

Source§

impl Clone for AttributionReport

Source§

fn clone(&self) -> AttributionReport

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 AttributionReport

Source§

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

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

impl<'de> Deserialize<'de> for AttributionReport

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 PartialEq for AttributionReport

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for AttributionReport

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
Source§

impl StructuralPartialEq for AttributionReport

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.