Skip to main content

CreateMessageRequest

Struct CreateMessageRequest 

Source
#[non_exhaustive]
pub struct CreateMessageRequest {
Show 15 fields pub model: ModelId, pub max_tokens: u32, pub messages: Vec<MessageInput>, pub system: Option<SystemPrompt>, pub temperature: Option<f32>, pub top_p: Option<f32>, pub top_k: Option<u32>, pub stop_sequences: Option<Vec<String>>, pub tools: Vec<Tool>, pub tool_choice: Option<ToolChoice>, pub metadata: Option<MessageMetadata>, pub service_tier: Option<RequestServiceTier>, pub thinking: Option<ThinkingConfig>, pub mcp_servers: Vec<McpServerConfig>, pub container: Option<String>, /* private fields */
}
Expand description

Request payload for POST /v1/messages.

Construct via CreateMessageRequest::builder.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§model: ModelId

Model to query.

§max_tokens: u32

Maximum number of output tokens to generate.

§messages: Vec<MessageInput>

Conversation history.

§system: Option<SystemPrompt>

Optional system prompt.

§temperature: Option<f32>

Sampling temperature.

§top_p: Option<f32>

Nucleus sampling cutoff.

§top_k: Option<u32>

Top-k sampling cutoff.

§stop_sequences: Option<Vec<String>>

Custom stop sequences.

§tools: Vec<Tool>

Tools the model may invoke.

§tool_choice: Option<ToolChoice>

Tool-use policy.

§metadata: Option<MessageMetadata>

Optional per-request metadata (user_id).

§service_tier: Option<RequestServiceTier>

Request-side service tier preference.

§thinking: Option<ThinkingConfig>

Extended-thinking configuration.

§mcp_servers: Vec<McpServerConfig>

MCP servers exposed to the model on this request.

§container: Option<String>

Container ID for the code-execution built-in tool.

Implementations§

Source§

impl CreateMessageRequest

Source

pub fn builder() -> CreateMessageRequestBuilder

Begin configuring a request.

Trait Implementations§

Source§

impl Clone for CreateMessageRequest

Source§

fn clone(&self) -> CreateMessageRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateMessageRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&CreateMessageRequest> for CountTokensRequest

Source§

fn from(req: &CreateMessageRequest) -> Self

Project a CreateMessageRequest onto the subset of fields the count-tokens endpoint accepts. Sampling parameters (temperature, top_p, etc.) and max_tokens are dropped because they don’t affect tokenization.

Source§

impl Serialize for CreateMessageRequest

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more