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

Mencantumkan CannedQueryUserView untuk semua CannedQuery yang aktif.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

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

Parameter kueri

Parameter
languageCode

string

Opsional. Kode bahasa yang digunakan untuk menampilkan kueri standar. Jika tidak ditentukan di sini atau terjemahan yang sesuai tidak ditemukan, teks default akan ditampilkan.
pageSize

integer

Jumlah maksimum CannedQueryUserView 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 ListActiveCannedQueryUserViewsResponse.next_page_token, yang diterima dari panggilan CannedQueryService.ListActiveCannedQueryUserViews sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode CannedQueryService.ListActiveCannedQueryUserViews.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "cannedQueryUserViews": [
    {
      object (CannedQueryUserView)
    }
  ],
  "nextPageToken": string
}
Kolom
cannedQueryUserViews[]

object (CannedQueryUserView)

CannedQueryUserView yang merepresentasikan kueri standar aktif (yang ada, diaktifkan, dan memenuhi kemampuan).
nextPageToken

string

Token yang dapat dikirim sebagai ListActiveCannedQueryUserViewsRequest.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.

CannedQueryUserView

Informasi terbatas tentang CannedQuery yang memadai untuk pengguna akhir.

Representasi JSON 
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  }
}
Kolom
cannedQuery

string

Nama resource CannedQuery yang digunakan tampilan ini. Parameter ini mengidentifikasi kueri standar dalam permintaan bantuan.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}
localizedTexts

object (CannedQueryTexts)

Teks yang dilokalkan untuk kueri tersimpan.