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)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "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.
activationBehavior
(deprecated)

enum (ActivationBehavior)

Perilaku saat kueri standar ini diaktifkan. Tidak digunakan lagi.
requiredCapabilities[]

object (AssistantCapability)

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

string

Nama ikon dari pustaka Simbol Google untuk kueri standar.
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,
  "description": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ],

  // Union field start_message can be only one of the following:
  "suggestedUserQuery": string,
  "assistantMessage": string,
  "userQuery": string
  // End of list of possible types for union field start_message.
}
Kolom
title

string

Wajib. Judul yang ditujukan untuk pengguna akhir.
prefix

string

Opsional. Awalan yang harus diawali dengan suggestedPrompts.
description
(deprecated)

string

Wajib. Deskripsi yang ditujukan untuk pengguna akhir. Tidak digunakan lagi.
suggestedPrompts[]

object (SuggestedPrompt)

Wajib. Perintah yang akan ditawarkan kueri standar kepada pengguna.
Kolom union start_message. Pesan yang akan digunakan kueri standar sebagai awal percakapan. Tidak digunakan lagi. Gunakan suggested_prompts sebagai gantinya. start_message hanya ada berupa salah satu diantara berikut:
suggestedUserQuery
(deprecated)

string

Tidak digunakan lagi. Sebagai gantinya, gunakan userQuery. Teks standar untuk giliran pertama pengguna yang disarankan (misalnya, "buat gambar kucing")
assistantMessage
(deprecated)

string

Teks standar untuk giliran pertama asisten. Ini akan ditampilkan kepada pengguna, kemungkinan meminta input (misalnya, "Jenis konten apa yang ingin Anda buat? (misalnya, email, artikel, presentasi)"). Tidak digunakan lagi.
userQuery
(deprecated)

string

Teks standar untuk giliran pertama pengguna. Tidak digunakan lagi. Sebagai gantinya, gunakan suggestedPrompts.

SuggestedPrompt

Perintah yang disarankan untuk kueri tersimpan.

Representasi JSON 
{
  "promptText": string
}
Kolom
promptText

string

Wajib. Teks perintah yang disarankan.

ActivationBehavior

Perilaku saat kueri standar ini diaktifkan. Tidak digunakan lagi.

Enum
ACTIVATION_BEHAVIOR_UNSPECIFIED Nilai default, tidak boleh digunakan. Default-nya adalah NEW_SESSION.
NEW_SESSION Saat menggunakan kueri standar ini, sesi asisten baru akan dimulai.
NEW_RESEARCH_ASSISTANT_SESSION Saat menggunakan kueri standar ini, sesi asisten riset baru akan dimulai.

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.