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

Mencantumkan semua CannedQuery dalam Assistant.

Permintaan HTTP

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

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
filter

string

Opsional. Ekspresi filter.

Kolom yang didukung:

  • enabled
  • googleDefined

Contoh:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

Jumlah maksimum kueri standar 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 yang diterima dari panggilan CannedQueryService.ListCannedQueries sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode CannedQueryService.ListCannedQueries.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
Kolom
cannedQueries[]

object (CannedQuery)

Daftar CannedQuery yang cocok dengan permintaan.
nextPageToken

string

Token yang dapat dikirim sebagai ListCannedQueriesRequest.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.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.cannedQueries.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.