Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

Cancela a vez em andamento da sessão do assistente, se houver: a interrupção explícita do usuário para uma vez em execução separada de qualquer stream. Um cancelamento que chega em uma tarefa que não hospeda a vez a substitui pela época da vez da sessão, encerrando-a em uma renovação de concessão.

Solicitação HTTP

POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. A sessão do assistente em que a vez em andamento será cancelada.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "turnId": string
}
Campos
turnId

string

Opcional. A rodada a ser cancelada. Se estiver vazio, cancela a rodada em execução. Um cancelamento que nomeia uma rodada que não está mais em execução não tem efeito.

Corpo da resposta

Resposta para assistantSessions.cancelAssistantTurn.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "cancelled": boolean
}
Campos
cancelled

boolean

Se uma rodada em andamento foi encontrada e solicitada para ser interrompida (diretamente nesta tarefa ou por uma preempção de época para uma rodada hospedada em outro lugar).

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.assistantSessions.get

Para mais informações, consulte a documentação do IAM.