REST Resource: projects.locations.collections.engines.agents

Resource: Agent

Melakukan tugas spesifik yang telah ditentukan sebelumnya.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
Kolom
name

string

ID. Nama resource agen. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} atau projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Wajib. Nama tampilan agen. Hal ini dapat digunakan oleh LLM untuk otomatis memilih agen yang akan merespons kueri pengguna.
description

string

Wajib. Deskripsi agen yang dapat dibaca manusia. Hal ini dapat digunakan oleh LLM untuk otomatis memilih agen yang akan merespons kueri pengguna.
icon

object (Image)

Opsional. Ikon yang merepresentasikan agen di UI.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat Agen ini dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Khusus output. Stempel waktu saat Agen ini terakhir diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Opsional. Tidak digunakan lagi: Gunakan Agent.authorization_config sebagai gantinya. Daftar otorisasi yang diperlukan untuk agen ini.
authorizationConfig

object (AuthorizationConfig)

Opsional. Otorisasi yang diperlukan oleh agen.
dataStoreSpecs

object (DataStoreSpecs)

Opsional. DataStoreSpecs yang terkait dengan agen. Jika kolom ini tidak disetel, semua penyimpanan data di mesin akan digunakan.
state

enum (State)

Hanya output. Status siklus proses agen.
toolSettings
(deprecated)

object (AgentToolSettings)

Opsional. TIDAK DIGUNAKAN LAGI: Migrasi terencana ke definisi AgentCard.
languageCode

string

Opsional. Kode bahasa teks di kolom description, displayName, dan starterPrompts.
starterPrompts[]

object (StarterPrompt)

Opsional. Saran perintah awal untuk ditampilkan kepada pengguna di halaman landing agen.
customPlaceholderText

string

Opsional. Teks placeholder kustom yang muncul di kotak teks sebelum pengguna memasukkan teks apa pun.
Kolom union definition. Definisi agen. LINT.IfChange(definition) definition hanya dapat berupa salah satu dari berikut ini:
adkAgentDefinition

object (AdkAgentDefinition)

Opsional. Perilaku agen ditentukan sebagai agen ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Opsional. Perilaku agen yang dikelola Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Opsional. Perilaku agen ditentukan sebagai agen A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Opsional. Perilaku agen ditentukan sebagai agen Dialogflow.
Kolom union agent_state_reason. Alasan mengapa agen berada dalam statusnya saat ini. agent_state_reason hanya ada berupa salah satu diantara berikut:
suspensionReason

string

Hanya output. Alasan agen ditangguhkan. Hanya disetel jika statusnya SUSPENDED.
rejectionReason

string

Hanya output. Alasan agen ditolak. Hanya disetel jika statusnya adalah PRIVATE, dan sampai ke sana melalui penolakan.
deploymentFailureReason

string

Hanya output. Alasan deployment agen gagal. Hanya disetel jika statusnya adalah DEPLOYMENT_FAILED.

AdkAgentDefinition

Menyimpan definisi agen yang menggunakan ADK dan di-deploy ke Agent Engine (sebelumnya dikenal sebagai Reasoning Engine).

Representasi JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Kolom
toolSettings

object (AgentToolSettings)

Opsional. Parameter yang menentukan cara agen ditampilkan ke LLM perencana.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Opsional. Mesin penalaran yang terhubung ke agen.
authorizations[]
(deprecated)

string

Opsional. TIDAK DIGUNAKAN LAGI: Gunakan Agent.authorizations sebagai gantinya. Nama resource otorisasi yang diperlukan. Jika pengguna tidak diberi otorisasi, layanan akan menampilkan sejumlah URI otorisasi yang harus dibuka dan diberi otorisasi oleh pengguna di browser. Setelah semua otorisasi diberikan, pengguna dapat mencoba kembali kueri, dan otorisasi akan diteruskan ke agen.

Format: projects/{project}/locations/{location}/authorizations/{authorization}

AgentToolSettings

Setelan untuk alat yang merepresentasikan agen ke LLM perencana Agentspace.

Representasi JSON 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Kolom
toolDescription

string

Wajib. Hal ini dapat digunakan oleh LLM untuk menjelaskan kapan agen harus digunakan.
inputParameterName

string

Opsional. Nama parameter untuk panggilan fungsi. Nama parameter ini akan memberi petunjuk kepada LLM tentang jenis konten yang diharapkan ada dalam parameter, misalnya "pertanyaan", "perintah", "searchQuery", dll.
inputParameterDescription

string

Opsional. Deskripsi parameter untuk panggilan fungsi. Deskripsi ini akan memberikan informasi selengkapnya kepada LLM tentang parameter, misalnya jenis konten yang diharapkan untuk diteruskan dan tindakan apa yang harus dilakukan terhadapnya.

ProvisionedReasoningEngine

Melacak mesin penalaran yang terhubung ke agen. Pesan ini tidak dimaksudkan untuk melacak siklus proses agen. Sebagai gantinya, hanya digunakan untuk menentukan parameter guna terhubung ke agen yang sudah di-deploy ke mesin penalaran.

Representasi JSON 
{
  "reasoningEngine": string
}
Kolom
reasoningEngine

string

Wajib. Mesin penalaran yang terhubung ke agen. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Menyimpan definisi agen yang dikelola Google.

Representasi JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "authorizations": [
    string
  ],
  "deploymentInfo": {
    object (DeploymentInfo)
  },

  // Union field agent_config can be only one of the following:
  "dataScienceAgentConfig": {
    object (DataScienceAgentConfig)
  }
  // End of list of possible types for union field agent_config.
}
Kolom
toolSettings

object (AgentToolSettings)

Opsional. Parameter yang menentukan cara agen ditampilkan ke LLM perencana.
authorizations[]
(deprecated)

string

Opsional. TIDAK DIGUNAKAN LAGI: Gunakan Agent.authorizations sebagai gantinya. Nama resource otorisasi yang diperlukan. Jika pengguna tidak diberi otorisasi, layanan akan menampilkan sejumlah URI otorisasi yang harus dibuka dan diberi otorisasi oleh pengguna di browser. Setelah semua otorisasi diberikan, pengguna dapat mencoba kembali kueri, dan otorisasi akan diteruskan ke agen.

Format: projects/{project}/locations/{location}/authorizations/{authorization}
deploymentInfo

object (DeploymentInfo)

Hanya output. Informasi deployment otomatis untuk agen.
Kolom union agent_config. Konfigurasi khusus jenis agen. agent_config hanya ada berupa salah satu diantara berikut:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Opsional. Konfigurasi khusus untuk agen sains data buatan Google. Struktur data ini ditujukan untuk menyimpan konfigurasi waktu permintaan dan deployment untuk agen.

DataScienceAgentConfig

Konfigurasi khusus untuk agen sains data buatan Google. Struktur data ini ditujukan untuk menyimpan konfigurasi waktu permintaan dan deployment untuk agen.

Representasi JSON 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Kolom
bqProjectId

string

Wajib. ID project BigQuery tempat set data berada.
bqDatasetId

string

Wajib. ID set data BigQuery yang akan digunakan untuk agen. Set data harus berada di project yang ditentukan oleh bqProjectId.
blocklistTables[]

string

Opsional. Tabel BigQuery yang akan diblokir agar tidak digunakan oleh agen.
allowlistTables[]

string

Opsional. Tabel BigQuery yang diizinkan untuk digunakan oleh agen.
nlQueryConfig

object (NlQueryConfig)

Opsional. Konfigurasi yang disediakan pelanggan.

NlQueryConfig

Tentukan konfigurasi yang disediakan pelanggan khusus untuk terjemahan bahasa alami ke kode SQL/Python.

Representasi JSON 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Kolom
nl2sqlPrompt

string

Opsional. Pelanggan memberikan petunjuk NL2SQL
nl2pyPrompt

string

Opsional. Pelanggan memberikan petunjuk bagi LLM untuk menulis kode python untuk analisis data.
nl2sqlExamples[]

object (Nl2SqlExample)

Opsional. Pelanggan memberikan contoh NL2SQL, termasuk input dan SQL yang diharapkan.
schemaDescription

string

Opsional. Deskripsi bahasa alami tentang skema set data BigQuery.
bqSqlGenUseCustomPrompt

boolean

Opsional. Apakah akan menggunakan perintah kustom untuk layanan Pembuatan SQL BigQuery.

Nl2SqlExample

Satu contoh NL2SQL.

Representasi JSON 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Kolom
query

string

Opsional. Kueri bahasa alami yang akan dijawab.
expectedSql

string

Opsional. Output SQL yang diharapkan.
expectedResponse

string

Opsional. Respons yang diharapkan terhadap kueri.

DeploymentInfo

Informasi deployment otomatis untuk agen.

Representasi JSON 
{
  "operation": string,
  "finishTime": string
}
Kolom
operation

string

Hanya output. Resource operasi yang berjalan lama untuk deployment. Dapat digunakan untuk melakukan polling status deployment. Setelah deployment selesai, kolom ini akan kosong. Jika deployment gagal,kolom akan berisi nama resource LRO yang gagal, tetapi resource operasi itu sendiri akan dihapus secara otomatis setelah beberapa saat.
finishTime

string (Timestamp format)

Hanya output. Waktu selesai deployment - hanya disetel jika deployment selesai atau gagal.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

A2AAgentDefinition

Definisi tersimpan dari agen yang menggunakan A2A.

Representasi JSON 
{

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string,
  "remoteAgentCard": {
    object (RemoteAgentcard)
  }
  // End of list of possible types for union field agent_card.
}
Kolom
Kolom union agent_card. Nama agen toko, kemampuan, info autentikasi, dll. agent_card hanya dapat berupa salah satu dari berikut ini:
jsonAgentCard

string

Opsional. Kartu agen adalah string JSON.
remoteAgentCard

object (RemoteAgentcard)

Opsional. Kartu agen jarak jauh.

RemoteAgentcard

Definisi kartu agen yang dihosting dari jarak jauh.

Representasi JSON 
{
  "uri": string
}
Kolom
uri

string

Wajib. URI kartu agen.

DialogflowAgentDefinition

Definisi tersimpan dari agen yang menggunakan agen Dialogflow.

Representasi JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Kolom
toolSettings

object (AgentToolSettings)

Opsional. Parameter yang menentukan cara agen ditampilkan ke LLM perencana.
dialogflowAgent

string

Wajib. Nama resource Agen Dialogflow pokok. Format: projects/{project}/locations/{location}/agents/{agent}

Gambar

Mewakili gambar.

Representasi JSON 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Kolom
Kolom union storage_method. Dapat berupa URI atau konten yang dienkode sebagai string base64. storage_method hanya ada berupa salah satu diantara berikut:
uri

string

URI gambar.
content

string

Isi file gambar berenkode base64.

AuthorizationConfig

Menjelaskan otorisasi yang diperlukan.

Representasi JSON 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Kolom
toolAuthorizations[]

string

Opsional. Daftar otorisasi yang diperlukan agar agen dapat mengakses resource lain. Token autentikasi akan diteruskan ke agen sebagai bagian dari isi permintaan.
agentAuthorization

string

Opsional. Otorisasi yang diperlukan untuk memanggil agen. Token autentikasi akan diteruskan ke agen sebagai bagian dari header autentikasi permintaan.

DataStoreSpecs

Mewakili serangkaian spesifikasi penyimpanan data.

Representasi JSON 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Kolom
specs[]

object (DataStoreSpec)

Opsional. Spesifikasi yang menentukan DataStore untuk memfilter panggilan penelusuran dan konfigurasi untuk penyimpanan data tersebut. Hal ini hanya dipertimbangkan untuk Engine dengan beberapa penyimpanan data.

Negara bagian/Provinsi

Kemungkinan nilai untuk status siklus proses agen.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
CONFIGURED Agen dikonfigurasi, tetapi belum ada deployment yang dipicu.
DEPLOYING Agen sedang di-deploy.
DISABLED Agen hanya tersedia untuk admin.
DEPLOYMENT_FAILED Deployment agen gagal.
PRIVATE Agen hanya tersedia untuk pembuatnya.
ENABLED Agen tersedia untuk pengguna yang memiliki akses.
SUSPENDED Agen tidak tersedia untuk sementara, meskipun dapat dilihat oleh pengguna yang memiliki akses.

StarterPrompt

Saran perintah awal untuk ditampilkan kepada pengguna di halaman landing agen.

Representasi JSON 
{
  "text": string
}
Kolom
text

string

Wajib. Teks perintah awal.

Metode

create

 Membuat Agent.

delete

 Menghapus Agent.

deploy

 Men-deploy Agent.

get

 Mendapatkan Agent.

getAgentView

 Menampilkan AgentView untuk Agent tertentu, yang berisi informasi tambahan tentang Agen.

list

 Mencantumkan semua Agent di Assistant yang dibuat oleh pemanggil.

patch

 Memperbarui Agent