Skip to main content

MessageRequestBuilder

Struct MessageRequestBuilder 

Source
pub struct MessageRequestBuilder<'a> { /* private fields */ }
Expand description

Fluent builder for Claude API message requests.

Created via ClaudeClient::messages(). Chain methods to configure, then call .send() for the full response or .stream() for SSE events.

Implementations§

Source§

impl<'a> MessageRequestBuilder<'a>

Source

pub fn model(self, model: &str) -> Self

Set the model by ID (e.g. “claude-opus-4-6”)

Source

pub fn opus(self) -> Self

Use Claude Opus 4.6 - most intelligent, best for agents and coding

Source

pub fn sonnet(self) -> Self

Use Claude Sonnet 4.6 - best speed/intelligence balance

Source

pub fn haiku(self) -> Self

Use Claude Haiku 4.5 - fastest and cheapest

Source

pub fn system(self, text: &str) -> Self

Set the system prompt (plain text)

Source

pub fn system_cached(self, text: &str) -> Self

Set the system prompt with prompt caching enabled

Source

pub fn user(self, text: &str) -> Self

Add a user text message

Source

pub fn user_with_image_base64( self, text: &str, media_type: &str, base64_data: &str, ) -> Self

Add a user message with an image (base64 encoded)

Source

pub fn user_with_image_url(self, text: &str, url: &str) -> Self

Add a user message with an image URL

Source

pub fn assistant(self, text: &str) -> Self

Add an assistant text message (for multi-turn conversations)

Source

pub fn messages(self, msgs: Vec<Message>) -> Self

Set the full message list (for agentic loops where you manage messages)

Source

pub fn tool_results(self, results: Vec<ContentBlock>) -> Self

Add tool results as a user message (for the agentic tool loop)

Source

pub fn thinking_adaptive(self) -> Self

Enable adaptive thinking (recommended for Opus 4.6 / Sonnet 4.6). Claude dynamically decides when and how much to think.

Source

pub fn thinking_enabled(self, budget_tokens: usize) -> Self

Enable thinking with a fixed token budget (older models only). budget_tokens must be less than max_tokens (minimum 1024).

Source

pub fn thinking_disabled(self) -> Self

Explicitly disable thinking

Source

pub fn effort(self, level: &str) -> Self

Set the effort level: “low”, “medium”, “high” (default), or “max” (Opus only). Lower effort = cheaper/faster. Higher effort = deeper reasoning.

Source

pub fn tools(self, tools: Vec<Tool>) -> Self

Set the available tools for Claude to call

Source

pub fn tool_choice_auto(self) -> Self

Let Claude decide whether to use tools (default)

Source

pub fn tool_choice_any(self) -> Self

Force Claude to use at least one tool

Source

pub fn tool_choice_specific(self, name: &str) -> Self

Force Claude to use a specific tool by name

Source

pub fn tool_choice_none(self) -> Self

Prevent Claude from using any tools

Source

pub fn json_schema(self, schema: Value) -> Self

Constrain the response to match a JSON schema

Source

pub fn max_tokens(self, n: usize) -> Self

Maximum tokens to generate (default: 4096)

Source

pub fn temperature(self, t: f32) -> Self

Sampling temperature (0.0 = deterministic, 1.0 = creative)

Source

pub fn top_p(self, p: f32) -> Self

Nucleus sampling parameter

Source

pub fn top_k(self, k: usize) -> Self

Top-k sampling parameter

Source

pub fn stop_sequences(self, seqs: Vec<String>) -> Self

Custom stop sequences

Source

pub fn user_id(self, id: &str) -> Self

Set a user ID for tracking/billing

Source

pub fn beta(self, header: &str) -> Self

Enable a beta feature by header string (e.g. “compact-2026-01-12”)

Source

pub fn build(self) -> MessagesRequest

Build the request without sending (useful for inspection/testing)

Source

pub async fn send(&self) -> Result<MessagesResponse, ClaudeApiError>

Send the request and return the full response (non-streaming).

Source

pub async fn stream(&self) -> Result<SseParser, ClaudeApiError>

Send the request with streaming, returning an SSE event parser. Use parser.next_event() to consume events one at a time.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,