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

Enumera todas las sesiones por su DataStore principal.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso del almacén de datos. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Parámetros de consulta

Parámetros
pageSize

integer

Cantidad máxima de resultados que se mostrarán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1,000.
pageToken

string

Un token de página, recibido desde una llamada sessions.list anterior. Proporciona esto para recuperar la página siguiente.
filter

string

Lista de campos separados por comas según los cuales se filtrará, en la gramática de EBNF.

Los campos admitidos son los siguientes:

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

Ejemplos:

  • 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

Es una lista de campos separados por comas según los cuales se ordenará el resultado, en orden ascendente. Usa "desc" después del nombre de un campo para el orden descendente.

Campos admitidos:

  • update_time
  • create_time
  • session_name
  • is_pinned

Ejemplo:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: Enumera las sesiones primero por is_pinned y, luego, por update_time.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListSessionsResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.sessions.list

Para obtener más información, consulta la documentación de IAM.