Method: projects.locations.dataStores.sessions.list

Répertorie toutes les sessions par DataStore parent.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/dataStores/*}/sessions

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource du data store. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de résultats sur une page. Si aucune valeur n'est spécifiée, la valeur par défaut est 50. La valeur maximale autorisée est 1 000.
pageToken

string

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

string

Liste de champs séparés par une virgule sur lesquels filtrer, dans la grammaire EBNF.

Les champs compatibles sont les suivants :

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time
  • collaborativeProject

Exemples :

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
  • collaborativeProject = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborativeProjects/cp1"
orderBy

string

Liste de champs séparés par une virgule sur lesquels trier, par ordre croissant. Utilisez "desc" après un nom de champ pour un ordre décroissant.

Champs compatibles :

  • update_time
  • create_time
  • session_name
  • is_pinned

Exemple :

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc : liste les sessions par is_pinned, puis par update_time.

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListSessionsResponse.

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.sessions.list

Pour en savoir plus, consultez la documentation IAM.