Share via


VoiceLiveSessionResponse Class

Definition

Base for session configuration in the response.

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

Constructors

Name Description
VoiceLiveSessionResponse()

Initializes a new instance of VoiceLiveSessionResponse.

Properties

Name Description
Animation

The animation configuration for the session.

Avatar

Configuration for avatar streaming and behavior during the session.

Id

The unique identifier for the session.

InputAudioEchoCancellation

Configuration for echo cancellation during server-side audio processing.

InputAudioFormat

Input audio format. Default is 'pcm16'.

InputAudioNoiseReduction

Configuration for input audio noise reduction.

InputAudioSamplingRate

Input audio sampling rate in Hz. Available values:

  • For pcm16: 8000, 16000, 24000

  • For g711_alaw/g711_ulaw: 8000

InputAudioTranscription

Configuration for input audio transcription.

Instructions

Optional instructions to guide the model's behavior throughout the session.

MaxResponseOutputTokens

Gets or sets the maximum number of tokens to generate in the response.

Modalities

The modalities to be used in the session.

Model

The model for the session.

OutputAudioFormat

Output audio format. Default is 'pcm16'.

OutputAudioTimestampTypes

Types of timestamps to include in audio response content.

Temperature

Controls the randomness of the model's output. Range: 0.0 to 1.0. Default is 0.7.

ToolChoice

Gets or sets the tool choice strategy for response generation.

Tools

Configuration for tools to be used during the session, if applicable.

TurnDetection

Gets or sets the TurnDetection.

Voice

Gets or sets the Voice.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<VoiceLiveSessionResponse>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<VoiceLiveSessionResponse>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<VoiceLiveSessionResponse>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<VoiceLiveSessionResponse>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<VoiceLiveSessionResponse>.Write(ModelReaderWriterOptions)

Applies to