Method: projects.locations.collections.engines.assistants.cannedQueries.list

Répertorie tous les CannedQuery d'un Assistant.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parente. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Paramètres de requête

Paramètres
filter

string

Facultatif. Expression du filtre.

Champs acceptés :

  • enabled
  • googleDefined

Exemples :

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

Nombre maximal de requêtes prédéfinies à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est de 1 000. Toute valeur supérieure sera ramenée à 1 000.
pageToken

string

Jeton de page reçu d'un appel CannedQueryService.ListCannedQueries précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à CannedQueryService.ListCannedQueries doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode CannedQueryService.ListCannedQueries.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
Champs
cannedQueries[]

object (CannedQuery)

Liste des CannedQuery correspondant à la requête.
nextPageToken

string

Jeton pouvant être envoyé en tant que ListCannedQueriesRequest.page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.cannedQueries.list

Pour en savoir plus, consultez la documentation IAM.