REST Resource: projects.locations.collections.engines.assistants.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.

Metode

create

 Membuat Agent.

delete

 Menghapus Agent.

deploy

 Men-deploy Agent.

disableAgent

 Menonaktifkan Agen.

enableAgent

 Mengaktifkan Agen.

get

 Mendapatkan Agent.

getAgentView

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

getIamPolicy

 Mendapatkan kebijakan kontrol akses untuk resource agen.

list

 Mencantumkan semua Agent di Assistant yang dibuat oleh pemanggil.

patch

 Memperbarui Agent

rejectAgent

 Menolak Agen yang ditawarkan kepada publik.

requestAgentReview

 Menampilkan Agen kepada admin dengan menyediakannya untuk ditinjau.

setIamPolicy

 Menetapkan kebijakan kontrol akses untuk resource agen.

suspendAgent

 Menangguhkan Agen.

withdrawAgent

 Membatalkan penawaran Agen kepada publik.