Struct ApiChatRequest 

pub struct ApiChatRequest {
    pub messages: Vec<ApiChatMessage>,
    pub tools: Vec<ApiTool>,
    pub tool_choice: Option<ApiToolChoice>,
    pub tool_call_protocol: ApiToolCallProtocol,
    pub legacy_functions: Vec<ApiFunction>,
    pub legacy_function_call: Option<ApiFunctionCallChoice>,
    pub response_format: Option<ApiResponseFormat>,
    pub stream_options: Option<ApiStreamOptions>,
}

Fields

messages: Vec<ApiChatMessage>

tools: Vec<ApiTool>

tool_choice: Option<ApiToolChoice>

tool_call_protocol: ApiToolCallProtocol

Wire protocol emitted by the model’s chat template for automatic tool calls. Forced/named calls may still use a hard argument grammar and the JSON fallback.

legacy_functions: Vec<ApiFunction>

legacy_function_call: Option<ApiFunctionCallChoice>

response_format: Option<ApiResponseFormat>

stream_options: Option<ApiStreamOptions>

Implementations

impl ApiChatRequest

pub fn generated_control_token_texts(&self) -> &'static [&'static str]

Protocol controls are generatable only when this request can emit a modern tool call. tool_choice: none must not widen token sampling.

pub fn generated_response_envelope(&self) -> Option<ResponseCompletionEnvelope>

Alternate complete response envelope available to this request.

Trait Implementations

impl Clone for ApiChatRequest

fn clone(&self) -> ApiChatRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiChatRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiChatRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiChatRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ApiChatRequest

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 ApiChatRequest