Debian Codegraph @

docs/dyn/dialogflow_v2beta1.projects.locations.knowledgeBases.documents.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.locations.html">locations</a> . <a href="dialogflow_v2beta1.projects.locations.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2beta1.projects.locations.knowledgeBases.documents.html">documents</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, importGcsCustomMetadata=None, x__xgafv=None)</a></code></p>
82 <p class="firstline"></p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline"></p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline"></p>
89 <p class="toc_element">
90 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline"></p>
92 <p class="toc_element">
93 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94 <p class="firstline"></p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100 <p class="firstline"></p>
101 <p class="toc_element">
102 <code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline"></p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="create">create(parent, body=None, importGcsCustomMetadata=None, x__xgafv=None)</code>
112 <pre>
113
114 Args:
115 parent: string, A parameter (required)
116 body: object, The request body.
117 The object takes the form of:
118
119 {
120 &quot;content&quot;: &quot;A String&quot;,
121 &quot;contentUri&quot;: &quot;A String&quot;,
122 &quot;displayName&quot;: &quot;A String&quot;,
123 &quot;enableAutoReload&quot;: True or False,
124 &quot;knowledgeTypes&quot;: [
125 &quot;A String&quot;,
126 ],
127 &quot;latestReloadStatus&quot;: {
128 &quot;status&quot;: {
129 &quot;code&quot;: 42,
130 &quot;details&quot;: [
131 {
132 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133 },
134 ],
135 &quot;message&quot;: &quot;A String&quot;,
136 },
137 &quot;time&quot;: &quot;A String&quot;,
138 },
139 &quot;metadata&quot;: {
140 &quot;a_key&quot;: &quot;A String&quot;,
141 },
142 &quot;mimeType&quot;: &quot;A String&quot;,
143 &quot;name&quot;: &quot;A String&quot;,
144 &quot;rawContent&quot;: &quot;A String&quot;,
145 &quot;state&quot;: &quot;A String&quot;,
146 }
147
148 importGcsCustomMetadata: boolean, A parameter
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154 Returns:
155 An object of the form:
156
157 {
158 &quot;done&quot;: True or False,
159 &quot;error&quot;: {
160 &quot;code&quot;: 42,
161 &quot;details&quot;: [
162 {
163 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
164 },
165 ],
166 &quot;message&quot;: &quot;A String&quot;,
167 },
168 &quot;metadata&quot;: {
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
171 &quot;name&quot;: &quot;A String&quot;,
172 &quot;response&quot;: {
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 }</pre>
176 </div>
177
178 <div class="method">
179 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
180 <pre>
181
182 Args:
183 name: string, A parameter (required)
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 {
193 &quot;done&quot;: True or False,
194 &quot;error&quot;: {
195 &quot;code&quot;: 42,
196 &quot;details&quot;: [
197 {
198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199 },
200 ],
201 &quot;message&quot;: &quot;A String&quot;,
202 },
203 &quot;metadata&quot;: {
204 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
205 },
206 &quot;name&quot;: &quot;A String&quot;,
207 &quot;response&quot;: {
208 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
209 },
210 }</pre>
211 </div>
212
213 <div class="method">
214 <code class="details" id="get">get(name, x__xgafv=None)</code>
215 <pre>
216
217 Args:
218 name: string, A parameter (required)
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224 Returns:
225 An object of the form:
226
227 {
228 &quot;content&quot;: &quot;A String&quot;,
229 &quot;contentUri&quot;: &quot;A String&quot;,
230 &quot;displayName&quot;: &quot;A String&quot;,
231 &quot;enableAutoReload&quot;: True or False,
232 &quot;knowledgeTypes&quot;: [
233 &quot;A String&quot;,
234 ],
235 &quot;latestReloadStatus&quot;: {
236 &quot;status&quot;: {
237 &quot;code&quot;: 42,
238 &quot;details&quot;: [
239 {
240 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
241 },
242 ],
243 &quot;message&quot;: &quot;A String&quot;,
244 },
245 &quot;time&quot;: &quot;A String&quot;,
246 },
247 &quot;metadata&quot;: {
248 &quot;a_key&quot;: &quot;A String&quot;,
249 },
250 &quot;mimeType&quot;: &quot;A String&quot;,
251 &quot;name&quot;: &quot;A String&quot;,
252 &quot;rawContent&quot;: &quot;A String&quot;,
253 &quot;state&quot;: &quot;A String&quot;,
254 }</pre>
255 </div>
256
257 <div class="method">
258 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
259 <pre>
260
261 Args:
262 parent: string, A parameter (required)
263 body: object, The request body.
264 The object takes the form of:
265
266 {
267 &quot;documentTemplate&quot;: {
268 &quot;knowledgeTypes&quot;: [
269 &quot;A String&quot;,
270 ],
271 &quot;metadata&quot;: {
272 &quot;a_key&quot;: &quot;A String&quot;,
273 },
274 &quot;mimeType&quot;: &quot;A String&quot;,
275 },
276 &quot;gcsSource&quot;: {
277 &quot;uris&quot;: [
278 &quot;A String&quot;,
279 ],
280 },
281 &quot;importGcsCustomMetadata&quot;: True or False,
282 }
283
284 x__xgafv: string, V1 error format.
285 Allowed values
286 1 - v1 error format
287 2 - v2 error format
288
289 Returns:
290 An object of the form:
291
292 {
293 &quot;done&quot;: True or False,
294 &quot;error&quot;: {
295 &quot;code&quot;: 42,
296 &quot;details&quot;: [
297 {
298 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
299 },
300 ],
301 &quot;message&quot;: &quot;A String&quot;,
302 },
303 &quot;metadata&quot;: {
304 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
305 },
306 &quot;name&quot;: &quot;A String&quot;,
307 &quot;response&quot;: {
308 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
309 },
310 }</pre>
311 </div>
312
313 <div class="method">
314 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
315 <pre>
316
317 Args:
318 parent: string, A parameter (required)
319 filter: string, A parameter
320 pageSize: integer, A parameter
321 pageToken: string, A parameter
322 x__xgafv: string, V1 error format.
323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
326
327 Returns:
328 An object of the form:
329
330 {
331 &quot;documents&quot;: [
332 {
333 &quot;content&quot;: &quot;A String&quot;,
334 &quot;contentUri&quot;: &quot;A String&quot;,
335 &quot;displayName&quot;: &quot;A String&quot;,
336 &quot;enableAutoReload&quot;: True or False,
337 &quot;knowledgeTypes&quot;: [
338 &quot;A String&quot;,
339 ],
340 &quot;latestReloadStatus&quot;: {
341 &quot;status&quot;: {
342 &quot;code&quot;: 42,
343 &quot;details&quot;: [
344 {
345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
346 },
347 ],
348 &quot;message&quot;: &quot;A String&quot;,
349 },
350 &quot;time&quot;: &quot;A String&quot;,
351 },
352 &quot;metadata&quot;: {
353 &quot;a_key&quot;: &quot;A String&quot;,
354 },
355 &quot;mimeType&quot;: &quot;A String&quot;,
356 &quot;name&quot;: &quot;A String&quot;,
357 &quot;rawContent&quot;: &quot;A String&quot;,
358 &quot;state&quot;: &quot;A String&quot;,
359 },
360 ],
361 &quot;nextPageToken&quot;: &quot;A String&quot;,
362 }</pre>
363 </div>
364
365 <div class="method">
366 <code class="details" id="list_next">list_next()</code>
367 <pre>Retrieves the next page of results.
368
369 Args:
370 previous_request: The request for the previous page. (required)
371 previous_response: The response from the request for the previous page. (required)
372
373 Returns:
374 A request object that you can call &#x27;execute()&#x27; on to request the next
375 page. Returns None if there are no more items in the collection.
376 </pre>
377 </div>
378
379 <div class="method">
380 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
381 <pre>
382
383 Args:
384 name: string, A parameter (required)
385 body: object, The request body.
386 The object takes the form of:
387
388 {
389 &quot;content&quot;: &quot;A String&quot;,
390 &quot;contentUri&quot;: &quot;A String&quot;,
391 &quot;displayName&quot;: &quot;A String&quot;,
392 &quot;enableAutoReload&quot;: True or False,
393 &quot;knowledgeTypes&quot;: [
394 &quot;A String&quot;,
395 ],
396 &quot;latestReloadStatus&quot;: {
397 &quot;status&quot;: {
398 &quot;code&quot;: 42,
399 &quot;details&quot;: [
400 {
401 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
402 },
403 ],
404 &quot;message&quot;: &quot;A String&quot;,
405 },
406 &quot;time&quot;: &quot;A String&quot;,
407 },
408 &quot;metadata&quot;: {
409 &quot;a_key&quot;: &quot;A String&quot;,
410 },
411 &quot;mimeType&quot;: &quot;A String&quot;,
412 &quot;name&quot;: &quot;A String&quot;,
413 &quot;rawContent&quot;: &quot;A String&quot;,
414 &quot;state&quot;: &quot;A String&quot;,
415 }
416
417 updateMask: string, A parameter
418 x__xgafv: string, V1 error format.
419 Allowed values
420 1 - v1 error format
421 2 - v2 error format
422
423 Returns:
424 An object of the form:
425
426 {
427 &quot;done&quot;: True or False,
428 &quot;error&quot;: {
429 &quot;code&quot;: 42,
430 &quot;details&quot;: [
431 {
432 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
433 },
434 ],
435 &quot;message&quot;: &quot;A String&quot;,
436 },
437 &quot;metadata&quot;: {
438 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
439 },
440 &quot;name&quot;: &quot;A String&quot;,
441 &quot;response&quot;: {
442 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
443 },
444 }</pre>
445 </div>
446
447 <div class="method">
448 <code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
449 <pre>
450
451 Args:
452 name: string, A parameter (required)
453 body: object, The request body.
454 The object takes the form of:
455
456 {
457 &quot;gcsSource&quot;: {
458 &quot;uri&quot;: &quot;A String&quot;,
459 },
460 &quot;importGcsCustomMetadata&quot;: True or False,
461 }
462
463 x__xgafv: string, V1 error format.
464 Allowed values
465 1 - v1 error format
466 2 - v2 error format
467
468 Returns:
469 An object of the form:
470
471 {
472 &quot;done&quot;: True or False,
473 &quot;error&quot;: {
474 &quot;code&quot;: 42,
475 &quot;details&quot;: [
476 {
477 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
478 },
479 ],
480 &quot;message&quot;: &quot;A String&quot;,
481 },
482 &quot;metadata&quot;: {
483 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
484 },
485 &quot;name&quot;: &quot;A String&quot;,
486 &quot;response&quot;: {
487 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
488 },
489 }</pre>
490 </div>
491
492 </body></html>