File: integrations_v1.projects.locations.collections.engines.assistants.agentFlows.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (359 lines) | stat: -rw-r--r-- 16,470 bytes parent folder | download
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
<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="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.collections.html">collections</a> . <a href="integrations_v1.projects.locations.collections.engines.html">engines</a> . <a href="integrations_v1.projects.locations.collections.engines.assistants.html">assistants</a> . <a href="integrations_v1.projects.locations.collections.engines.assistants.agentFlows.html">agentFlows</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request to create a new AgentFlow with user-provided flow configuration.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing AgentFlow.</p>
<p class="toc_element">
  <code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uses Natural Language (NL) to generate an AgentFlow configuration and create a new AgentFlow.</p>
<p class="toc_element">
  <code><a href="#generateAndUpdate">generateAndUpdate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uses Natural Language (NL) to generate an AgentFlow configuration and update an existing AgentFlow.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an existing AgentFlow.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all AgentFlows.</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 an existing AgentFlow.</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="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Request to create a new AgentFlow with user-provided flow configuration.

Args:
  parent: string, Required. Parent resource name where this AgentFlow will be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # AgentFlow configurations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
  &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
  &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
  &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
  &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AgentFlow configurations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
  &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
  &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
  &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
  &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an existing AgentFlow.

Args:
  name: string, Required. The resource name of the AgentFlow to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
  <pre>Uses Natural Language (NL) to generate an AgentFlow configuration and create a new AgentFlow.

Args:
  parent: string, Required. Parent resource name where this AgentFlow will be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for GenerateAgentFlow.
  &quot;creator&quot;: &quot;A String&quot;, # Optional. The creator id;
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the AgentFlow to be generated.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the AgentFlow to be generated.
  &quot;intent&quot;: &quot;A String&quot;, # Required. The intent, described in natural language, for the AgentFlow to generate.
}

  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 GenerateAgentFlow.
  &quot;agentFlow&quot;: { # AgentFlow configurations. # Output only. AgentFlow that gets generated.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
    &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
    &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
    &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
    &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
    &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
    &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="generateAndUpdate">generateAndUpdate(name, body=None, x__xgafv=None)</code>
  <pre>Uses Natural Language (NL) to generate an AgentFlow configuration and update an existing AgentFlow.

Args:
  name: string, Required. The resource name of the AgentFlow to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for GenerateAndUpdateAgentFlow.
  &quot;intent&quot;: &quot;A String&quot;, # Required. The intent, described in natural language, for the AgentFlow to update.
  &quot;updater&quot;: &quot;A String&quot;, # Optional. The updater id;
}

  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 GenerateAndUpdateAgentFlow.
  &quot;agentFlow&quot;: { # AgentFlow configurations. # Output only. AgentFlow that gets updated.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
    &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
    &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
    &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
    &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
    &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
    &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets an existing AgentFlow.

Args:
  name: string, Required. The resource name of the AgentFlow to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AgentFlow configurations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
  &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
  &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
  &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
  &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
  <pre>Lists all AgentFlows.

Args:
  parent: string, Required. The parent resource where this AgentFlow was created. (required)
  filter: string, Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
  orderBy: string, Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for &quot;create_time&quot;, &quot;update_time&quot;. Ascending sort order for &quot;agent_flow_id&quot;, &quot;display_name&quot;.
  pageSize: integer, Optional. The maximum number of AgentFlows to return. The service may return fewer than this value. If unspecified, at most 100 AgentFlows will be returned.
  pageToken: string, Optional. A page token, received from a previous `ListAgentFlows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAgentFlows` must match the call that provided the page token.
  readMask: string, Optional. The mask which specifies fields that need to be returned in the AgentFlow&#x27;s response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListAgentFlows.
  &quot;agentFlows&quot;: [ # Output only. The AgentFlows from the specified collection.
    { # AgentFlow configurations.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
      &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
      &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
      &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
      &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
      &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</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 &#x27;execute()&#x27; 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 an existing AgentFlow.

Args:
  name: string, Required. Resource name of the agent flow. (required)
  body: object, The request body.
    The object takes the form of:

{ # AgentFlow configurations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
  &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
  &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
  &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
  &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
}

  updateMask: string, Optional. Field mask specifying the fields in the above AgentFlow that have been modified and need to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AgentFlow configurations.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was created.
  &quot;creator&quot;: &quot;A String&quot;, # Output only. The user who created the agent flow.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the agent flow.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the agent flow.
  &quot;flowConfig&quot;: &quot;A String&quot;, # Required. The flow configuration, represented as a string.
  &quot;name&quot;: &quot;A String&quot;, # Required. Resource name of the agent flow.
  &quot;noCodeAgent&quot;: &quot;A String&quot;, # Optional. Name of the NoCodeAgent.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the agent flow was last updated.
}</pre>
</div>

</body></html>