Struct CreateResponse

pub struct CreateResponse {
    pub create_model_response_properties: CreateModelResponseProperties,
    pub response_properties: ResponseProperties,
    pub input: CreateResponseInput,
    pub include: Option<Vec<Includable>>,
    pub parallel_tool_calls: Option<bool>,
    pub store: Option<bool>,
    pub stream: Option<bool>,
}

Fields

create_model_response_properties: CreateModelResponseProperties

response_properties: ResponseProperties

input: CreateResponseInput

Text, image, or file inputs to the model, used to generate a response.

Learn more:

• Text inputs and outputs
• Image inputs
• File inputs
• Conversation state
• Function calling

include: Option<Vec<Includable>>

Specify additional output data to include in the model response. Currently supported values are:

• file_search_call.results: Include the search results of the file search tool call.
• message.input_image.image_url: Include image urls from the input message.
• computer_call_output.output.image_url: Include image urls from the computer call output.
• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).
• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.

parallel_tool_calls: Option<bool>

Whether to allow the model to run tool calls in parallel.

store: Option<bool>

Whether to store the generated model response for later retrieval via API.

stream: Option<bool>

If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.

Implementations

impl CreateResponse

pub fn builder() -> CreateResponseBuilder<((), (), (), (), (), (), ())>

Create a builder for building CreateResponse. On the builder, call .create_model_response_properties(...)(optional), .response_properties(...)(optional), .input(...), .include(...)(optional), .parallel_tool_calls(...)(optional), .store(...)(optional), .stream(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateResponse.

Trait Implementations

impl Clone for CreateResponse

fn clone(&self) -> CreateResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateResponse

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateResponse

fn eq(&self, other: &CreateResponse) -> 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 CreateResponse

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 CreateResponse