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

Ressource : CannedQuery

Ressource de requête standardisée de Assistant. Elle représente 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)
    },
    ...
  },
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "enabled": boolean,
  "googleDefined": boolean
}
Champs
name

string

Immuable. Nom de ressource de la requête standardisé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 d'une longueur maximale de 1 024 caractères.
displayName

string

Nom à afficher de la requête standardisée. Il doit s'agir d'une chaîne encodée au format UTF-8 d'une longueur maximale de 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.
requiredCapabilities[]

object (AssistantCapability)

Facultatif. Fonctionnalités dont l'Assistant a besoin pour utiliser cette requête standardisée.
enabled

boolean

Indique si cette requête standardisée est activée.
googleDefined

boolean

Uniquement en sortie. Indique s'il s'agit d'une requête standardisée en lecture seule définie par Google.

CannedQueryTexts

Éléments de texte de la requête standardisée, qui peuvent être localisés.

Représentation JSON 
{
  "title": string,
  "prefix": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ]
}
Champs
title

string

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

string

Facultatif. Préfixe par lequel suggestedPrompts doit commencer.
suggestedPrompts[]

object (SuggestedPrompt)

Obligatoire. Invites que la requête standardisée proposera à l'utilisateur.

SuggestedPrompt

Invite suggérée pour la requête standardisée.

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

string

Obligatoire. Texte de l'invite suggérée.

AssistantCapability

Fonctionnalité d'un assistant nécessaire pour utiliser cette requête standardisée.

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. Fonctionnalité 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 configurer pour utiliser cette requête standardisée.

Méthodes

create

 Crée un objet CannedQuery.

delete

 Supprime un objet CannedQuery.

get

 Récupère un objet CannedQuery.

list

 Répertorie tous les objets CannedQuery d'un Assistant.

listActiveCannedQueryUserViews

 Répertorie les CannedQueryUserView pour tous les CannedQuery actifs.

patch

 Met à jour un objet CannedQuery.