Struct RealtimeResponseCreateParams 

pub struct RealtimeResponseCreateParams {
    pub modalities: Option<Vec<String>>,
    pub instructions: Option<String>,
    pub voice: Option<VoiceIdsShared>,
    pub output_audio_format: Option<String>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<String>,
    pub temperature: Option<f64>,
    pub max_response_output_tokens: Option<Value>,
    pub conversation: Option<String>,
    pub metadata: Option<Metadata>,
    pub input: Option<Vec<RealtimeConversationItemWithReference>>,
}

Parameters for creating a new Realtime response via the client event.

Used By

• RealtimeClientEventResponseCreate

Fields

modalities: Option<Vec<String>>

The set of modalities the model can respond with.

instructions: Option<String>

System instructions override for this response.

voice: Option<VoiceIdsShared>

Voice override for this response.

output_audio_format: Option<String>

Output audio format override for this response.

tools: Option<Vec<Tool>>

Tools override for this response.

tool_choice: Option<String>

Tool choice override for this response.

temperature: Option<f64>

Temperature override for this response.

max_response_output_tokens: Option<Value>

Max output tokens override for this response.

conversation: Option<String>

Conversation context override (“auto” or “none”).

metadata: Option<Metadata>

Metadata override for this response.

input: Option<Vec<RealtimeConversationItemWithReference>>

Input items override for this response’s context.

Implementations

impl RealtimeResponseCreateParams

pub fn former() -> RealtimeResponseCreateParamsFormer<RealtimeResponseCreateParamsFormerDefinition<(), RealtimeResponseCreateParams, ReturnPreformed>>

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

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<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for RealtimeResponseCreateParams

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

type Definition = RealtimeResponseCreateParamsFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = RealtimeResponseCreateParamsFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

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

type Types = RealtimeResponseCreateParamsFormerDefinitionTypes<__Context, __Formed>

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

impl<Definition> EntityToFormer<Definition> for RealtimeResponseCreateParams

where Definition: FormerDefinition<Storage = RealtimeResponseCreateParamsFormerStorage>,

type Former = RealtimeResponseCreateParamsFormer<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 RealtimeResponseCreateParams

type Storage = RealtimeResponseCreateParamsFormerStorage

The storage type used for forming the entity.

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