VoiceResponseBase Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v3.0.0-beta.3

Source:

VoiceResponseBase.cs

Properties shared by persisted voice responses.

public class VoiceResponseBase : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.VoiceResponseBase>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.VoiceResponseBase>

type VoiceResponseBase = class
    interface IJsonModel<VoiceResponseBase>
    interface IPersistableModel<VoiceResponseBase>

Public Class VoiceResponseBase
Implements IJsonModel(Of VoiceResponseBase), IPersistableModel(Of VoiceResponseBase)

Inheritance

Object

VoiceResponseBase

Derived

Azure.AI.Projects.Agents.VoiceResponse

Implements

IJsonModel<VoiceResponseBase> IPersistableModel<VoiceResponseBase> IPersistableModel<T>

Properties

Name	Description
MaxOutputTokens	Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types: Int64. "inf". </remarks> Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
Object	The object type, must be realtime.response.
OutputModalities	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.
Status	The final status of the response (completed, cancelled, failed, or incomplete, in_progress).
StatusDetails	Additional details about the status.
Usage	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.

Methods

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

Explicit Interface Implementations

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