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
|
<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="workspaceevents_v1.html">Google Workspace Events API</a> . <a href="workspaceevents_v1.message.html">message</a></h1>
<h2>Instance Methods</h2>
<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="#stream">stream(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="stream">stream(body=None, x__xgafv=None)</code>
<pre>SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
Args:
body: object, The request body.
The object takes the form of:
{ # /////////// Request Messages ///////////
"configuration": { # Configuration of a send message request. # Configuration for the send request.
"acceptedOutputModes": [ # The output modes that the agent is expected to respond with.
"A String",
],
"blocking": True or False, # If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.
"historyLength": 42, # The maximum number of messages to include in the history. if 0, the history will be unlimited.
"pushNotification": { # Configuration for setting up push notifications for task updates. # A configuration of a webhook that can be used to receive updates
"authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
"credentials": "A String", # Optional credentials
"schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
"A String",
],
},
"id": "A String", # A unique identifier (e.g. UUID) for this push notification.
"token": "A String", # Token unique for this task/session
"url": "A String", # Url to send the notification too
},
},
"message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # Required. The message to send to the agent.
"content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
"contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
"extensions": [ # The URIs of extensions that are present or contributed to this Message.
"A String",
],
"messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
"a_key": "", # Properties of the object.
},
"role": "A String", # A role for the message.
"taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
},
"metadata": { # Optional metadata for the request.
"a_key": "", # Properties of the object.
},
"tenant": "A String", # Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are
"artifactUpdate": { # TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.
"append": True or False, # Whether this should be appended to a prior one produced
"artifact": { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication. # The artifact itself
"artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
"description": "A String", # A human readable description of the artifact, optional.
"extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
"A String",
],
"metadata": { # Optional metadata included with the artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # A human readable name for the artifact.
"parts": [ # The content of the artifact.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
},
"contextId": "A String", # The id of the context that this task belongs too
"lastChunk": True or False, # Whether this represents the last part of an artifact
"metadata": { # Optional metadata associated with the artifact update.
"a_key": "", # Properties of the object.
},
"taskId": "A String", # The id of the task for this artifact
},
"message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
"content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
"contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
"extensions": [ # The URIs of extensions that are present or contributed to this Message.
"A String",
],
"messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
"a_key": "", # Properties of the object.
},
"role": "A String", # A role for the message.
"taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
},
"statusUpdate": { # TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.
"contextId": "A String", # The id of the context that the task belongs to
"final": True or False, # Whether this is the last status update expected for this task.
"metadata": { # Optional metadata to associate with the task update.
"a_key": "", # Properties of the object.
},
"status": { # A container for the status of a task # The new status of the task.
"message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
"content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
"contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
"extensions": [ # The URIs of extensions that are present or contributed to this Message.
"A String",
],
"messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
"a_key": "", # Properties of the object.
},
"role": "A String", # A role for the message.
"taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
},
"state": "A String", # The current state of this task
"timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
},
"taskId": "A String", # The id of the task that is changed
},
"task": { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
"artifacts": [ # A set of output artifacts for a Task.
{ # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
"artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
"description": "A String", # A human readable description of the artifact, optional.
"extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
"A String",
],
"metadata": { # Optional metadata included with the artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # A human readable name for the artifact.
"parts": [ # The content of the artifact.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
},
],
"contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
"history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
{ # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
"content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
"contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
"extensions": [ # The URIs of extensions that are present or contributed to this Message.
"A String",
],
"messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
"a_key": "", # Properties of the object.
},
"role": "A String", # A role for the message.
"taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
},
],
"id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
"a_key": "", # Properties of the object.
},
"status": { # A container for the status of a task # The current status of a Task, including state and a message.
"message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
"content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
{ # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
"data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
"data": {
"a_key": "", # Properties of the object.
},
},
"file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
"fileWithBytes": "A String",
"fileWithUri": "A String",
"mimeType": "A String",
"name": "A String",
},
"metadata": { # Optional metadata associated with this part.
"a_key": "", # Properties of the object.
},
"text": "A String",
},
],
"contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
"extensions": [ # The URIs of extensions that are present or contributed to this Message.
"A String",
],
"messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
"metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
"a_key": "", # Properties of the object.
},
"role": "A String", # A role for the message.
"taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
},
"state": "A String", # The current state of this task
"timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
},
},
}</pre>
</div>
</body></html>
|
