Method: projects.locations.collections.engines.agents.list

Mencantumkan semua Agent di Assistant yang dibuat oleh pemanggil.

Permintaan HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/agents

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource induk. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum Agent yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000; nilai di atas itu akan dikonversi menjadi 1.000.
pageToken

string

Opsional. Token halaman ListAgentsResponse.next_page_token, yang diterima dari panggilan AgentService.ListAgents sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk agents.list harus sesuai dengan panggilan yang memberikan token halaman.
orderBy

string

Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan, diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk urutan menurun. Kolom yang didukung:

  • updateTime
  • isPinned

Contoh:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": mencantumkan agen menurut isPinned terlebih dahulu, lalu menurut updateTime.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance ListAgentsResponse.

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 parent:

  • discoveryengine.agents.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.