Request message for WidgetService.WidgetListSessions
method.
JSON representation |
---|
{ "location" : string , "configId" : string , "listSessionsRequest" : { object ( |
Fields | |
---|---|
location
|
Required. The location resource where widget list sessions will be performed. Format: |
configId
|
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
listSessionsRequest
|
Required. The proxied request to ConversationalSearchService.ListSessions. |
additionalParams
|
Required. Additional params for security and privacy enhancement. |
ListSessionsRequest
Request for ListSessions method.
JSON representation |
---|
{ "parent" : string , "pageSize" : integer , "pageToken" : string , "filter" : string , "orderBy" : string } |
parent
string
Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}
pageSize
integer
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken
string
A page token, received from a previous ListSessions
call. Provide this to retrieve the subsequent page.
filter
string
A comma-separated list of fields to filter by, in EBNF grammar.
The supported fields are:
-
user_pseudo_id
-
state
-
display_name
-
starred
-
is_pinned
-
labels
-
create_time
-
update_time
Examples:
-
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
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Supported fields:
-
update_time
-
create_time
-
session_name
-
is_pinned
Example:
-
update_time desc
-
create_time
-
is_pinned desc,update_time desc
: list sessions by is_pinned first, then by update_time.