Struct RealtimeResponseCreateParams

pub struct RealtimeResponseCreateParams {
    pub modalities: Option<Vec<RealtimeResponseCreateParamsModality>>,
    pub instructions: Option<String>,
    pub voice: Option<VoiceIdsShared>,
    pub output_audio_format: Option<RealtimeResponseCreateParamsOutputAudioFormat>,
    pub tools: Option<Vec<RealtimeResponseCreateParamsTool>>,
    pub tool_choice: Option<String>,
    pub temperature: Option<f64>,
    pub max_response_output_tokens: Option<RealtimeResponseCreateParamsMaxResponseOutputTokens>,
    pub conversation: Option<RealtimeResponseCreateParamsConversation>,
    pub metadata: Option<Metadata>,
    pub input: Option<Vec<RealtimeConversationItemWithReference>>,
}

Create a new Realtime response with these parameters

Fields

modalities: Option<Vec<RealtimeResponseCreateParamsModality>>

The set of modalities the model can respond with. To disable audio, set this to [“text”].

instructions: Option<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.

voice: Option<VoiceIdsShared>

The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are alloy, ash, ballad, coral, echo, fable, onyx, nova, sage, shimmer, and verse.

output_audio_format: Option<RealtimeResponseCreateParamsOutputAudioFormat>

The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw.

tools: Option<Vec<RealtimeResponseCreateParamsTool>>

Tools (functions) available to the model.

tool_choice: Option<String>

How the model chooses tools. Options are auto, none, required, or specify a function, like {"type": "function", "function": {"name": "my_function"}}.

temperature: Option<f64>

Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.

max_response_output_tokens: Option<RealtimeResponseCreateParamsMaxResponseOutputTokens>

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.

conversation: Option<RealtimeResponseCreateParamsConversation>

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.

metadata: Option<Metadata>

input: Option<Vec<RealtimeConversationItemWithReference>>

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 from the default conversation.

Implementations

impl RealtimeResponseCreateParams

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

Create a builder for building RealtimeResponseCreateParams. On the builder, call .modalities(...)(optional), .instructions(...)(optional), .voice(...)(optional), .output_audio_format(...)(optional), .tools(...)(optional), .tool_choice(...)(optional), .temperature(...)(optional), .max_response_output_tokens(...)(optional), .conversation(...)(optional), .metadata(...)(optional), .input(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeResponseCreateParams.

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 Default for RealtimeResponseCreateParams

fn default() -> RealtimeResponseCreateParams

Returns the “default value” for a type.

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 PartialEq for RealtimeResponseCreateParams

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

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 RealtimeResponseCreateParams