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
|
<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="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.html">engines</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html">assistants</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html">cannedQueries</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, cannedQueryId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a CannedQuery.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a CannedQuery.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a CannedQuery.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all CannedQuerys under an Assistant.</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 a CannedQuery.</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, cannedQueryId=None, x__xgafv=None)</code>
<pre>Creates a CannedQuery.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
body: object, The request body.
The object takes the form of:
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
}
cannedQueryId: string, Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a CannedQuery.
Args:
name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. (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="get">get(name, x__xgafv=None)</code>
<pre>Gets a CannedQuery.
Args:
name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all CannedQuerys under an Assistant.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
filter: string, Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`
pageSize: integer, Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken: string, A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.
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 the CannedQueryService.ListCannedQueries method.
"cannedQueries": [ # The list of CannedQuerys matching the request.
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
},
],
"nextPageToken": "A String", # A token that can be sent as ListCannedQueriesRequest.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 '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 a CannedQuery.
Args:
name: string, Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
body: object, The request body.
The object takes the form of:
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
}
updateMask: string, The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
"defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
"displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
"enabled": True or False, # Whether this canned query is enabled.
"googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
"localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
"a_key": { # The text pieces for the canned query, which can be localized.
"prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
"suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
{ # A suggested prompt for the canned query.
"promptText": "A String", # Required. The text of the suggested prompt.
},
],
"title": "A String", # Required. The title that is for the end user.
},
},
"name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
{ # Capability of an assistant needed to use this canned query.
"actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
},
],
}</pre>
</div>
</body></html>
|
