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

Mencantumkan semua Assistant dalam Engine.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

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

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum Assistant 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

Token halaman ListAssistantsResponse.next_page_token, yang diterima dari panggilan AssistantService.ListAssistants sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode AssistantService.ListAssistants.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "assistants": [
    {
      object (Assistant)
    }
  ],
  "nextPageToken": string
}
Kolom
assistants[]

object (Assistant)

Semua Assistant pelanggan.

nextPageToken

string

Token yang dapat dikirim sebagai ListAssistantsRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

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.assistants.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.