Struct ModelRequest 

pub struct ModelRequest {
    pub model: ModelRef,
    pub messages: Vec<Message>,
    pub tools: Vec<ToolSpec>,
    pub tool_choice: ToolChoice,
    pub output_format: OutputFormat,
    pub generation: GenerationOptions,
    pub feature_policy: FeaturePolicy,
    pub provider_options: BTreeMap<String, Value>,
    pub metadata: ExtensionMap,
}

A complete provider-neutral model request.

Fields

model: ModelRef

Selected model.

messages: Vec<Message>

Ordered conversation messages.

tools: Vec<ToolSpec>

Model-facing tools.

tool_choice: ToolChoice

Tool-selection behavior.

output_format: OutputFormat

Desired final-output format.

generation: GenerationOptions

Common generation options.

feature_policy: FeaturePolicy

Feature-degradation behavior.

provider_options: BTreeMap<String, Value>

Typed adapters serialize options into their provider namespace.

metadata: ExtensionMap

Host-only namespaced metadata.

Implementations

impl ModelRequest

pub fn new(model: ModelRef, message: Message) -> Self

Creates a request with one initial message.

pub fn message(self, message: Message) -> Self

Appends a conversation message.

pub fn tool(self, tool: ToolSpec) -> Self

Adds a model-facing tool.

pub fn provider_tool(self, tool: ProviderToolSpec) -> Self

Adds a provider-hosted tool.

pub fn provider_tools(&self) -> Vec<ProviderToolSpec>

Returns provider-hosted tools separately from application function tools.

pub fn generation(self, generation: GenerationOptions) -> Self

Replaces common generation controls.

pub fn response_mode(self, response_mode: ResponseMode) -> Self

Sets response delivery behavior.

pub fn selected_response_mode(&self) -> ResponseMode

Returns the requested response delivery mode.

pub fn provider_option( self, provider: impl Into<String>, options: Value, ) -> Self

Adds an adapter-owned namespaced option object.

pub fn output_format(self, output_format: OutputFormat) -> Self

Sets the desired output format.

pub fn structured_output<T>(self, name: impl Into<String>) -> Self

where T: JsonSchema,

Requests strict structured output described by the Rust type T.

pub const fn feature_policy(self, feature_policy: FeaturePolicy) -> Self

Sets the feature-degradation policy.

Trait Implementations

impl Clone for ModelRequest

fn clone(&self) -> ModelRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ModelRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelRequest