Skip to main content

ResponsesRequestBuilder

Struct ResponsesRequestBuilder 

Source
pub struct ResponsesRequestBuilder { /* private fields */ }
Expand description

Builder for ResponsesRequest.

Implementations§

Source§

impl ResponsesRequestBuilder

Source

pub fn client<VALUE: Into<DeepSeekClient>>(self, value: VALUE) -> Self

Source

pub fn model<VALUE: Into<String>>(self, value: VALUE) -> Self

ID of the model to use. The Responses API currently only supports deepseek-v4-flash.

Source

pub fn input<VALUE: Into<Input>>(self, value: VALUE) -> Self

The input to the model. Either a plain string (treated as a single user message), or a list of input items.

At least one of input and instructions is required.

Source

pub fn instructions<VALUE: Into<String>>(self, value: VALUE) -> Self

A system-level instruction, inserted as the first system message of the model’s context.

Source

pub fn reasoning<VALUE: Into<Reasoning>>(self, value: VALUE) -> Self

Configuration of the thinking mode.

Source

pub fn max_output_tokens<VALUE: Into<u32>>(self, value: VALUE) -> Self

An upper bound for the number of tokens that can be generated in the response, including both the visible output tokens and the reasoning tokens.

Source

pub fn stream<VALUE: Into<bool>>(self, value: VALUE) -> Self

If set to true, the response is streamed as semantic server-sent events. The final event is response.completed / response.incomplete / response.failed (there is no data: [DONE] message).

Source

pub fn temperature<VALUE: Into<f64>>(self, value: VALUE) -> Self

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. Has no effect in thinking mode.

Source

pub fn top_p<VALUE: Into<f64>>(self, value: VALUE) -> Self

Possible values: <= 1

Default value: 1

An alternative to sampling with temperature, called nucleus sampling. Has no effect in thinking mode.

Source

pub fn text<VALUE: Into<Text>>(self, value: VALUE) -> Self

Configuration of the text output.

Source

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

A list of tools the model may call. Function names must be non-empty, at most 128 characters, match ^[a-zA-Z0-9_-]+$, and be unique across all tools. Besides function, the built-in web_search tool is supported and executed on the server side.

Source

pub fn tool<VALUE, FROM_VALUE: Into<VALUE>>(self, item: FROM_VALUE) -> Self
where Vec<Tool>: Default + Extend<VALUE>,

A list of tools the model may call. Function names must be non-empty, at most 128 characters, match ^[a-zA-Z0-9_-]+$, and be unique across all tools. Besides function, the built-in web_search tool is supported and executed on the server side.

Source

pub fn tool_choice<VALUE: Into<ToolChoice>>(self, value: VALUE) -> Self

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 (default) 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", "name": "my_function"} forces the model to call that tool.

Source

pub fn top_logprobs<VALUE: Into<u32>>(self, value: VALUE) -> Self

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.

Source

pub fn user<VALUE: Into<String>>(self, value: VALUE) -> Self

A custom end-user identifier, with allowed character set [a-zA-Z0-9\-_] and a maximum length of 512. Do not include user privacy information.

Source

pub fn build(self) -> Result<ResponsesRequest, ResponsesRequestBuilderError>

Builds a new ResponsesRequest.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Default for ResponsesRequestBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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