VoiceAgentRealtimeResponse interface

Paket:

@azure/ai-projects

Ett live-svar i realtid returnerades av röstagenttjänsten i både response.created och-händelserna response.done .

Extends

VoiceAgentRealtimeResponseBase

Egenskaper

audio	Ljudkonfigurationen som används av livesvaret, inklusive fälten för platt röst, plats och format under output.
output	Föremålen som produceras av live-svaret.

Ärvda egenskaper

conversation_id	Vilken konversation svaret läggs till i, bestäms av fältet conversation i response.create händelsen. Om auto, kommer svaret att läggas till i standardkonversationen och värdet av conversation_id blir ett id som conv_1234. Om none, kommer svaret inte att läggas till i någon konversation och värdet av conversation_id blir null. Om svar triggas automatiskt av VAD kommer svaret att läggas till i standardkonversationen
id	Det unika ID:t för svaret kommer att se ut som resp_1234.
max_output_tokens	Maximalt antal utmatningstoken för ett enda assistentsvar, inklusive verktygsanrop, som användes i detta svar.
metadata	Anpassade sträng-nyckel-värdespar kopplade till svaret.
object	Objekttypen måste vara realtime.response.
output_modalities	Den mängd modaliteter modellen använde för att svara är för närvarande de enda möjliga värdena [\"audio\"], [\"text\"]. Ljudutdata inkluderar alltid en texttranskription. Att ställa in utgången på läge text inaktiverar ljudutgången från modellen.
status	Svarets slutstatus (completed, cancelled, , failedeller incomplete, in_progress).
status_details	Ytterligare detaljer om statusen.
usage	Användningsstatistik för svaret, detta motsvarar faktureringen. En realtids-API-session upprätthåller en konversationskontext och lägger till nya Items i konversationen, så utdata från tidigare turer (text- och ljudtokens) blir indata för senare turer.

Egenskapsinformation

audio

Ljudkonfigurationen som används av livesvaret, inklusive fälten för platt röst, plats och format under output.

audio?: VoiceResponseAudio

Egenskapsvärde

VoiceResponseAudio

output

Föremålen som produceras av live-svaret.

output?: RealtimeConversationItemUnion[]

Egenskapsvärde

RealtimeConversationItemUnion[]

Information om ärvda egenskaper

conversation_id

Vilken konversation svaret läggs till i, bestäms av fältet conversation i response.create händelsen. Om auto, kommer svaret att läggas till i standardkonversationen och värdet av conversation_id blir ett id som conv_1234. Om none, kommer svaret inte att läggas till i någon konversation och värdet av conversation_id blir null. Om svar triggas automatiskt av VAD kommer svaret att läggas till i standardkonversationen

conversation_id?: string

Egenskapsvärde

string

Ärvd frånVoiceAgentRealtimeResponseBase.conversation_id

id

Det unika ID:t för svaret kommer att se ut som resp_1234.

id?: string

Egenskapsvärde

string

Ärvd frånVoiceAgentRealtimeResponseBase.id

max_output_tokens

Maximalt antal utmatningstoken för ett enda assistentsvar, inklusive verktygsanrop, som användes i detta svar.

max_output_tokens?: number | "inf"

Egenskapsvärde

number | "inf"

Ärvd frånVoiceAgentRealtimeResponseBase.max_output_tokens

metadata

Anpassade sträng-nyckel-värdespar kopplade till svaret.

metadata?: Metadata

Egenskapsvärde

Metadata

Ärvd frånVoiceAgentRealtimeResponseBase.metadata

object

Objekttypen måste vara realtime.response.

object?: "realtime.response"

Egenskapsvärde

"realtime.response"

Ärvt frånVoiceAgentRealtimeResponseBase.object

output_modalities

Den mängd modaliteter modellen använde för att svara är för närvarande de enda möjliga värdena [\"audio\"], [\"text\"]. Ljudutdata inkluderar alltid en texttranskription. Att ställa in utgången på läge text inaktiverar ljudutgången från modellen.

output_modalities?: ("text" | "audio")[]

Egenskapsvärde

("text" | "audio")[]

Ärvd frånVoiceAgentRealtimeResponseBase.output_modalities

status

Svarets slutstatus (completed, cancelled, , failedeller incomplete, in_progress).

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Egenskapsvärde

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Ärvd frånVoiceAgentRealtimeResponseBase.status

status_details

Ytterligare detaljer om statusen.

status_details?: RealtimeResponseStatusDetails

Egenskapsvärde

RealtimeResponseStatusDetails

Ärvt frånVoiceAgentRealtimeResponseBase.status_details

usage

Användningsstatistik för svaret, detta motsvarar faktureringen. En realtids-API-session upprätthåller en konversationskontext och lägger till nya Items i konversationen, så utdata från tidigare turer (text- och ljudtokens) blir indata för senare turer.

usage?: RealtimeResponseUsage

Egenskapsvärde

RealtimeResponseUsage

Ärvd frånVoiceAgentRealtimeResponseBase.usage