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

Apresenta todas as sessões pelo respetivo elemento principal DataStore.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da loja 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 devolver. Se não for especificado, a predefinição é 50. O valor máximo permitido é 1000.
pageToken

string

Um token de página, recebido de uma chamada sessions.list anterior. Faculte este valor para obter a página seguinte.
filter

string

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

Os campos suportados 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 pelos quais ordenar, ordenada por ordem ascendente. Use "desc" após um nome de campo para ordem descendente.

Campos suportados:

  • update_time
  • create_time
  • session_name
  • is_pinned

Exemplo:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: liste as sessões por is_pinned primeiro e, em seguida, por update_time.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de ListSessionsResponse.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.sessions.list

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