Method: projects.locations.collections.dataConnector.executeAction

使用 DataConnector 执行第三方操作。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。DataConnector 资源。

用于执行操作的数据连接器。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
字段
actionName

string

必需。操作的名称。

例如：“send_email”
args

object (Struct format)

必需。操作的具名实参。

例如：{"recipient": "tom@...", "subject": ... }

向用户提供时，此部分可能可供修改。
languageCode

string

可选。操作创建的状态和错误消息所使用的语言。
assistAnswerInfo

object (AssistAnswerInfo)

可选。如果指定，操作执行结果将与给定的辅助回答相关联。这样，助理便可在同一会话中后续的回答中将该结果考虑在内。

引用的辅助回答资源必须存在。

响应正文

对 DataConnectorService.ExecuteAction 方法的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
字段
status

object (Status)

操作执行状态。
textResult

string

成功执行操作后，人类可读的结果。
result

object (Struct format)

成功执行操作时的详细结果。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.dataConnectors.executeAction

如需了解详情，请参阅 IAM 文档。

AssistAnswerInfo

用于标识辅助回答中的操作调用的消息。

JSON 表示法 
{
  "assistAnswer": string,
  "invocationId": string
}
字段
assistAnswer

string

必需。辅助回答的名称。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}
invocationId

string

必需。操作调用 ID。