VoiceAgentConnection interface
Ein verbundener, bidirektionaler Sprachagentenstrom.
Unterstützt genau eine Iteration for await über Server-Events; ein zweiter Versuch wirft.
Das frühe Verlassen der Schleife (break, , returnoder ein nicht erkannter Fehler im Schleifenkörper) schließt die Verbindung als Nebenwirkung.
Unerkannte Server-Ereignistypen werden als VoiceAgentUnknownEvent ausgeliefert, ohne den Strom zu unterbrechen. Fehlgeformte Ereignisse lassen die Iteration trotzdem mit einem Protokollfehler fehl.
- Extends
-
AsyncIterable<VoiceAgentRealtimeEvent>
Eigenschaften
| closed | Löst sich, sobald die Verbindung geschlossen ist. |
| state | Aktueller Verbindungszustand. |
Methoden
| cancel |
Hebt eine laufende Antwort ab. |
| clear |
Löscht gepufferte Eingabe-Audio. |
| clear |
Löscht ausstehende Ausgabe-Audio beim Service. |
| close(number, string) | Schließt elegant die WebSocket-Verbindung. |
| commit |
Übermittelt gepufferte Eingabe-Audio. |
| configure |
Updates unterstützten Live-Session-Einstellungen. |
| dispose() | Löst die Verbindung. Äquivalent zu close(). |
| request |
Bittet um eine neue Antwort. |
| send |
Fügt base64-codierte Audiobytes an den Eingabepuffer an. |
| send |
Sendet jedes generierte Client-Protokoll-Ereignis. |
| send |
Fügt ein Benutzertextelement hinzu und fordert standardmäßig eine Antwort an. |
| send |
Gibt dem Agenten ein vom Client ausgeführtes Funktionsergebnis zurück. |
Geerbte Methoden
| [async |
Details zur Eigenschaft
closed
Löst sich, sobald die Verbindung geschlossen ist.
closed: Promise<VoiceAgentCloseResult>Eigenschaftswert
Promise<VoiceAgentCloseResult>
state
Aktueller Verbindungszustand.
state: VoiceAgentConnectionStateEigenschaftswert
Details zur Methode
cancelResponse(VoiceAgentCancelResponseOptions)
Hebt eine laufende Antwort ab.
function cancelResponse(options?: VoiceAgentCancelResponseOptions): Promise<void>Parameter
- options
- VoiceAgentCancelResponseOptions
Gibt zurück
Promise<void>
clearInputAudio(VoiceAgentEventOptions)
Löscht gepufferte Eingabe-Audio.
function clearInputAudio(options?: VoiceAgentEventOptions): Promise<void>Parameter
- options
- VoiceAgentEventOptions
Gibt zurück
Promise<void>
clearOutputAudio(VoiceAgentEventOptions)
Löscht ausstehende Ausgabe-Audio beim Service.
function clearOutputAudio(options?: VoiceAgentEventOptions): Promise<void>Parameter
- options
- VoiceAgentEventOptions
Gibt zurück
Promise<void>
close(number, string)
Schließt elegant die WebSocket-Verbindung.
function close(code?: number, reason?: string): Promise<void>Parameter
- code
-
number
- reason
-
string
Gibt zurück
Promise<void>
commitAudio(VoiceAgentEventOptions)
Übermittelt gepufferte Eingabe-Audio.
function commitAudio(options?: VoiceAgentEventOptions): Promise<void>Parameter
- options
- VoiceAgentEventOptions
Gibt zurück
Promise<void>
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)
Updates unterstützten Live-Session-Einstellungen.
function configureSession(session: VoiceAgentSessionUpdateConfig, options?: VoiceAgentSessionUpdateOptions): Promise<void>Parameter
- session
- VoiceAgentSessionUpdateConfig
- options
- VoiceAgentSessionUpdateOptions
Gibt zurück
Promise<void>
dispose()
Löst die Verbindung. Äquivalent zu close().
function dispose(): Promise<void>Gibt zurück
Promise<void>
requestResponse(VoiceAgentResponseOptions)
Bittet um eine neue Antwort.
function requestResponse(options?: VoiceAgentResponseOptions): Promise<void>Parameter
- options
- VoiceAgentResponseOptions
Gibt zurück
Promise<void>
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)
Fügt base64-codierte Audiobytes an den Eingabepuffer an.
function sendAudio(audio: ArrayBuffer | Uint8Array, options?: VoiceAgentEventOptions): Promise<void>Parameter
- audio
-
ArrayBuffer | Uint8Array
- options
- VoiceAgentEventOptions
Gibt zurück
Promise<void>
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)
Sendet jedes generierte Client-Protokoll-Ereignis.
function sendEvent(event: VoiceAgentClientEvent, options?: VoiceAgentSendOptions): Promise<void>Parameter
- event
- VoiceAgentClientEvent
- options
- VoiceAgentSendOptions
Gibt zurück
Promise<void>
sendText(string, VoiceAgentSendTextOptions)
Fügt ein Benutzertextelement hinzu und fordert standardmäßig eine Antwort an.
function sendText(text: string, options?: VoiceAgentSendTextOptions): Promise<void>Parameter
- text
-
string
- options
- VoiceAgentSendTextOptions
Gibt zurück
Promise<void>
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)
Gibt dem Agenten ein vom Client ausgeführtes Funktionsergebnis zurück.
function sendToolOutput(callId: string, output: string, options?: VoiceAgentSendToolOutputOptions): Promise<void>Parameter
- callId
-
string
- output
-
string
- options
- VoiceAgentSendToolOutputOptions
Gibt zurück
Promise<void>
Details zur geerbten Methode
[asyncIterator]()
function [asyncIterator](): AsyncIterator<VoiceAgentRealtimeEvent, any, any>Gibt zurück
AsyncIterator<VoiceAgentRealtimeEvent, any, any>
Geerbt von AsyncIterable. [asyncIterator]