RealtimeClientEventResponseCancel interface

進行中の返信をキャンセルするには、このイベントを送信してください。 サーバーは、状態が response.done のresponse.status=cancelled イベントで応答します。 キャンセルの応答がなければ、サーバーはエラーで応答します。 応答がなくても response.cancel に連絡しても安全です。エラーが返されてセッション自体は影響を受けません。

Extends

プロパティ

event_id

このイベントを識別するためにオプションのクライアント生成IDを使用しています。

response_id

キャンセルする特定の応答IDが指定されなければ、デフォルトの会話で進行中の応答がキャンセルされます。

type

イベントの種類は response.cancelでなければなりません。

プロパティの詳細

event_id

このイベントを識別するためにオプションのクライアント生成IDを使用しています。

event_id?: string

プロパティ値

string

response_id

キャンセルする特定の応答IDが指定されなければ、デフォルトの会話で進行中の応答がキャンセルされます。

response_id?: string

プロパティ値

string

type

イベントの種類は response.cancelでなければなりません。

type: "response.cancel"

プロパティ値

"response.cancel"