Struct MessageRequest 

pub struct MessageRequest {
    pub model: Option<String>,
    pub messages: Vec<MessageBody>,
    pub max_tokens: Option<i32>,
    pub system: Option<SystemMessageContent>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
    pub stream: Option<bool>,
    pub stop_sequences: Option<Vec<String>>,
    pub tools: Option<Vec<MessageTools>>,
    pub tool_choice: Option<MessageToolChoice>,
    pub metadata: Option<MessageMetadata>,
}

Request message for /v1/messages endpoint.

Fields

model: Option<String>

Model name for the model to use.

messages: Vec<MessageBody>

Input messages.

max_tokens: Option<i32>

The maximum number of tokens to generate before stopping.

system: Option<SystemMessageContent>

System prompt message for the model.

temperature: Option<f32>

What sampling temperature to use, between 0 and 2.

top_p: Option<f32>

An alternative to sampling with temperature, called nucleus sampling.

top_k: Option<i32>

(Unsupported) When generating next tokens, randomly selecting from k most likely options.

stream: Option<bool>

If set, partial message deltas will be sent as server-sent events.

stop_sequences: Option<Vec<String>>

(Not supported by reasoning models) Up to 4 sequences where the API will stop generating.

tools: Option<Vec<MessageTools>>

A list of tools the model may call.

tool_choice: Option<MessageToolChoice>

Controls which (if any) tool is called by the model.

metadata: Option<MessageMetadata>

An object describing metadata about the request.

Trait Implementations

impl Clone for MessageRequest

fn clone(&self) -> MessageRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageRequest

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

Formats the value using the given formatter.

impl Default for MessageRequest

fn default() -> MessageRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MessageRequest

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 MessageRequest