Method: projects.locations.collections.dataConnector.executeAction

Executa uma ação de terceiros usando o DataConnector.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:executeAction

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Recurso DataConnector.

O conector de dados usado para executar a ação.

Corpo da solicitação

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

Representação JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Campos
actionName

string

Obrigatório. Nome da ação.

Por exemplo: "send_email"
args

object (Struct format)

Obrigatório. Argumentos nomeados da ação.

Por exemplo: {"recipient": "tom@...", "subject": ... }

Quando oferecida a um usuário, essa parte pode ser editável.
languageCode

string

Opcional. Idioma a ser usado para mensagens de status e erro criadas por ações.
assistAnswerInfo

object (AssistAnswerInfo)

Opcional. Se especificado, o resultado da execução da ação será associado à resposta de assistência fornecida. Assim, o assistente pode considerar o resultado em respostas subsequentes na mesma sessão.

O recurso de resposta de assistência referenciado precisa existir.

Corpo da resposta

Resposta para o método DataConnectorService.ExecuteAction.

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

Representação JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Campos
status

object (Status)

status da execução da ação.
textResult

string

Resultado legível da execução da ação em caso de sucesso.
result

object (Struct format)

Resultado detalhado da execução da ação em caso de sucesso.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

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

  • discoveryengine.dataConnectors.executeAction

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

AssistAnswerInfo

Mensagem que identifica uma invocação de ação na resposta do assistente.

Representação JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
Campos
assistAnswer

string

Obrigatório. Nome da resposta do assistente.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}
invocationId

string

Obrigatório. O ID da invocação da ação.