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)
    },
    ...
  },
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "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.
requiredCapabilities[]

object (AssistantCapability)

Facultatif. Capacités dont l'Assistant a besoin pour utiliser cette 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,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ]
}
Fields
title

string

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

string

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

object (SuggestedPrompt)

Obligatoire. Requêtes que la requête prédéfinie proposera à l'utilisateur.

SuggestedPrompt

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

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

string

Obligatoire. Texte de la suggestion de requête.

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.