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)

(選用步驟) 如果指定，動作執行結果會與指定的輔助回覆相關聯。這樣一來，Google 助理就能在同一個工作階段的後續回覆中，將結果納入考量。

參照的輔助回覆資源必須存在。

回應主體

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。