Struct RealtimeSessionCreateResponse

pub struct RealtimeSessionCreateResponse {

    pub client_secret: RealtimeSessionCreateResponseClientSecret,
    pub modalities: Option<Vec<RealtimeSessionCreateResponseModality>>,
    pub instructions: Option<String>,
    pub voice: Option<VoiceIdsShared>,
    pub input_audio_format: Option<String>,
    pub output_audio_format: Option<String>,
    pub input_audio_transcription: Option<RealtimeSessionCreateResponseInputAudioTranscription>,
    pub speed: Option<Number>,
    pub tracing: Option<RealtimeSessionCreateResponseTracing>,
    pub turn_detection: Option<RealtimeSessionCreateResponseTurnDetection>,
    pub tools: Option<Vec<RealtimeSessionCreateResponseTool>>,
    pub tool_choice: Option<String>,
    pub temperature: Option<Number>,
    pub max_response_output_tokens: Option<RealtimeSessionCreateResponseMaxResponseOutputTokens>,
}

A new Realtime session configuration, with an ephermeral key. Default TTL for keys is one minute.

Fields

client_secret: RealtimeSessionCreateResponseClientSecret

Ephemeral key returned by the API.

modalities: Option<Vec<RealtimeSessionCreateResponseModality>>

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 sage, shimmer and verse.

input_audio_format: Option<String>

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

output_audio_format: Option<String>

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

input_audio_transcription: Option<RealtimeSessionCreateResponseInputAudioTranscription>

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously and should be treated as rough guidance rather than the representation understood by the model.

speed: Option<Number>

The speed of the model’s spoken response. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.

tracing: Option<RealtimeSessionCreateResponseTracing>

Configuration options for tracing. Set to null to disable tracing. Once tracing is enabled for a session, the configuration cannot be modified.

auto will create a trace for the session with default values for the workflow name, group id, and metadata.

turn_detection: Option<RealtimeSessionCreateResponseTurnDetection>

Configuration for turn detection. Can be set to null to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.

tools: Option<Vec<RealtimeSessionCreateResponseTool>>

Tools (functions) available to the model.

tool_choice: Option<String>

How the model chooses tools. Options are auto, none, required, or specify a function.

temperature: Option<Number>

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

max_response_output_tokens: Option<RealtimeSessionCreateResponseMaxResponseOutputTokens>

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.

Implementations

impl RealtimeSessionCreateResponse

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

Create a builder for building RealtimeSessionCreateResponse. On the builder, call .client_secret(...), .modalities(...)(optional), .instructions(...)(optional), .voice(...)(optional), .input_audio_format(...)(optional), .output_audio_format(...)(optional), .input_audio_transcription(...)(optional), .speed(...)(optional), .tracing(...)(optional), .turn_detection(...)(optional), .tools(...)(optional), .tool_choice(...)(optional), .temperature(...)(optional), .max_response_output_tokens(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeSessionCreateResponse.

Trait Implementations

impl Clone for RealtimeSessionCreateResponse

fn clone(&self) -> RealtimeSessionCreateResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeSessionCreateResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeSessionCreateResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeSessionCreateResponse

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

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

const 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 RealtimeSessionCreateResponse

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 RealtimeSessionCreateResponse