Method: projects.locations.dataStores.sessions.list

列出其父级 DataStore 下的所有会话。

HTTP 请求

：


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

网址使用 gRPC 转码语法。

路径参数

参数
parent

string

必需。数据存储区资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

查询参数

参数
pageSize

integer

页面中结果的数量上限。如果未指定，则默认为 50。允许的最大值为 1,000。
pageToken

string

从之前的 sessions.list 调用接收的页面令牌。利用其进行后续页面检索。
filter

string

要过滤依据的字段的英文逗号分隔列表，采用 EBNF 语法。

支持的字段包括：

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

示例：

  • 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

要排序依据的字段的英文逗号分隔列表，按升序排序。在字段名称后添加“desc”表示降序。

支持的字段：

  • update_time
  • create_time
  • session_name
  • is_pinned
  • display_name

示例：

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc：先按 is_pinned 列出会话，然后按 update_time 列出会话。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 ListSessionsResponse 实例。

授权范围

需要以下 OAuth 范围之一：

  • 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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.sessions.list

如需了解详情，请参阅 IAM 文档。