Struct RealtimeSessionCreateRequest 

pub struct RealtimeSessionCreateRequest {

    pub modalities: Option<Vec<String>>,
    pub model: Option<String>,
    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<RealtimeSessionInputAudioTranscription>,
    pub turn_detection: Option<RealtimeSessionTurnDetection>,
    pub input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<String>,
    pub temperature: Option<f64>,
    pub max_response_output_tokens: Option<Value>,
}

Represents the request body for creating or updating a Realtime session via REST or WebSocket.

Used By

• /realtime/sessions (POST)
• RealtimeClientEventSessionUpdate

Fields

modalities: Option<Vec<String>>

The set of modalities the model can respond with.

model: Option<String>

The Realtime model ID.

instructions: Option<String>

Default system instructions.

voice: Option<VoiceIdsShared>

Default voice for audio output.

input_audio_format: Option<String>

Format of input audio.

output_audio_format: Option<String>

Format of output audio.

input_audio_transcription: Option<RealtimeSessionInputAudioTranscription>

Input audio transcription configuration.

turn_detection: Option<RealtimeSessionTurnDetection>

Turn detection configuration.

input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>

Input audio noise reduction configuration.

tools: Option<Vec<Tool>>

Default tools available to the model.

tool_choice: Option<String>

Default tool choice strategy.

temperature: Option<f64>

Default sampling temperature.

max_response_output_tokens: Option<Value>

Default maximum output tokens.

Implementations

impl RealtimeSessionCreateRequest

pub fn former() -> RealtimeSessionCreateRequestFormer<RealtimeSessionCreateRequestFormerDefinition<(), RealtimeSessionCreateRequest, ReturnPreformed>>

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

Trait Implementations

impl Clone for RealtimeSessionCreateRequest

fn clone(&self) -> RealtimeSessionCreateRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeSessionCreateRequest

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

Formats the value using the given formatter.

impl Default for RealtimeSessionCreateRequest

fn default() -> RealtimeSessionCreateRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeSessionCreateRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

type Definition = RealtimeSessionCreateRequestFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = RealtimeSessionCreateRequestFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

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

type Types = RealtimeSessionCreateRequestFormerDefinitionTypes<__Context, __Formed>

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

impl<Definition> EntityToFormer<Definition> for RealtimeSessionCreateRequest

where Definition: FormerDefinition<Storage = RealtimeSessionCreateRequestFormerStorage>,

type Former = RealtimeSessionCreateRequestFormer<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 RealtimeSessionCreateRequest

type Storage = RealtimeSessionCreateRequestFormerStorage

The storage type used for forming the entity.

impl PartialEq for RealtimeSessionCreateRequest

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

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 RealtimeSessionCreateRequest