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
|
<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.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.reasoningEngines.html">reasoningEngines</a> . <a href="aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.html">a2a</a> . <a href="aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.html">v1</a> . <a href="aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.html">tasks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html">pushNotificationConfigs()</a></code>
</p>
<p class="firstline">Returns the pushNotificationConfigs Resource.</p>
<p class="toc_element">
<code><a href="#a2aGetReasoningEngine">a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get request for reasoning engine instance via the A2A get protocol apis.</p>
<p class="toc_element">
<code><a href="#cancel">cancel(name, a2aEndpoint, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Send post request for reasoning engine instance via the A2A post protocol apis.</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="#subscribe">subscribe(name, a2aEndpoint, x__xgafv=None)</a></code></p>
<p class="firstline">Stream get request for reasoning engine instance via the A2A stream get protocol apis.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="a2aGetReasoningEngine">a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)</code>
<pre>Get request for reasoning engine instance via the A2A get protocol apis.
Args:
name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"a_key": "", # Properties of the object.
}</pre>
</div>
<div class="method">
<code class="details" id="cancel">cancel(name, a2aEndpoint, body=None, x__xgafv=None)</code>
<pre>Send post request for reasoning engine instance via the A2A post protocol apis.
Args:
name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
body: object, The request body.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"a_key": "", # Properties of the object.
}</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="subscribe">subscribe(name, a2aEndpoint, x__xgafv=None)</code>
<pre>Stream get request for reasoning engine instance via the A2A stream get protocol apis.
Args:
name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}</pre>
</div>
</body></html>
|
