RealtimeClientEventResponseCancel interface

Envía este evento para cancelar una respuesta en curso. El servidor responderá con un response.done evento con un estado de response.status=cancelled. Si no hay respuesta para cancelar, el servidor responderá con un error. Es seguro llamar response.cancel aunque no haya respuesta en curso, se devolverá un error y la sesión permanecerá intacta.

Extends

Propiedades

event_id

ID opcional generado por el cliente para identificar este evento.

response_id

Un ID de respuesta específico para cancelar, si no se proporciona, cancelará una respuesta en curso en la conversación predeterminada.

type

El tipo de evento, debe ser response.cancel.

Detalles de las propiedades

event_id

ID opcional generado por el cliente para identificar este evento.

event_id?: string

Valor de propiedad

string

response_id

Un ID de respuesta específico para cancelar, si no se proporciona, cancelará una respuesta en curso en la conversación predeterminada.

response_id?: string

Valor de propiedad

string

type

El tipo de evento, debe ser response.cancel.

type: "response.cancel"

Valor de propiedad

"response.cancel"