pub struct ModelRequest { /* private fields */ }Expand description
Immutable, fully normalized request passed to a model adapter.
Construction derives input modalities and every provider-neutral capability requirement from the supplied content and controls. Adapters must validate registered extensions and referenced schemas before provider I/O; unsupported extensions are errors and are never silently dropped. Provider-side history, automatic truncation, storage, background execution, and multi-candidate generation are intentionally outside this durable core request.
Structural validation does not authenticate serialized instruction owners or tool descriptors. Public protocol/API adapters must resolve those values from an authenticated tenant registry instead of accepting caller-supplied claims.
Implementations§
Source§impl ModelRequest
impl ModelRequest
Sourcepub const MAX_TOOL_DEFINITIONS: ExecutionCount
pub const MAX_TOOL_DEFINITIONS: ExecutionCount
Maximum tool definitions accepted by one provider-neutral request.
Sourcepub const MAX_TOOL_CALLS_PER_RESPONSE: ExecutionCount
pub const MAX_TOOL_CALLS_PER_RESPONSE: ExecutionCount
Maximum tool calls accepted from one model response.
Sourcepub fn builder(limits: ModelRequestLimits) -> ModelRequestBuilder
pub fn builder(limits: ModelRequestLimits) -> ModelRequestBuilder
Starts a bounded request builder with explicit finite limits.
Sourcepub fn instructions(&self) -> &[Instruction]
pub fn instructions(&self) -> &[Instruction]
Returns ordered application-owned instructions.
Sourcepub const fn transcript(&self) -> &ModelTranscript
pub const fn transcript(&self) -> &ModelTranscript
Returns ordered durable prior model/tool turns.
Sourcepub fn tools(&self) -> impl ExactSizeIterator<Item = &ToolDescriptor>
pub fn tools(&self) -> impl ExactSizeIterator<Item = &ToolDescriptor>
Iterates available tool descriptors in canonical name order.
Sourcepub fn tool(&self, name: &CapabilityName) -> Option<&ToolDescriptor>
pub fn tool(&self, name: &CapabilityName) -> Option<&ToolDescriptor>
Returns one available tool by registry-local name.
Sourcepub const fn tool_selection(&self) -> &ModelToolSelection
pub const fn tool_selection(&self) -> &ModelToolSelection
Returns the requested tool-selection behavior.
Sourcepub const fn max_tool_calls_per_response(&self) -> ExecutionCount
pub const fn max_tool_calls_per_response(&self) -> ExecutionCount
Returns the finite tool-call ceiling for one response.
Sourcepub const fn requires_strict_tool_arguments(&self) -> bool
pub const fn requires_strict_tool_arguments(&self) -> bool
Returns whether every complete tool argument must be provider-constrained.
Sourcepub const fn output_modalities(&self) -> &ModelModalities
pub const fn output_modalities(&self) -> &ModelModalities
Returns requested output modalities.
Sourcepub const fn text_output_format(&self) -> Option<&ModelTextOutputFormat>
pub const fn text_output_format(&self) -> Option<&ModelTextOutputFormat>
Returns text output format, absent for non-text-only output.
Sourcepub const fn response_mode(&self) -> ModelResponseMode
pub const fn response_mode(&self) -> ModelResponseMode
Returns complete or streaming response delivery.
Sourcepub const fn requires_reasoning_summaries(&self) -> bool
pub const fn requires_reasoning_summaries(&self) -> bool
Returns whether a readable provider reasoning summary was requested.
Sourcepub const fn limits(&self) -> &ModelRequestLimits
pub const fn limits(&self) -> &ModelRequestLimits
Returns finite request limits.
Sourcepub const fn extensions(&self) -> &Extensions
pub const fn extensions(&self) -> &Extensions
Returns bounded registered provider/adapter extension values.
Sourcepub const fn requirements(&self) -> &ModelRequirements
pub const fn requirements(&self) -> &ModelRequirements
Returns normalized requirements derived from this exact request.
Sourcepub fn content_bytes(&self) -> ByteCount
pub fn content_bytes(&self) -> ByteCount
Returns resolved instruction and message content bytes.
Trait Implementations§
Source§impl Clone for ModelRequest
impl Clone for ModelRequest
Source§impl Debug for ModelRequest
impl Debug for ModelRequest
Source§impl<'de> Deserialize<'de> for ModelRequest
impl<'de> Deserialize<'de> for ModelRequest
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 ModelRequest
Source§impl JsonSchema for ModelRequest
impl JsonSchema for ModelRequest
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