Share via

SessionResponse Class

Definition

Namespace:
Azure.AI.VoiceLive
Assembly:
Azure.AI.VoiceLive.dll
Package:
Azure.AI.VoiceLive v1.0.0
Package:
Azure.AI.VoiceLive v1.0.0-beta.4
Source:
SessionResponse.cs
Source:
SessionResponse.cs

The response resource.

public class SessionResponse : System.ClientModel.Primitives.IJsonModel<Azure.AI.VoiceLive.SessionResponse>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.VoiceLive.SessionResponse>
type SessionResponse = class
    interface IJsonModel<SessionResponse>
    interface IPersistableModel<SessionResponse>
Public Class SessionResponse
Implements IJsonModel(Of SessionResponse), IPersistableModel(Of SessionResponse)
Inheritance
Object
SessionResponse
Implements
IJsonModel<SessionResponse> IPersistableModel<SessionResponse> IPersistableModel<T>

Properties

ConversationId

Which conversation the response is added to, determined by the conversation field in the response.create event. If auto, the response will be added to the default conversation and the value of conversation_id will be an id like conv_1234. If none, the response will not be added to any conversation and the value of conversation_id will be null. If responses are being triggered by server VAD, the response will be added to the default conversation, thus the conversation_id will be an id like conv_1234.
Id

The unique ID of the response.
MaxOutputTokens

Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.
Modalities

The set of modalities the model used to respond. If there are multiple modalities, the model will pick one, for example if modalities is ["text", "audio"], the model could be responding in either text or audio.
ModalitiesInternal

The set of modalities the model used to respond. If there are multiple modalities, the model will pick one, for example if modalities is ["text", "audio"], the model could be responding in either text or audio.
Object

The object type, must be realtime.response.
Output

The list of output items generated by the response.
OutputAudioFormat

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

The final status of the response.

One of: completed, cancelled, failed, incomplete, or in_progress.
StatusDetails

Additional details about the status.
Temperature

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

Usage statistics for the Response, this will correspond to billing. A VoiceLive API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns.
Voice

supported voice identifiers and configurations.

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SessionResponse>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SessionResponse>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SessionResponse>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SessionResponse>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SessionResponse>.Write(ModelReaderWriterOptions)

Applies to