REST Resource: projects.locations.collections.engines.assistants.cannedQueries

Resource: CannedQuery

Resource kueri tersimpan dari Assistant. Bagian ini merepresentasikan pintasan untuk memulai percakapan yang telah ditentukan sebelumnya.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "enabled": boolean,
  "googleDefined": boolean
}
Kolom
name

string

Tidak dapat diubah. Nama resource kueri standar. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
displayName

string

Nama tampilan kueri standar. Harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter.
defaultTexts

object (CannedQueryTexts)

Wajib. Nilai default (tidak dilokalkan) untuk atribut teks.
localizedTexts

map (key: string, value: object (CannedQueryTexts))

Opsional. Terjemahan atribut teks. Kuncinya harus berupa kode bahasa BCP-47.
requiredCapabilities[]

object (AssistantCapability)

Opsional. Kemampuan yang harus dimiliki Asisten untuk menggunakan kueri standar ini.
enabled

boolean

Apakah kueri tersimpan ini diaktifkan.
googleDefined

boolean

Hanya output. Apakah ini kueri standar hanya baca yang ditentukan Google.

CannedQueryTexts

Bagian teks untuk kueri standar, yang dapat dilokalkan.

Representasi JSON 
{
  "title": string,
  "prefix": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ]
}
Kolom
title

string

Wajib. Judul yang ditujukan untuk pengguna akhir.
prefix

string

Opsional. Awalan yang harus diawali dengan suggestedPrompts.
suggestedPrompts[]

object (SuggestedPrompt)

Wajib. Perintah yang akan ditawarkan kueri standar kepada pengguna.

SuggestedPrompt

Perintah yang disarankan untuk kueri standar.

Representasi JSON 
{
  "promptText": string
}
Kolom
promptText

string

Wajib. Teks perintah yang disarankan.

AssistantCapability

Kemampuan asisten yang diperlukan untuk menggunakan kueri standar ini.

Representasi JSON 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Kolom
Kolom union capability. Kemampuan asisten, baik tindakan maupun alat. capability hanya ada berupa salah satu diantara berikut:
actionName

string

Nama tindakan yang perlu disiapkan Asisten untuk menggunakan kueri standar ini.

Metode

create

 Membuat CannedQuery.

delete

 Menghapus CannedQuery.

get

 Mendapatkan CannedQuery.

list

 Mencantumkan semua CannedQuery dalam Assistant.

listActiveCannedQueryUserViews

 Mencantumkan CannedQueryUserView untuk semua CannedQuery yang aktif.

patch

 Memperbarui CannedQuery.