Lingua

ProjectsAgentsModelFactory.VoiceResponseBase Method

Definition

Properties shared by persisted voice responses.

public static Azure.AI.Projects.Agents.VoiceResponseBase VoiceResponseBase(Azure.AI.Projects.Agents.VoiceResponseBaseObject? object = default, OpenAI.VoiceResponseBaseStatus? status = default, OpenAI.Realtime.RealtimeResponseStatusDetails statusDetails = default, OpenAI.Realtime.RealtimeResponseUsage usage = default, System.Collections.Generic.IEnumerable<OpenAI.VoiceResponseBaseOutputModality> outputModalities = default, BinaryData maxOutputTokens = default);
static member VoiceResponseBase : Nullable<Azure.AI.Projects.Agents.VoiceResponseBaseObject> * Nullable<OpenAI.VoiceResponseBaseStatus> * OpenAI.Realtime.RealtimeResponseStatusDetails * OpenAI.Realtime.RealtimeResponseUsage * seq<OpenAI.VoiceResponseBaseOutputModality> * BinaryData -> Azure.AI.Projects.Agents.VoiceResponseBase
Public Shared Function VoiceResponseBase (Optional object As Nullable(Of VoiceResponseBaseObject) = Nothing, Optional status As Nullable(Of VoiceResponseBaseStatus) = Nothing, Optional statusDetails As RealtimeResponseStatusDetails = Nothing, Optional usage As RealtimeResponseUsage = Nothing, Optional outputModalities As IEnumerable(Of VoiceResponseBaseOutputModality) = Nothing, Optional maxOutputTokens As BinaryData = Nothing) As VoiceResponseBase

Parameters

object
Nullable<VoiceResponseBaseObject>

The object type, must be realtime.response.

status
Nullable<VoiceResponseBaseStatus>

The final status of the response (completed, cancelled, failed, or incomplete, in_progress).

statusDetails
OpenAI.Realtime.RealtimeResponseStatusDetails

Additional details about the status.

usage
OpenAI.Realtime.RealtimeResponseUsage

Usage statistics for the Response, this will correspond to billing. A Realtime 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.

outputModalities
IEnumerable<VoiceResponseBaseOutputModality>

The set of modalities the model used to respond, currently the only possible values are [\"audio\"], [\"text\"]. Audio output always include a text transcript. Setting the output to mode text will disable audio output from the model.

maxOutputTokens
BinaryData

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

Returns

A new VoiceResponseBase instance for mocking.

Applies to