Method: projects.locations.collections.dataConnector.executeAction

Executa uma ação de terceiros através da app DataConnector.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. DataConnector recurso.

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

Corpo do pedido

O corpo do pedido 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 com nome da ação.

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

Quando oferecida a um utilizador, esta parte pode ser editável.
languageCode

string

Opcional. Idioma a usar para mensagens de estado e de erro criadas por ações.
assistAnswerInfo

object (AssistAnswerInfo)

Opcional. Se especificado, o resultado da execução da ação é associado à resposta do assistente fornecida. Isto permite que o assistente tenha em conta o resultado em respostas subsequentes na mesma sessão.

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

Corpo da resposta

Resposta para o método DataConnectorService.ExecuteAction.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (Status)

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

string

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

object (Struct format)

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

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de 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 de assistência.

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

string

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