RealtimeClientEventResponseCancel interface

Pacote:

@azure/ai-projects

Envie este evento para cancelar uma resposta em andamento. O servidor responderá com um response.done evento com um status de response.status=cancelled. Se não houver resposta para cancelar, o servidor responderá com um erro. É seguro ligar, response.cancel mesmo que nenhuma resposta esteja em andamento, um erro será retornado e a sessão permanecerá intacta.

Extends

RealtimeClientEvent

Propriedades

event_id	ID opcional gerado pelo cliente usado para identificar esse evento.
response_id	Um ID específico de resposta para cancelar – se não fornecida, cancelará uma resposta em andamento na conversa padrão.
type	O tipo de evento deve ser response.cancel.

Detalhes da propriedade

event_id

ID opcional gerado pelo cliente usado para identificar esse evento.

event_id?: string

Valor da propriedade

string

response_id

Um ID específico de resposta para cancelar – se não fornecida, cancelará uma resposta em andamento na conversa padrão.

response_id?: string

Valor da propriedade

string

type

O tipo de evento deve ser response.cancel.

type: "response.cancel"

Valor da propriedade

"response.cancel"