Method: projects.locations.collections.dataConnector.buildActionInvocation

Membangun pemanggilan tindakan menggunakan DataConnector.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Resource DataConnector.

Konektor data yang digunakan untuk membuat pemanggilan tindakan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "actionName": string,
  "languageCode": string
}
Kolom
actionName

string

Wajib diisi. Nama tindakan.

Misalnya: "send_email"
languageCode

string

Opsional. Bahasa yang akan digunakan untuk pesan status dan error.

Isi respons

Respons untuk metode DataConnectorService.BuildActionInvocation.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
Kolom
actionInvocation

object (ActionInvocation)

Pemanggilan tindakan.

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.buildActionInvocation

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ActionInvocation

Mewakili pemanggilan tindakan.

Representasi JSON 
{
  "agentName": string,
  "actionName": string,
  "args": {
    object
  },
  "dataConnector": string,
  "dataSource": string,
  "invocationId": string,
  "actionDisplayName": string,
  "userConfirmationMessage": string,
  "authorizationUrl": string,
  "resendQueryOnUserAuthorization": boolean,
  "parameterDeclaration": {
    object
  },
  "argSetCandidates": [
    {
      object
    }
  ]
}
Kolom
agentName

string

Opsional. Nama agen yang melakukan tindakan.
actionName

string

nama tindakan.

Misalnya: "send_email"
args

object (Struct format)

Argumen bernama dari tindakan.

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

Jika ditawarkan kepada pengguna, bagian ini mungkin dapat diedit.

Jika ada beberapa opsi untuk argumen tindakan (misalnya, beberapa kemungkinan slot waktu untuk acara kalender), kolom ini akan menjelaskan opsi pertama.
dataConnector

string

Resource DataConnector.

Konektor data yang digunakan untuk melakukan tindakan.
dataSource

string

Hanya output. Nama sumber data.
invocationId

string

Hanya output. ID pemanggilan tindakan.
actionDisplayName

string

Hanya output. Nama tindakan yang dapat dibaca manusia yang ditampilkan kepada pengguna.
userConfirmationMessage

string

Hanya output. Pesan yang dapat dibaca manusia yang ditampilkan kepada pengguna bersama dengan dialog konfirmasi.
authorizationUrl

string

Hanya output. URL otorisasi.
resendQueryOnUserAuthorization

boolean

Hanya output. Jika benar, pemanggil harus mengirim ulang kueri setelah otorisasi pengguna.
parameterDeclaration

object (Struct format)

Khusus output. Deskripsi parameter tindakan, termasuk informasi rendering/validasi. Formatnya didasarkan pada spesifikasi parameter OpenAPI. Berdasarkan: https://swagger.io/docs/specification/describing-parameters/

Contoh:

{
    "type": "object",
    "properties": {
        "title": {
            "type": "string",
            "description": "title of the event",
        },
        "startTime": {
            "type": "string",
            "format": "date-time",
            "description": (
                "Start time of the meeting, e.g. 2024-07-12T23:30"
            ),
        },
        "attendees": {
            "type": "array",
            "items": {"type": "string", "format": "email"},
            "description": "List of email addresses of attendees",
        },
        "duration": {
            "type": "integer",
            "format": "int32",
            "minimum": 5,
            "maximum": 240,
            "default": { "numberValue": 30 },
            "description": (
                "Duration of the meeting in minutes. Defaults to 30"
                " minutes."
            ),
        },
        "timezone": {
            "type": "string",
            "description": (
                'IANA time Zone Database name, e.g. "Europe/Zurich". If'
                " omitted, timezone of the user will be used"
            ),
        },
        "eventType": {
            "type": "string",
            "enum": ["meeting", "focus_time", "out_of_office", "task"],
            "description": "type of the event",
        },
    },
    "required": ["startTime", "title", "attendees"]
}
argSetCandidates[]

object (Struct format)

Hanya output. Jika ada beberapa opsi untuk argumen tindakan (misalnya, beberapa kemungkinan slot waktu untuk acara kalender), kandidat argumen tambahan ini akan dicantumkan di kolom ini.

Berisi daftar set argumen, yang masing-masing diformat serupa dengan kolom args. Set argumen hanya berisi argumen yang berbeda dari kolom args. Saat ditawarkan kepada pengguna, nilai ini mungkin dapat diedit.

Contoh:

args berisi opsi pertama dengan semua argumen:

{"title": "Meeting with John", "startTime": "2024-08-01T13:30", ... }

argSetCandidates berisi opsi lainnya, tetapi hanya argumen yang berbeda yang diisi:

[{ "startTime": "2024-08-01T14:00" }, { "startTime": "2024-08-01T14:30" }, { "startTime": "2024-08-01T15:30" }]