Method: projects.locations.dataStores.sessions.list

Lista todas as sessões pelo DataStore principal.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do repositório de dados. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de resultados a serem retornados. Se não for especificado, o padrão será 50. O valor máximo permitido é 1000.
pageToken

string

Um token de página recebido de uma chamada sessions.list anterior. Forneça isso para recuperar a página subsequente.
filter

string

Uma lista separada por vírgulas de campos para filtrar, na gramática EBNF.

Os campos aceitos são:

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

Exemplos:

  • 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

Uma lista separada por vírgulas de campos para ordenar, classificados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Campos compatíveis:

  • update_time
  • create_time
  • session_name
  • is_pinned

Exemplo:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: lista as sessões primeiro por is_pinned e depois por update_time.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListSessionsResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.sessions.list

Para mais informações, consulte a documentação do IAM.