Skip to main content

EvalItem

Struct EvalItem 

Source
pub struct EvalItem {
    pub id: ItemId,
    pub name: String,
    pub description: Option<String>,
    pub tags: Vec<Tag>,
    pub setup: Setup,
    pub before: Vec<TurnSpec>,
    pub turn: TurnSpec,
    pub expect: Expectations,
    pub judge: Vec<JudgeCriterion>,
    pub provenance: Provenance,
}
Expand description

One named scenario.

Fields§

§id: ItemId

Stable identifier, unique within a suite. Reports and baselines join on it, so renaming one is renaming a measurement.

§name: String

One sentence a human reads in a report.

§description: Option<String>

Longer prose, when the scenario needs it.

§tags: Vec<Tag>

Labels a run selects on.

§setup: Setup

The state the world is in before the turn.

§before: Vec<TurnSpec>

Turns the person takes first, in the same conversation. Only the last turn is observed; what the conversation built is read back after it.

§turn: TurnSpec

The turn the person takes.

§expect: Expectations

What must be true afterwards, checked without a model.

§judge: Vec<JudgeCriterion>

Which linguistic qualities a judge grades. Empty means no judge runs, which is the right answer for most items.

§provenance: Provenance

Where each part of this item came from: authored, derived or recorded.

Declared once here, or once for a whole directory in a SuiteManifest. It changes nothing about how the item runs and everything about how crate::baseline::compare reads a difference — an intended projection change, a broken pairing, or a corpus defect.

Implementations§

Source§

impl EvalItem

Source

pub fn validate(&self) -> Result<(), CorpusError>

Checks the combinations serde cannot.

§Errors

CorpusError::Invalid naming the field and the reason.

Source

pub fn carries(&self, part: ItemPart) -> bool

Returns true when the item actually has something in part.

A turn always has something in it — TurnSpec::validate refuses one that does not — so ItemPart::Turn is always carried.

Source

pub fn has_tag(&self, tag: &Tag) -> bool

Returns true when this item carries tag.

Source

pub fn fingerprint(&self) -> ItemFingerprint

Digests the item part by part, recording where the corpus said each part came from.

A run stores this on ItemReport so a later comparison can tell whether the two runs measured the same thing. The digest is over a canonical rendering with object keys sorted, so an item whose seeded state was written out with its fields in a different order still fingerprints the same.

use turnframe_eval::corpus::{EvalItem, ItemPart, PartProvenance};

let item: EvalItem = toml::from_str(
    r#"
    id = "a"
    name = "A scenario"

    [provenance]
    setup = "derived"

    [turn]
    text = "hello"

    [[setup.cases]]
    workflow = "trip"
    case_id = "trip-1"
    label = "Trip 1"
    state = { status = "draft" }
    "#,
)?;
item.validate()?;

let fingerprint = item.fingerprint();
assert_eq!(fingerprint.provenance_of(ItemPart::Setup), PartProvenance::Derived);
assert_eq!(fingerprint.provenance_of(ItemPart::Turn), PartProvenance::Authored);

Trait Implementations§

Source§

impl Clone for EvalItem

Source§

fn clone(&self) -> Self

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 EvalItem

Source§

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

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

impl<'de> Deserialize<'de> for EvalItem

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 EvalItem

Source§

fn eq(&self, other: &Self) -> 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 EvalItem

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 EvalItem

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more