1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.reasoningEngines.html">reasoningEngines</a> . <a href="aiplatform_v1beta1.reasoningEngines.sessions.html">sessions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="aiplatform_v1beta1.reasoningEngines.sessions.events.html">events()</a></code>
</p>
<p class="firstline">Returns the events Resource.</p>
<p class="toc_element">
<code><a href="#appendEvent">appendEvent(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Appends an event to a given session.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Session.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes details of the specific Session.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of the specific Session.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Sessions in a given reasoning engine.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specific Session.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="appendEvent">appendEvent(name, body=None, x__xgafv=None)</code>
<pre>Appends an event to a given session.
Args:
name: string, Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
body: object, The request body.
The object takes the form of:
{ # An event represents a message from either the user or agent.
"actions": { # Actions are parts of events that are executed by the agent. # Optional. Actions executed by the agent.
"artifactDelta": { # Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.
"a_key": 42,
},
"escalate": True or False, # Optional. The agent is escalating to a higher level agent.
"requestedAuthConfigs": { # Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.
"a_key": "", # Properties of the object.
},
"skipSummarization": True or False, # Optional. If true, it won't call model to summarize function response. Only used for function_response event.
"stateDelta": { # Optional. Indicates that the event is updating the state with the given delta.
"a_key": "", # Properties of the object.
},
"transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
"transferToAgent": True or False, # Deprecated. If set, the event transfers to the specified agent.
},
"author": "A String", # Required. The name of the agent that sent the event, or user.
"content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Content of the event provided by the author.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
"outcome": "A String", # Required. Outcome of the code execution.
"output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
},
"executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
"code": "A String", # Required. The code to be executed.
"language": "A String", # Required. Programming language of the `code`.
},
"fileData": { # URI based data. # Optional. URI based data.
"displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"thought": True or False, # Optional. Indicates if the part is thought from the model.
"thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
"errorMessage": "A String", # Optional. Error message if the response is an error.
"eventMetadata": { # Metadata relating to a LLM response event. # Optional. Metadata relating to this event.
"branch": "A String", # Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.
"customMetadata": { # The custom metadata of the LlmResponse.
"a_key": "", # Properties of the object.
},
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Optional. Metadata returned to client when grounding is enabled.
"googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
"groundingChunks": [ # List of supporting references retrieved from specified grounding source.
{ # Grounding chunk.
"maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
"placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
"flagContentUri": "A String", # A link where users can flag a problem with the generated answer.
"reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
{ # Encapsulates a review snippet.
"authorAttribution": { # Author attribution for a photo or review. # This review's author.
"displayName": "A String", # Name of the author of the Photo or Review.
"photoUri": "A String", # Profile photo URI of the author of the Photo or Review.
"uri": "A String", # URI of the author of the Photo or Review.
},
"flagContentUri": "A String", # A link where users can flag a problem with the review.
"googleMapsUri": "A String", # A link to show the review on Google Maps.
"relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.
"review": "A String", # A reference representing this place review which may be used to look up this place review again.
},
],
},
"placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
"text": "A String", # Text of the chunk.
"title": "A String", # Title of the chunk.
"uri": "A String", # URI reference of the chunk.
},
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
"documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
"lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
},
"text": "A String", # The content of the chunk.
},
"text": "A String", # Text of the attribution.
"title": "A String", # Title of the attribution.
"uri": "A String", # URI reference of the attribution.
},
"web": { # Chunk from the web. # Grounding chunk from the web.
"domain": "A String", # Domain of the (original) URI.
"title": "A String", # Title of the chunk.
"uri": "A String", # URI reference of the chunk.
},
},
],
"groundingSupports": [ # Optional. List of grounding support.
{ # Grounding support.
"confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
3.14,
],
"groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
42,
],
"segment": { # Segment of the content. # Segment of the content this support belongs to.
"endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
"partIndex": 42, # Output only. The index of a Part object within its parent Content object.
"startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
"text": "A String", # Output only. The text corresponding to the segment from the response.
},
},
],
"retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
"googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
},
"retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
"A String",
],
"searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
"sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
},
"webSearchQueries": [ # Optional. Web search queries for the following-up web search.
"A String",
],
},
"interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.
"longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.
"A String",
],
"partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.
"turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode.
},
"invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id.
"name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.
"timestamp": "A String", # Required. Timestamp when the event was created on client side.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SessionService.AppendEvent.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new Session.
Args:
parent: string, Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
body: object, The request body.
The object takes the form of:
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
"expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
"ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes details of the specific Session.
Args:
name: string, Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of the specific Session.
Args:
name: string, Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
"expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
"ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Sessions in a given reasoning engine.
Args:
parent: string, Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
filter: string, Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=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: * `create_time` * `update_time` Example: `create_time desc`.
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 next_page_token value returned from a previous list SessionService.ListSessions call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SessionService.ListSessions.
"nextPageToken": "A 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.
"sessions": [ # A list of sessions matching the request.
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
"expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
"ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specific Session.
Args:
name: string, Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'. (required)
body: object, The request body.
The object takes the form of:
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
"expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
"ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
"expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
"ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}</pre>
</div>
</body></html>
|
