WidgetListSessionsRequest

WidgetService.WidgetListSessions 方法的要求訊息。

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

string

這是必要旗標，要執行小工具清單工作階段的位置資源。格式：locations/{location}
configId

string

這是必要旗標，WidgetConfig 的 UUID。這個欄位用於識別小工具設定。
listSessionsRequest

object (ListSessionsRequest)

這是必要旗標，傳送至 ConversationalSearchService.ListSessions 的 Proxy 要求。
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 列出工作階段。