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

enum (ActivationBehavior)

Il comportamento quando questa query predefinita viene attivata. Deprecato.
requiredCapabilities[]

object (AssistantCapability)

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

string

Il nome dell'icona della libreria delle icone di Google per la 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,
  "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.
}
Campi
title

string

Obbligatorio. Il titolo destinato all'utente finale.
prefix

string

Facoltativo. Il prefisso con cui deve iniziare suggestedPrompts.
description
(deprecated)

string

Obbligatorio. La descrizione per l'utente finale. Deprecato.
suggestedPrompts[]

object (SuggestedPrompt)

Obbligatorio. I prompt che la query predefinita offrirà all'utente.
Campo unione start_message. Il messaggio che la query predefinita utilizzerà come inizio della conversazione. Deprecato. Utilizza invece suggested_prompts. start_message può essere solo uno dei seguenti:
suggestedUserQuery
(deprecated)

string

Deprecato. Utilizza invece userQuery. Il testo predefinito per il primo turno suggerito dell'utente (ad es. genera un'immagine di un gatto
assistantMessage
(deprecated)

string

Il testo predefinito per il primo turno dell'assistente. Verrà visualizzato dall'utente, probabilmente chiedendo un input (ad es. "Che tipo di contenuti vorresti creare? ad esempio, email, articolo, presentazione". Deprecato.
userQuery
(deprecated)

string

Il testo predefinito per il primo turno dell'utente. Deprecato. Utilizza invece suggestedPrompts.

SuggestedPrompt

Un prompt suggerito per la query predefinita.

Rappresentazione JSON 
{
  "promptText": string
}
Campi
promptText

string

Obbligatorio. Il testo del prompt suggerito.

ActivationBehavior

Il comportamento quando questa query predefinita viene attivata. Deprecato.

Enum
ACTIVATION_BEHAVIOR_UNSPECIFIED Valore predefinito, non deve essere utilizzato. Il valore predefinito è NEW_SESSION.
NEW_SESSION Quando utilizzi questa query predefinita, viene avviata una nuova sessione dell'assistente.
NEW_RESEARCH_ASSISTANT_SESSION Quando utilizzi questa query predefinita, viene avviata una nuova sessione dell'assistente di ricerca.

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:
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.