Method: projects.locations.collections.dataConnector.executeAction

DataConnector を使用してサードパーティのアクションを実行します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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。