Skip to main content

ChatRequest

Struct ChatRequest 

Source
pub struct ChatRequest {
Show 17 fields pub client: DeepSeekClient, pub messages: Vec<ChatMessage>, pub model: String, pub thinking: Option<Thinking>, pub reasoning_effort: Option<ReasoningEffort>, pub max_tokens: Option<u32>, pub response_format: Option<ResponseFormat>, pub stop: Option<Stop>, pub stream: Option<bool>, pub stream_options: Option<StreamOptions>, pub temperature: Option<f64>, pub top_p: Option<f64>, pub tools: Vec<Tool>, pub tool_choice: Option<ToolChoice>, pub logprobs: Option<bool>, pub top_logprobs: Option<u32>, pub user_id: Option<String>,
}
Expand description

Chat completion request body.

Fields§

§client: DeepSeekClient§messages: Vec<ChatMessage>

A list of messages comprising the conversation so far.

§model: String

Possible values: [deepseek-v4-flash, deepseek-v4-pro]

ID of the model to use.

§thinking: Option<Thinking>

Controls the switch between thinking and non-thinking mode.

§reasoning_effort: Option<ReasoningEffort>

Possible values: [high, max]

Controls the reasoning effort of the model. The default effort is high for regular requests; for some complex agent requests (such as Claude Code, OpenCode), effort is automatically set to max. For compatibility, low and medium are mapped to high, and xhigh is mapped to max.

§max_tokens: Option<u32>

The maximum number of tokens that can be generated in the chat completion.

The total length of input tokens and generated tokens is limited by the model’s context length.

For the value range and default value, please refer to the documentation.

§response_format: Option<ResponseFormat>

An object specifying the format that the model must output. Setting to { “type”: “json_object” } enables JSON Output, which guarantees the message the model generates is valid JSON.

Important: When using JSON Output, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly “stuck” request. Also note that the message content may be partially cut off if finish_reason=“length”, which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

§stop: Option<Stop>

Up to 16 sequences where the API will stop generating further tokens.

§stream: Option<bool>

If set, partial message deltas will be sent. Tokens will be sent as data-only server-sent events (SSE) as they become available, with the stream terminated by a `data: [DONE]`` message.

§stream_options: Option<StreamOptions>

Options for streaming response. Only set this when you set stream: true.

§temperature: Option<f64>

Possible values: <= 2

Default value: 1

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

§top_p: Option<f64>

Possible values: <= 1

Default value: 1

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

§tools: Vec<Tool>

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

§tool_choice: Option<ToolChoice>

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool. none is the default when no tools are present. auto is the default if tools are present.

§logprobs: Option<bool>

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

§top_logprobs: Option<u32>

Possible values: <= 20

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

§user_id: Option<String>

A custom user_id. Allowed character set is [a-zA-Z0-9\-_], with a maximum length of 512. Do not include user privacy information in the user_id. user_id can be used to distinguish user identities on your side to help us with content safety review. user_id can be used for KVCache isolation for privacy management. user_id can be used for scheduling isolation of users on your business side. For more details on the user_id parameter, please refer to Rate Limit & Isolation

Trait Implementations§

Source§

impl Clone for ChatRequest

Source§

fn clone(&self) -> ChatRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChatRequest

Source§

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

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

impl DeepSeekRequest for ChatRequest

Source§

type Response = ChatGeneric<ChatChoice>

Full response type for non-streaming calls.
Source§

type StreamItem = Result<ChatGeneric<ChatChoiceStream>, DeepSeekError>

Item type emitted by streaming calls.
Source§

type BlockingStream = ChatStreamBlocking

Blocking stream iterator type.
Source§

async fn send(self) -> Result<Chat, DeepSeekError>

Send a non-streaming request.
Source§

async fn stream(self) -> Result<Receiver<ChatStreamItem>, DeepSeekError>

Send a streaming request (SSE), returning a receiver of stream items.
Source§

fn stream_blocking(self) -> Result<ChatStreamBlocking, DeepSeekError>

Send a streaming request but consume results via a blocking iterator.
Source§

impl PartialEq for ChatRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for ChatRequest

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

impl StructuralPartialEq for ChatRequest

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> 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