WidgetListSessionsRequest

WidgetService.WidgetListSessions 方法的请求消息。

JSON 表示法
{
  "location": string,
  "configId": string,
  "listSessionsRequest": {
    object (ListSessionsRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
字段
location

string

必需。将执行 widget 列表会话的位置资源。格式:locations/{location}

configId

string

必需。WidgetConfig 的 UUID。此字段用于标识 widget 配置。

listSessionsRequest

object (ListSessionsRequest)

必需。向 ConversationalSearchService.ListSessions 发送的代理请求。

additionalParams

object (AdditionalParams)

必需。用于增强安全性和隐私性的其他参数。

ListSessionsRequest

针对 ListSessions 方法的请求。

JSON 表示法
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
字段
parent

string

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

pageSize

integer

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

pageToken

string

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

filter

string

要过滤的字段的逗号分隔列表,采用 EBNF 语法。

支持的字段包括:

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

示例:

  • 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

以英文逗号分隔的排序依据字段列表,按升序排序。在字段名称后使用“desc”表示降序。

支持的字段:

  • update_time
  • create_time
  • session_name
  • is_pinned

示例:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc:先按 is_pinned 列出会议,然后按 update_time 列出会议。