Method: projects.locations.collections.engines.sessions.list

Elenca tutte le sessioni in base al relativo DataStore principale.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa del datastore. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Parametri di query

Parametri
pageSize

integer

Il numero massimo di risultati da restituire. Se non specificato, il valore predefinito è 50. Il valore massimo consentito è 1000.
pageToken

string

Un token di pagina ricevuto da una precedente chiamata sessions.list. Forniscilo per recuperare la pagina successiva.
filter

string

Un elenco di campi separato da virgole in base ai quali filtrare, nella grammatica EBNF.

I campi supportati sono:

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

Esempi:

  • 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"
orderBy

string

Un elenco separato da virgole di campi in base ai quali ordinare, ordinati in ordine crescente. Utilizza "desc" dopo il nome di un campo per l'ordine decrescente.

Campi supportati:

  • update_time
  • create_time
  • session_name
  • is_pinned

Esempio:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: elenca le sessioni prima in base a is_pinned, poi in base a update_time.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ListSessionsResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.sessions.list

Per saperne di più, consulta la documentazione di IAM.