forked from googleapis/google-api-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathagentregistry_v1alpha.projects.locations.agents.html
More file actions
341 lines (305 loc) · 19.5 KB
/
agentregistry_v1alpha.projects.locations.agents.html
File metadata and controls
341 lines (305 loc) · 19.5 KB
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
<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="agentregistry_v1alpha.html">Agent Registry API</a> . <a href="agentregistry_v1alpha.projects.html">projects</a> . <a href="agentregistry_v1alpha.projects.locations.html">locations</a> . <a href="agentregistry_v1alpha.projects.locations.agents.html">agents</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Agent.</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 Agents in a given project and location.</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="#search">search(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches Agents in a given project and location.</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Agent.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
"agentId": "A String", # Output only. A stable, globally unique identifier for agents.
"attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
"a_key": {
"a_key": "", # Properties of the object.
},
},
"card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
"content": { # Output only. The content of the agent card.
"a_key": "", # Properties of the object.
},
"type": "A String", # Output only. The type of agent card.
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
"displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
"location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
"name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
"protocols": [ # Output only. The connection details for the Agent.
{ # Represents the protocol of an Agent.
"interfaces": [ # Output only. The connection details for the Agent.
{ # Represents the connection details for an Agent or MCP Server.
"protocolBinding": "A String", # Required. The protocol binding of the interface.
"url": "A String", # Required. The destination URL.
},
],
"protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
"type": "A String", # Output only. The type of the protocol.
},
],
"skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
{ # Represents the skills of an Agent.
"description": "A String", # Output only. A more detailed description of the skill.
"examples": [ # Output only. Example prompts or scenarios this skill can handle.
"A String",
],
"id": "A String", # Output only. A unique identifier for the agent's skill.
"name": "A String", # Output only. A human-readable name for the agent's skill.
"tags": [ # Output only. Keywords describing the skill.
"A String",
],
},
],
"uid": "A String", # Output only. A universally unique identifier for the Agent.
"updateTime": "A String", # Output only. Update time.
"version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
}</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 Agents in a given project and location.
Args:
parent: string, Required. Parent value for ListAgentsRequest (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Agents
"agents": [ # The list of Agents.
{ # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
"agentId": "A String", # Output only. A stable, globally unique identifier for agents.
"attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
"a_key": {
"a_key": "", # Properties of the object.
},
},
"card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
"content": { # Output only. The content of the agent card.
"a_key": "", # Properties of the object.
},
"type": "A String", # Output only. The type of agent card.
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
"displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
"location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
"name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
"protocols": [ # Output only. The connection details for the Agent.
{ # Represents the protocol of an Agent.
"interfaces": [ # Output only. The connection details for the Agent.
{ # Represents the connection details for an Agent or MCP Server.
"protocolBinding": "A String", # Required. The protocol binding of the interface.
"url": "A String", # Required. The destination URL.
},
],
"protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
"type": "A String", # Output only. The type of the protocol.
},
],
"skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
{ # Represents the skills of an Agent.
"description": "A String", # Output only. A more detailed description of the skill.
"examples": [ # Output only. Example prompts or scenarios this skill can handle.
"A String",
],
"id": "A String", # Output only. A unique identifier for the agent's skill.
"name": "A String", # Output only. A human-readable name for the agent's skill.
"tags": [ # Output only. Keywords describing the skill.
"A String",
],
},
],
"uid": "A String", # Output only. A universally unique identifier for the Agent.
"updateTime": "A String", # Output only. Update time.
"version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}</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="search">search(parent, body=None, x__xgafv=None)</code>
<pre>Searches Agents in a given project and location.
Args:
parent: string, Required. Parent value for SearchAgentsRequest. Format: `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # Message for searching Agents
"pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
"pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
"searchString": "A String", # Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId=urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to searching Agents
"agents": [ # A list of Agents that match the `search_string`.
{ # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
"agentId": "A String", # Output only. A stable, globally unique identifier for agents.
"attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
"a_key": {
"a_key": "", # Properties of the object.
},
},
"card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
"content": { # Output only. The content of the agent card.
"a_key": "", # Properties of the object.
},
"type": "A String", # Output only. The type of agent card.
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
"displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
"location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
"name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
"protocols": [ # Output only. The connection details for the Agent.
{ # Represents the protocol of an Agent.
"interfaces": [ # Output only. The connection details for the Agent.
{ # Represents the connection details for an Agent or MCP Server.
"protocolBinding": "A String", # Required. The protocol binding of the interface.
"url": "A String", # Required. The destination URL.
},
],
"protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
"type": "A String", # Output only. The type of the protocol.
},
],
"skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
{ # Represents the skills of an Agent.
"description": "A String", # Output only. A more detailed description of the skill.
"examples": [ # Output only. Example prompts or scenarios this skill can handle.
"A String",
],
"id": "A String", # Output only. A unique identifier for the agent's skill.
"name": "A String", # Output only. A human-readable name for the agent's skill.
"tags": [ # Output only. Keywords describing the skill.
"A String",
],
},
],
"uid": "A String", # Output only. A universally unique identifier for the Agent.
"updateTime": "A String", # Output only. Update time.
"version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
},
],
"nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_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>
</body></html>