Method: projects.locations.apps.runAssistant

Executa o agente assistente para a sessão de assistente especificada.

Solicitação HTTP

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

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

Parâmetros de caminho

Parâmetros
app

string

Obrigatório. O app para o qual o assistente será executado. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo da solicitação

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

Representação JSON 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
Campos
assistantSession

string

Obrigatório. A sessão do assistente que será usada para executar o assistente. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

Obrigatório. A mensagem a ser enviada ao agente assistente.
interactionType

enum (RunAssistantRequest.InteractionType)

Opcional. Diferentes tipos de interação para a mensagem do assistente.

Corpo da resposta

Mensagem de resposta para AssistantService.RunAssistant.

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

Representação JSON 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
Campos
output

object (AssistantOutput)

Obrigatório. A saída do agente assistente.
state

enum (AssistantSessionState)

Apenas saída. O status da sessão do assistente.

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 app:

  • ces.apps.update

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

RunAssistantRequest.InteractionType

O tipo de interação da mensagem enviada ao assistente.

Tipos enumerados
INTERACTION_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se o tipo não for especificado.
NEW_MESSAGE A mensagem é uma entrada do usuário. A entrada do usuário é fornecida na lista de blocos.
POLL A mensagem é para consultar o estado da sessão do assistente.
DISMISS A mensagem é para dispensar a sessão do assistente que está aguardando análise. Isso vai mudar o estado da sessão do assistente para inativo.

AssistantOutput

A saída do agente assistente.

Representação JSON 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
Campos
message

object (AssistantMessage)

Obrigatório. A resposta do agente assistente.
userResponseSuggestions

object (UserResponseSuggestions)

Apenas saída. Respostas sugeridas do usuário pelo agente assistente.