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

Ressource : CannedQuery

Ressource de requête standardisée de Assistant. Il s'agit d'un raccourci vers un début de conversation prédéfini.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "enabled": boolean,
  "googleDefined": boolean
}
Champs
name

string

Immuable. Nom de ressource de la requête enregistrée. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.
displayName

string

Nom à afficher de la requête prédéfinie. Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 128 caractères.
defaultTexts

object (CannedQueryTexts)

Obligatoire. Valeurs par défaut (non localisées) des attributs de texte.
localizedTexts

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

Facultatif. Traductions des attributs de texte. Les clés doivent être des codes de langue BCP-47.
activationBehavior
(deprecated)

enum (ActivationBehavior)

Comportement lorsque cette requête prédéfinie est activée. Obsolète.
requiredCapabilities[]

object (AssistantCapability)

Facultatif. Capacités dont l'Assistant a besoin pour utiliser cette requête prédéfinie.
icon

string

Nom de l'icône de la bibliothèque Google Symbols pour la requête prédéfinie.
enabled

boolean

Indique si cette requête prédéfinie est activée.
googleDefined

boolean

Uniquement en sortie. Indique si la requête prédéfinie est en lecture seule et définie par Google.

CannedQueryTexts

Éléments de texte pour la requête prédéfinie, qui peuvent être localisés.

Représentation 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.
}
Champs
title

string

Obligatoire. Titre destiné à l'utilisateur final.
prefix

string

Facultatif. Préfixe par lequel suggestedPrompts doit commencer.
description
(deprecated)

string

Obligatoire. Description destinée à l'utilisateur final. Obsolète.
suggestedPrompts[]

object (SuggestedPrompt)

Obligatoire. Requêtes que la requête prédéfinie proposera à l'utilisateur.
Champ d'union start_message. Message que la requête enregistrée utilisera pour lancer la conversation. Obsolète. Utilisez plutôt suggested_prompts. start_message ne peut être qu'un des éléments suivants :
suggestedUserQuery
(deprecated)

string

Obsolète. Utilisez plutôt userQuery. Texte prédéfini pour le premier tour de l'utilisateur (par exemple, "génère une image de chat")
assistantMessage
(deprecated)

string

Texte prédéfini pour le premier tour de l'assistant. Il sera affiché à l'utilisateur, probablement pour lui demander une saisie (par exemple, "Quel type de contenu souhaitez-vous créer ? (par exemple, "e-mail, article, présentation"). Obsolète.
userQuery
(deprecated)

string

Texte prédéfini pour le premier tour de l'utilisateur. Obsolète. Utilisez plutôt suggestedPrompts.

SuggestedPrompt

Requête suggérée pour la requête prédéfinie.

Représentation JSON 
{
  "promptText": string
}
Champs
promptText

string

Obligatoire. Texte de la suggestion de requête.

ActivationBehavior

Comportement lorsque cette requête prédéfinie est activée. Obsolète.

Enums
ACTIVATION_BEHAVIOR_UNSPECIFIED Valeur par défaut, ne doit pas être utilisée. La valeur par défaut est NEW_SESSION.
NEW_SESSION Lorsque vous utilisez cette requête prédéfinie, une nouvelle session d'assistance est lancée.
NEW_RESEARCH_ASSISTANT_SESSION Lorsque vous utilisez cette requête prédéfinie, une nouvelle session de l'assistant de recherche démarre.

AssistantCapability

Capacité d'un assistant nécessaire pour utiliser cette requête prédéfinie.

Représentation JSON 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Champs
Champ d'union capability. Capacité d'un assistant, qu'il s'agisse d'une action ou d'un outil. capability ne peut être qu'un des éléments suivants :
actionName

string

Nom de l'action que l'Assistant doit avoir configurée pour utiliser cette requête prédéfinie.

Méthodes

create

 Crée un objet CannedQuery.

delete

 Supprime un CannedQuery.

get

 Récupère un CannedQuery.

list

 Répertorie tous les CannedQuery d'un Assistant.

listActiveCannedQueryUserViews

 Liste les CannedQueryUserView pour tous les CannedQuery actifs.

patch

 Met à jour un CannedQuery.