Struct RealtimeResponseCreateParams 

pub struct RealtimeResponseCreateParams {
    pub audio: ResponseAudio,
    pub conversation: Conversation,
    pub input: Vec<RealtimeConversationItem>,
    pub instructions: String,
    pub max_output_tokens: MaxOutputTokens,
    pub metadata: Option<Value>,
    pub output_modalities: Vec<String>,
    pub prompt: Option<Prompt>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<RealtimeTool>>,
}

Available on crate feature realtime only.

The response resource.

Fields

audio: ResponseAudio

Configuration for audio input and output.

conversation: Conversation

Controls which conversation the response is added to. Currently supports auto and none, with auto as the default value. The auto value means that the contents of the response will be added to the default conversation. Set this to none to create an out-of-band response which will not add items to default conversation.

input: Vec<RealtimeConversationItem>

Input items to include in the prompt for the model. Using this field creates a new context for this Response instead of using the default conversation. An empty array [] will clear the context for this Response. Note that this can include references to items that previously appeared in the session using their id.

instructions: String

The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. “be extremely succinct”, “act friendly”, “here are examples of good responses”) and on audio behavior (e.g. “talk quickly”, “inject emotion into your voice”, “laugh frequently”). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior. Note that the server sets default instructions which will be used if this field is not set and are visible in the session.created event at the start of the session.

max_output_tokens: MaxOutputTokens

Maximum number of output tokens for a single assistant response, inclusive of tool calls. Provide an integer between 1 and 4096 to limit output tokens, or inf for the maximum available tokens for a given model. Defaults to inf.

metadata: Option<Value>

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

output_modalities: Vec<String>

The set of modalities the model used to respond, currently the only possible values are ["audio"], ["text"]. Audio output always include a text transcript. Setting the output to mode text will disable audio output from the model.

prompt: Option<Prompt>

Reference to a prompt template and its variables. Learn more.

tool_choice: Option<ToolChoice>

How the model chooses tools. Provide one of the string modes or force a specific function/MCP tool.

tools: Option<Vec<RealtimeTool>>

Tools available to the model.

Trait Implementations

impl Clone for RealtimeResponseCreateParams

fn clone(&self) -> RealtimeResponseCreateParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeResponseCreateParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeResponseCreateParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RealtimeResponseCreateParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.