Method: projects.locations.collections.dataConnector.executeAction

Menjalankan tindakan pihak ketiga menggunakan DataConnector.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Resource DataConnector.

Konektor data yang digunakan untuk menjalankan tindakan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
Kolom
actionName

string

Wajib diisi. Nama tindakan.

Misalnya: "send_email"
args

object (Struct format)

Wajib. Argumen bernama dari tindakan.

Contoh: {"recipient": "tom@...", "subject": ... }

Jika ditawarkan kepada pengguna, bagian ini mungkin dapat diedit.
languageCode

string

Opsional. Bahasa yang akan digunakan untuk pesan status dan error yang dibuat oleh tindakan.
assistAnswerInfo

object (AssistAnswerInfo)

Opsional. Jika ditentukan, hasil eksekusi tindakan akan dikaitkan dengan jawaban bantuan yang diberikan. Dengan demikian, asisten dapat mempertimbangkan hasil tersebut dalam jawaban berikutnya pada sesi yang sama.

Sumber daya jawaban bantuan yang dirujuk harus ada.

Isi respons

Respons untuk metode DataConnectorService.ExecuteAction.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
Kolom
status

object (Status)

status eksekusi tindakan.
textResult

string

Hasil eksekusi tindakan yang dapat dibaca manusia jika berhasil.
result

object (Struct format)

Hasil mendetail dari eksekusi tindakan jika berhasil.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.dataConnectors.executeAction

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

AssistAnswerInfo

Pesan yang mengidentifikasi pemanggilan tindakan dalam jawaban bantuan.

Representasi JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
Kolom
assistAnswer

string

Wajib diisi. Nama jawaban bantuan.

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

string

Wajib. ID pemanggilan tindakan.