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

Risorsa: CannedQuery

Risorsa di query predefinita di Assistant. Rappresenta una scorciatoia per l'inizio di una conversazione predefinita.

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

string

Immutabile. Nome della risorsa della query predefinita. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
displayName

string

Il nome visualizzato della query predefinita. Deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri.
defaultTexts

object (CannedQueryTexts)

Obbligatorio. I valori predefiniti (non localizzati) per gli attributi di testo.
localizedTexts

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

Facoltativo. Le traduzioni degli attributi di testo. Le chiavi devono essere codici lingua BCP-47.
requiredCapabilities[]

object (AssistantCapability)

Facoltativo. Le funzionalità che l'assistente deve avere per utilizzare questa query predefinita.
enabled

boolean

Indica se questa query predefinita è abilitata.
googleDefined

boolean

Solo output. Indica se si tratta di una query predefinita di sola lettura definita da Google.

CannedQueryTexts

I frammenti di testo per la query predefinita, che possono essere localizzati.

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

string

Obbligatorio. Il titolo destinato all'utente finale.
prefix

string

Facoltativo. Il prefisso con cui deve iniziare suggestedPrompts.
suggestedPrompts[]

object (SuggestedPrompt)

Obbligatorio. I prompt che la query predefinita offrirà all'utente.

SuggestedPrompt

Un prompt suggerito per la query predefinita.

Rappresentazione JSON 
{
  "promptText": string
}
Campi
promptText

string

Obbligatorio. Il testo del prompt suggerito.

AssistantCapability

Funzionalità di un assistente necessaria per utilizzare questa query predefinita.

Rappresentazione JSON 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Campi
Campo unione capability. Funzionalità di un assistente, ovvero un'azione o uno strumento. capability può essere solo uno dei seguenti valori:
actionName

string

Il nome dell'azione che l'assistente deve configurare per utilizzare questa query predefinita.

Metodi

create

 Crea un CannedQuery.

delete

 Elimina un CannedQuery.

get

 Riceve un CannedQuery.

list

 Elenca tutti i CannedQuery in un Assistant.

listActiveCannedQueryUserViews

 Elenca i CannedQueryUserView per tutti i CannedQuery attivi.

patch

 Aggiorna un CannedQuery.