Lists Sessions
in a given reasoning engine.
Endpoint
gethttps://{service-endpoint}/v1beta1/{parent}/sessions
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
parent
string
Required. The resource name of the location to list sessions from. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}
Query parameters
pageSize
integer
Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
pageToken
string
Optional. The nextPageToken
value returned from a previous list SessionService.ListSessions
call.
filter
string
Optional. The standard list filter. Supported fields: * displayName
Example: displayName=abc
.
orderBy
string
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * createTime
* updateTime
Example: createTime desc
.
Request body
The request body must be empty.
Response body
Response message for SessionService.ListSessions
.
If successful, the response body contains data with the following structure:
A list of sessions matching the request.
nextPageToken
string
A token, which can be sent as ListSessionsRequest.page_token
to retrieve the next page. Absence of this field indicates there are no subsequent pages.
JSON representation |
---|
{
"sessions": [
{
object ( |