ResponsesRequest

Struct ResponsesRequest 

Source
pub struct ResponsesRequest {
Show 31 fields pub background: Option<bool>, pub include: Option<Vec<IncludeField>>, pub input: ResponseInput, pub instructions: Option<String>, pub max_output_tokens: Option<u32>, pub max_tool_calls: Option<u32>, pub metadata: Option<HashMap<String, Value>>, pub model: String, pub conversation: Option<String>, pub parallel_tool_calls: Option<bool>, pub previous_response_id: Option<String>, pub reasoning: Option<ResponseReasoningParam>, pub service_tier: Option<ServiceTier>, pub store: Option<bool>, pub stream: Option<bool>, pub temperature: Option<f32>, pub tool_choice: Option<ToolChoice>, pub tools: Option<Vec<ResponseTool>>, pub top_logprobs: Option<u32>, pub top_p: Option<f32>, pub truncation: Option<Truncation>, pub text: Option<TextConfig>, pub user: Option<String>, pub request_id: Option<String>, pub priority: i32, pub frequency_penalty: Option<f32>, pub presence_penalty: Option<f32>, pub stop: Option<StringOrArray>, pub top_k: i32, pub min_p: f32, pub repetition_penalty: f32,
}

Fields§

§background: Option<bool>

Run the request in the background

§include: Option<Vec<IncludeField>>

Fields to include in the response

§input: ResponseInput

Input content - can be string or structured items

§instructions: Option<String>

System instructions for the model

§max_output_tokens: Option<u32>

Maximum number of output tokens

§max_tool_calls: Option<u32>

Maximum number of tool calls

§metadata: Option<HashMap<String, Value>>

Additional metadata

§model: String

Model to use

§conversation: Option<String>

Optional conversation id to persist input/output as items

§parallel_tool_calls: Option<bool>

Whether to enable parallel tool calls

§previous_response_id: Option<String>

ID of previous response to continue from

§reasoning: Option<ResponseReasoningParam>

Reasoning configuration

§service_tier: Option<ServiceTier>

Service tier

§store: Option<bool>

Whether to store the response

§stream: Option<bool>

Whether to stream the response

§temperature: Option<f32>

Temperature for sampling

§tool_choice: Option<ToolChoice>

Tool choice behavior

§tools: Option<Vec<ResponseTool>>

Available tools

§top_logprobs: Option<u32>

Number of top logprobs to return

§top_p: Option<f32>

Top-p sampling parameter

§truncation: Option<Truncation>

Truncation behavior

§text: Option<TextConfig>

Text format for structured outputs (text, json_object, json_schema)

§user: Option<String>

User identifier

§request_id: Option<String>

Request ID

§priority: i32

Request priority

§frequency_penalty: Option<f32>

Frequency penalty

§presence_penalty: Option<f32>

Presence penalty

§stop: Option<StringOrArray>

Stop sequences

§top_k: i32

Top-k sampling parameter (SGLang extension)

§min_p: f32

Min-p sampling parameter (SGLang extension)

§repetition_penalty: f32

Repetition penalty (SGLang extension)

Trait Implementations§

Source§

impl Clone for ResponsesRequest

Source§

fn clone(&self) -> ResponsesRequest

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 ResponsesRequest

Source§

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

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

impl Default for ResponsesRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ResponsesRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl GenerationRequest for ResponsesRequest

Source§

fn is_stream(&self) -> bool

Check if the request is for streaming
Source§

fn get_model(&self) -> Option<&str>

Get the model name if specified
Source§

fn extract_text_for_routing(&self) -> String

Extract text content for routing decisions
Source§

impl Normalizable for ResponsesRequest

Source§

fn normalize(&mut self)

Normalize the request by applying defaults:

  1. Apply tool_choice defaults based on tools presence
  2. Apply parallel_tool_calls defaults
  3. Apply store field defaults
Source§

impl Serialize for ResponsesRequest

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 Validate for ResponsesRequest

Source§

impl<'v_a> ValidateArgs<'v_a> for ResponsesRequest

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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,