pub struct ModelResponse { /* private fields */ }Expand description
Immutable, fully normalized result of one model attempt.
Deserialization enforces intrinsic resource, metadata, usage, and finish
invariants, but serialized model/tool identities remain unauthenticated
claims. Call Self::validate_for against the attempt’s immutable descriptor
and request snapshot before consuming a durable or remote value. Adapter
code should prefer Self::new, which performs both validation layers.
Implementations§
Source§impl ModelResponse
impl ModelResponse
Sourcepub const MAX_CONTENT_ITEMS: usize = ModelOutputItems::MAX_CONTENT_ITEMS
pub const MAX_CONTENT_ITEMS: usize = ModelOutputItems::MAX_CONTENT_ITEMS
Maximum user-visible content and reasoning-summary items in one response.
Sourcepub const MAX_TOOL_CALLS: usize = ModelOutputItems::MAX_TOOL_CALLS
pub const MAX_TOOL_CALLS: usize = ModelOutputItems::MAX_TOOL_CALLS
Maximum complete tool proposals in one response.
Sourcepub const MAX_OUTPUT_ITEMS: usize = ModelOutputItems::MAX_ITEMS
pub const MAX_OUTPUT_ITEMS: usize = ModelOutputItems::MAX_ITEMS
Maximum total ordered output items in one response.
Sourcepub const MAX_INLINE_PAYLOAD_BYTES: ByteCount = ModelOutputItems::MAX_INLINE_PAYLOAD_BYTES
pub const MAX_INLINE_PAYLOAD_BYTES: ByteCount = ModelOutputItems::MAX_INLINE_PAYLOAD_BYTES
Maximum aggregate normalized output plus opaque provider replay bytes.
Sourcepub fn new<I>(
provenance: ModelResponseProvenance,
descriptor: &ModelDescriptor,
request: &ModelRequest,
output: I,
finish_reason: ModelFinishReason,
usage: ModelUsage,
extensions: Extensions,
) -> Result<Self, ModelResponseError>where
I: IntoIterator<Item = ModelOutputItem>,
pub fn new<I>(
provenance: ModelResponseProvenance,
descriptor: &ModelDescriptor,
request: &ModelRequest,
output: I,
finish_reason: ModelFinishReason,
usage: ModelUsage,
extensions: Extensions,
) -> Result<Self, ModelResponseError>where
I: IntoIterator<Item = ModelOutputItem>,
Constructs and binds one response to an immutable descriptor and request.
§Errors
Returns ModelResponseError for any structural, resource, finish,
capability-identity, request-limit, output-format, modality, or tool
mismatch. Referenced JSON Schemas still require trusted registry
resolution and validation by the adapter before construction.
Sourcepub fn with_provider_replay(
self,
provider_replay: ModelProviderReplay,
) -> Result<Self, ModelResponseError>
pub fn with_provider_replay( self, provider_replay: ModelProviderReplay, ) -> Result<Self, ModelResponseError>
Attaches exact provider continuation evidence to a tool-calling response.
§Errors
Returns ModelResponseError::ProviderReplayWithoutToolCalls when the
response does not require a tool-result continuation.
Sourcepub fn validate_for(
&self,
descriptor: &ModelDescriptor,
request: &ModelRequest,
) -> Result<(), ModelResponseError>
pub fn validate_for( &self, descriptor: &ModelDescriptor, request: &ModelRequest, ) -> Result<(), ModelResponseError>
Revalidates request- and registry-dependent response invariants.
§Errors
Returns ModelResponseError when provenance, usage, output modality,
reasoning summaries, final text format, or tool proposals do not match
the exact descriptor and request snapshot.
Sourcepub const fn provenance(&self) -> &ModelResponseProvenance
pub const fn provenance(&self) -> &ModelResponseProvenance
Returns attempt and model identity provenance.
Sourcepub fn output(&self) -> &[ModelOutputItem]
pub fn output(&self) -> &[ModelOutputItem]
Returns all output items in exact provider order.
Sourcepub fn tool_calls(&self) -> impl Iterator<Item = &ModelToolCallProposal>
pub fn tool_calls(&self) -> impl Iterator<Item = &ModelToolCallProposal>
Iterates complete, unapproved tool-call proposals in provider order.
Sourcepub const fn tool_call_count(&self) -> usize
pub const fn tool_call_count(&self) -> usize
Returns the exact number of complete, unapproved tool proposals.
Sourcepub const fn finish_reason(&self) -> ModelFinishReason
pub const fn finish_reason(&self) -> ModelFinishReason
Returns the normalized portable finish reason.
Sourcepub const fn usage(&self) -> &ModelUsage
pub const fn usage(&self) -> &ModelUsage
Returns normalized per-attempt token usage.
Sourcepub const fn extensions(&self) -> &Extensions
pub const fn extensions(&self) -> &Extensions
Returns registered opaque provider/adapter extension values.
Sourcepub const fn provider_replay(&self) -> Option<&ModelProviderReplay>
pub const fn provider_replay(&self) -> Option<&ModelProviderReplay>
Returns exact provider continuation evidence for a tool-calling turn.
Sourcepub fn inline_payload_bytes(&self) -> ByteCount
pub fn inline_payload_bytes(&self) -> ByteCount
Returns aggregate normalized output and provider replay bytes retained.
Trait Implementations§
Source§impl Clone for ModelResponse
impl Clone for ModelResponse
Source§impl Debug for ModelResponse
impl Debug for ModelResponse
Source§impl<'de> Deserialize<'de> for ModelResponse
impl<'de> Deserialize<'de> for ModelResponse
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
impl Eq for ModelResponse
Source§impl JsonSchema for ModelResponse
impl JsonSchema for ModelResponse
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read more