Skip to main content

OutputContract

Struct OutputContract 

Source
pub struct OutputContract {
    pub schema_id: OutputSchemaId,
    pub schema_version: SchemaVersion,
    pub dialect: OutputSchemaDialect,
    pub schema: OutputSchemaRef,
    pub mode: OutputMode,
    pub validation: ValidationPolicy,
    pub repair: RepairPolicy,
    pub retry_budget: RetryBudget,
    pub content_policy: ContentCapturePolicy,
    pub projection_hint: OutputProjectionHint,
}
Expand description

Carries the output contract record payload for journal, event, or fixture surfaces. Creating or cloning it only preserves serialized SDK state; append, publish, replay, or export effects are documented on the runtime and port methods that store it.

Fields§

§schema_id: OutputSchemaId

Stable schema id used for typed lineage, lookup, or dedupe.

§schema_version: SchemaVersion

Wire schema version used for compatibility checks.

§dialect: OutputSchemaDialect

Schema dialect used to interpret the output schema. Validators use it to select the supported JSON-schema subset and compatibility rules.

§schema: OutputSchemaRef

Schema reference or inline schema used to validate structured output. The runtime resolves this before treating model output as typed data.

§mode: OutputMode

Mode that selects how this operation or contract should behave. Callers use it to choose the explicit execution path instead of relying on hidden defaults.

§validation: ValidationPolicy

Validation policy applied before output is accepted as typed data. It controls validator selection, bounds, failure visibility, and local validation behavior.

§repair: RepairPolicy

Repair policy used after structured output validation fails. It controls whether repair is attempted and which policy gates must approve it.

§retry_budget: RetryBudget

Retry budget for validation, repair, or adapter attempts. Runtimes use it to stop bounded loops deterministically.

§content_policy: ContentCapturePolicy

Content-capture policy that governs raw content, summaries, redaction, and retention. Projection, telemetry, and delivery paths must honor it before exposing content.

§projection_hint: OutputProjectionHint

Provider-facing projection hint for structured output requests. It can guide model prompting but does not replace local validation policy.

Implementations§

Source§

impl OutputContract

Source

pub fn for_type<T: TypedOutputModel>() -> Self

Builds the for type value with the documented defaults. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn strict_json_schema<T: TypedOutputModel>() -> Self

Returns an updated value with strict json schema configured. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn fast_lenient<T: TypedOutputModel>() -> Self

Builds the fast lenient value. This is data construction and performs no I/O, journal append, event publication, or process work.

Source

pub fn provider_assisted<T: TypedOutputModel>() -> Self

Builds the provider assisted value. This is data construction and performs no I/O, journal append, event publication, or process work.

Source

pub fn inline_json_schema( schema_id: OutputSchemaId, schema_version: SchemaVersion, redacted_schema: Value, ) -> Self

Builds the inline json schema value. This is data construction and performs no I/O, journal append, event publication, or process work.

Source

pub fn new( schema_id: OutputSchemaId, schema_version: SchemaVersion, dialect: OutputSchemaDialect, schema: OutputSchemaRef, preset: OutputPreset, ) -> Self

Creates a new records::output value with explicit caller-provided inputs. This constructor is data-only and performs no I/O or external side effects.

Source

pub fn schema_fingerprint(&self) -> ContentHash

Computes the stable schema fingerprint for this records::output value. The computation is deterministic and side-effect free so it can be used in package, journal, or test evidence.

Source

pub fn validate_shape(&self) -> Result<(), AgentError>

Validates the records::output invariants and returns a typed error on failure. Validation is pure and does not perform I/O, dispatch, journal appends, or adapter calls.

Trait Implementations§

Source§

impl Clone for OutputContract

Source§

fn clone(&self) -> OutputContract

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 OutputContract

Source§

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

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

impl<'de> Deserialize<'de> for OutputContract

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 Eq for OutputContract

Source§

impl From<&OutputContract> for OutputContractSnapshot

Source§

fn from(contract: &OutputContract) -> Self

Converts to this type from the input type.
Source§

impl From<&OutputContract> for ProviderStructuredOutputHint

Source§

fn from(contract: &OutputContract) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for OutputContract

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for OutputContract

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 OutputContract

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> Same for T

Source§

type Output = T

Should always be Self
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.