VoiceResponse interface

Utrzymująca się odpowiedź głosowa reprezentująca jeden zwrot wnioskowania modelu w rozmowie. W wynikach output z listy projekcja może być pominięta; pobieranie pełnej odpowiedzi (GET .../responses/{response_id}) lub trasy stronicowanych elementów odpowiedzi (GET .../responses/{response_id}/items) dla jej elementów wyjściowych. created_at / completed_at są trwałymi rozszerzeniami zamówieniami Foundry.

Właściwości

audio

Konfiguracja dźwięku użyta do odpowiedzi, w tym format głosowy i audio użyty jako wyjście.

completed_at

Znacznik czasu w Unixie (w sekundach) oznaczający moment zakończenia odpowiedzi.

conversation_id

Do której rozmowy dołącza się odpowiedź, zależy od pola conversation zdarzenia response.create . Jeśli auto, odpowiedź zostanie dodana do domyślnej rozmowy, a wartość będzie conversation_id id jak conv_1234. Jeśli none, odpowiedź nie zostanie dodana do żadnej rozmowy, a wartość będzie conversation_id wynosić .null Jeśli odpowiedzi są wywoływane automatycznie przez VAD, zostaną dodane do domyślnej rozmowy

created_at

Znacznik czasu w Unixie (w sekundach) oznaczający moment utworzenia odpowiedzi.

id

Unikalne ID odpowiedzi będzie wyglądać jak resp_1234.

max_output_tokens

Maksymalna liczba tokenów wyjściowych dla jednej odpowiedzi asystenta, wliczając wywołania narzędzi, która została użyta w tej odpowiedzi.

metadata

Niestandardowe pary klucz-wartość powiązane z odpowiedzią.

object

Typ obiektu musi być .realtime.response

output

Lista elementów wyjściowych generowanych przez odpowiedź.

output_modalities

Zbiór modalności, których model wykorzystał do odpowiedzi, obecnie jedynymi możliwymi wartościami są , [\"text\"].[\"audio\"] Wyjście audio zawsze zawiera transkrypcję tekstową. Ustawienie wyjścia na tryb text wyłączy wyjście audio z modelu.

status

Ostateczny status odpowiedzi (completed, cancelled, failed, lub incomplete, in_progress).

status_details

Dodatkowe informacje o statusie.

temperature

Temperatura próbkowania użyta do odpowiedzi.

usage

Statystyki użytkowania dla Response, to będzie odpowiadać rozliczeniom. Sesja API w czasie rzeczywistym utrzymuje kontekst rozmowy i dodaje nowe elementy do rozmowy, dzięki czemu wyjście z poprzednich tur (tokeny tekstowe i audio) staje się wejściem dla późniejszych tur.

Szczegóły właściwości

audio

Konfiguracja dźwięku użyta do odpowiedzi, w tym format głosowy i audio użyty jako wyjście.

audio?: VoiceResponseAudio

Wartość właściwości

completed_at

Znacznik czasu w Unixie (w sekundach) oznaczający moment zakończenia odpowiedzi.

completed_at?: Date

Wartość właściwości

Date

conversation_id

Do której rozmowy dołącza się odpowiedź, zależy od pola conversation zdarzenia response.create . Jeśli auto, odpowiedź zostanie dodana do domyślnej rozmowy, a wartość będzie conversation_id id jak conv_1234. Jeśli none, odpowiedź nie zostanie dodana do żadnej rozmowy, a wartość będzie conversation_id wynosić .null Jeśli odpowiedzi są wywoływane automatycznie przez VAD, zostaną dodane do domyślnej rozmowy

conversation_id?: string

Wartość właściwości

string

created_at

Znacznik czasu w Unixie (w sekundach) oznaczający moment utworzenia odpowiedzi.

created_at?: Date

Wartość właściwości

Date

id

Unikalne ID odpowiedzi będzie wyglądać jak resp_1234.

id?: string

Wartość właściwości

string

max_output_tokens

Maksymalna liczba tokenów wyjściowych dla jednej odpowiedzi asystenta, wliczając wywołania narzędzi, która została użyta w tej odpowiedzi.

max_output_tokens?: number | "inf"

Wartość właściwości

number | "inf"

metadata

Niestandardowe pary klucz-wartość powiązane z odpowiedzią.

metadata?: Metadata

Wartość właściwości

object

Typ obiektu musi być .realtime.response

object?: "realtime.response"

Wartość właściwości

"realtime.response"

output

Lista elementów wyjściowych generowanych przez odpowiedź.

output?: RealtimeConversationItemUnion[]

Wartość właściwości

output_modalities

Zbiór modalności, których model wykorzystał do odpowiedzi, obecnie jedynymi możliwymi wartościami są , [\"text\"].[\"audio\"] Wyjście audio zawsze zawiera transkrypcję tekstową. Ustawienie wyjścia na tryb text wyłączy wyjście audio z modelu.

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

Wartość właściwości

("text" | "audio")[]

status

Ostateczny status odpowiedzi (completed, cancelled, failed, lub incomplete, in_progress).

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

Wartość właściwości

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

status_details

Dodatkowe informacje o statusie.

status_details?: RealtimeResponseStatusDetails

Wartość właściwości

temperature

Temperatura próbkowania użyta do odpowiedzi.

temperature?: number

Wartość właściwości

number

usage

Statystyki użytkowania dla Response, to będzie odpowiadać rozliczeniom. Sesja API w czasie rzeczywistym utrzymuje kontekst rozmowy i dodaje nowe elementy do rozmowy, dzięki czemu wyjście z poprzednich tur (tokeny tekstowe i audio) staje się wejściem dla późniejszych tur.

usage?: RealtimeResponseUsage

Wartość właściwości