RealtimeClientEventResponseCancel interface

Senden Sie dieses Ereignis, um eine laufende Antwort abzubrechen. Der Server antwortet mit einem response.done Ereignis mit einem Status von response.status=cancelled. Gibt es keine Antwort zum Abbrechen, antwortet der Server mit einer Fehlermeldung. Es ist sicher anzurufen response.cancel , selbst wenn keine Antwort läuft; ein Fehler wird zurückgegeben und die Sitzung bleibt unbeeinflusst.

Extends

Eigenschaften

event_id

Optionale, vom Client generierte ID zur Identifikation dieses Ereignisses.

response_id

Eine spezifische Antwort-ID zum Stornieren – falls nicht angegeben, wird eine laufende Antwort in der Standardkonversation abgebrochen.

type

Der Ereignistyp muss sein response.cancel.

Details zur Eigenschaft

event_id

Optionale, vom Client generierte ID zur Identifikation dieses Ereignisses.

event_id?: string

Eigenschaftswert

string

response_id

Eine spezifische Antwort-ID zum Stornieren – falls nicht angegeben, wird eine laufende Antwort in der Standardkonversation abgebrochen.

response_id?: string

Eigenschaftswert

string

type

Der Ereignistyp muss sein response.cancel.

type: "response.cancel"

Eigenschaftswert

"response.cancel"