Method: projects.locations.apps.executeTool

Menjalankan alat yang diberikan dengan argumen yang diberikan.

Permintaan HTTP

POST https://ces.googleapis.com/v1/{parent=projects/*/locations/*/apps/*}:executeTool

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource aplikasi yang memiliki alat/kumpulan alat. Format: projects/{project}/locations/{location}/apps/{app}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "args": {
    object
  },
  "mockConfig": {
    object (MockConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "variables": {
    object
  },
  "context": {
    object
  }
  // End of mutually exclusive fields.
}
Kolom
args

object (Struct format)

Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
mockConfig

object (MockConfig)

Opsional. Konfigurasi tiruan untuk eksekusi alat. Jika kolom ini disetel, alat yang memanggil alat lain akan di-mock berdasarkan pola dan respons yang diberikan.
ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
tool

string

Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opsional. Alat toolset yang akan dijalankan. Hanya satu alat yang harus cocok dengan predikat dari toolset. Jika tidak, error akan ditampilkan.
Akhir kolom yang saling eksklusif.
Konteks tambahan yang akan diberikan untuk eksekusi alat Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
variables

object (Struct format)

Opsional. Variabel yang tersedia untuk eksekusi alat.
context

object (Struct format)

Opsional. [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment untuk mengetahui detailnya) yang akan diteruskan ke alat Python.
Akhir kolom yang saling eksklusif.

Isi respons

Pesan respons untuk ToolService.ExecuteTool.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "response": {
    object
  },
  "variables": {
    object
  },
  "citations": {
    object (Citations)
  },
  "googleSearchSuggestions": {
    object (GoogleSearchSuggestions)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Kolom
response

object (Struct format)

Hasil eksekusi alat dalam format objek JSON. Gunakan kunci "output" untuk menentukan respons alat dan kunci "error" untuk menentukan detail error (jika ada). Jika kunci "output" dan "error" tidak ditentukan, seluruh "respons" akan diperlakukan sebagai hasil eksekusi alat.
variables

object (Struct format)

Nilai variabel di akhir eksekusi alat.
citations

object (Citations)

Kutipan yang memberikan informasi sumber untuk eksekusi alat.
googleSearchSuggestions

object (GoogleSearchSuggestions)

Saran yang ditampilkan dari Google Penelusuran sebagai hasil dari pemanggilan Alat Penelusuran Google selama eksekusi alat.
ID alat yang dieksekusi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
tool

string

Nama alat yang dijalankan. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Alat toolset yang dieksekusi.
Akhir kolom yang saling eksklusif.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • ces.tools.execute

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

MockConfig

Konfigurasi panggilan alat tiruan untuk sesi.

Representasi JSON 
{
  "mockedToolCalls": [
    {
      object (MockedToolCall)
    }
  ],
  "unmatchedToolCallBehavior": enum (MockConfig.UnmatchedToolCallBehavior)
}
Kolom
mockedToolCalls[]

object (MockedToolCall)

Opsional. Semua panggilan alat yang akan di-mock selama durasi sesi.
unmatchedToolCallBehavior

enum (MockConfig.UnmatchedToolCallBehavior)

Wajib. Perilaku untuk panggilan alat yang tidak cocok dengan pola argumen apa pun di mockedToolCalls.

MockedToolCall

Panggilan alat tiruan.

Mengekspresikan alat target + pola untuk dicocokkan dengan argumen / input alat tersebut. Jika pola cocok, respons tiruan akan ditampilkan.

Representasi JSON 
{
  "tool": string,
  "expectedArgsPattern": {
    object
  },
  "mockResponse": {
    object
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "toolId": string,
  "toolset": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Kolom
tool
(deprecated)

string

Opsional. Tidak digunakan lagi. Gunakan tool_identifier sebagai gantinya.
expectedArgsPattern

object (Struct format)

Wajib. Pola untuk mencocokkan argumen / input dari semua panggilan alat yang dikirim. Jika input panggilan alat cocok dengan pola ini, output tiruan akan ditampilkan.
mockResponse

object (Struct format)

Opsional. Respons / output tiruan yang akan ditampilkan jika argumen / input panggilan alat cocok dengan pola.
ID alat yang akan di-mock. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
toolId

string

Opsional. Nama alat yang akan di-mock. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset

object (ToolsetTool)

Opsional. Kumpulan alat untuk membuat tiruan.
Akhir kolom yang saling eksklusif.

MockConfig.UnmatchedToolCallBehavior

Tindakan yang harus dilakukan saat panggilan alat tidak cocok dengan panggilan alat tiruan.

Enum
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
FAIL Menampilkan error untuk panggilan alat apa pun yang tidak cocok dengan pola input yang diharapkan tiruan.
PASS_THROUGH Untuk panggilan alat yang tidak cocok, teruskan panggilan alat ke alat yang sebenarnya.