VoiceAgentRealtimeResponse interface
Odpowiedź na żywo w czasie rzeczywistym przez usługę agenta głosowego w obu response.created przypadkach i response.done zdarzeniach.
Właściwości
| audio | Konfiguracja dźwięku używana przez odpowiedź na żywo, w tym pola dostawcy głosu płaskiego, lokalizacji i formatu pod . |
| conversation_id | Do której rozmowy dołącza się odpowiedź, zależy od pola |
| id | Unikalne ID odpowiedzi będzie wyglądać jak |
| 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ć . |
| 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ą , |
| status | Ostateczny status odpowiedzi ( |
| status_details | Dodatkowe informacje o statusie. |
| 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żywana przez odpowiedź na żywo, w tym pola dostawcy głosu płaskiego, lokalizacji i formatu pod .output
audio?: VoiceResponseAudioWartość właściwości
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?: stringWartość właściwości
string
id
Unikalne ID odpowiedzi będzie wyglądać jak resp_1234.
id?: stringWartość 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?: MetadataWartość 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?: RealtimeResponseStatusDetailsWartość właściwości
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