Struct CreateResponseRequest 

#[non_exhaustive]
pub struct CreateResponseRequest {

    pub input: ResponseInput,
    pub include: Option<Vec<Includable>>,
    pub instructions: Option<String>,
    pub max_output_tokens: Option<i32>,
    pub metadata: Option<Metadata>,
    pub model: ModelIdsResponses,
    pub parallel_tool_calls: bool,
    pub previous_response_id: Option<String>,
    pub reasoning: Option<Reasoning>,
    pub store: Option<bool>,
    pub stream: Option<bool>,
    pub temperature: Option<f32>,
    pub text: Option<TextResponseFormatConfigurationOptions>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<Tool>>,
    pub top_p: Option<f32>,
    pub truncation: Option<String>,
    pub user: Option<String>,
}

Represents the request body for creating a model response. Corresponds to the request body of POST /responses.

Used By

• api::responses::Responses::create

Fields (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.

input: ResponseInput

Text, image, or file inputs to the model.

include: Option<Vec<Includable>>

Additional output data to include (e.g., “file_search_call.results”).

instructions: Option<String>

System instructions for the model.

max_output_tokens: Option<i32>

Maximum output tokens allowed.

metadata: Option<Metadata>

Metadata associated with the request.

model: ModelIdsResponses

Model ID used to generate the response.

parallel_tool_calls: bool

Whether to allow parallel tool calls. Defaults to true.

previous_response_id: Option<String>

ID of the previous response in the conversation.

reasoning: Option<Reasoning>

Reasoning configuration.

store: Option<bool>

Whether to store the generated response. Defaults to true.

stream: Option<bool>

Whether to stream the response. Defaults to false.

temperature: Option<f32>

Sampling temperature.

text: Option<TextResponseFormatConfigurationOptions>

Text response format configuration.

tool_choice: Option<ToolChoice>

Strategy for choosing tools.

tools: Option<Vec<Tool>>

List of available tools.

top_p: Option<f32>

Nucleus sampling probability.

truncation: Option<String>

Truncation strategy (“auto” or “disabled”).

user: Option<String>

End-user identifier.

Implementations

impl CreateResponseRequest

pub fn former() -> CreateResponseRequestFormer<CreateResponseRequestFormerDefinition<(), CreateResponseRequest, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for CreateResponseRequest

fn clone(&self) -> CreateResponseRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CreateResponseRequestEnhancements for CreateResponseRequest

fn with_simple_text(model: &str, text: &str) -> CreateResponseRequest

Create a simple text request

fn with_messages( model: &str, messages: Vec<InputMessage>, ) -> CreateResponseRequest

Create a request with message-based input

fn validate_request(&self) -> Result<(), ResponseRequestValidationError>

Validate the request configuration

impl Debug for CreateResponseRequest

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

Formats the value using the given formatter.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for CreateResponseRequest

where __End: FormingEnd<CreateResponseRequestFormerDefinitionTypes<__Context, __Formed>>,

type Definition = CreateResponseRequestFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = CreateResponseRequestFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for CreateResponseRequest

type Types = CreateResponseRequestFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for CreateResponseRequest

where Definition: FormerDefinition<Storage = CreateResponseRequestFormerStorage>,

type Former = CreateResponseRequestFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for CreateResponseRequest

type Storage = CreateResponseRequestFormerStorage

The storage type used for forming the entity.

impl PartialEq for CreateResponseRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CreateResponseRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateResponseRequest