Debian Codegraph @

docs/dyn/dialogflow_v2.projects.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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2.projects.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, 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="#export">export(name, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline"></p>
89 <p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91 <p class="firstline"></p>
92 <p class="toc_element">
93 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline"></p>
95 <p class="toc_element">
96 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
97 <p class="firstline"></p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
103 <p class="firstline"></p>
104 <p class="toc_element">
105 <code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline"></p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111 </div>
112
113 <div class="method">
114 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
115 <pre>
116
117 Args:
118 parent: string, A parameter (required)
119 body: object, The request body.
120 The object takes the form of:
121
122 {
123 &quot;contentUri&quot;: &quot;A String&quot;,
124 &quot;displayName&quot;: &quot;A String&quot;,
125 &quot;enableAutoReload&quot;: True or False,
126 &quot;knowledgeTypes&quot;: [
127 &quot;A String&quot;,
128 ],
129 &quot;latestReloadStatus&quot;: {
130 &quot;status&quot;: {
131 &quot;code&quot;: 42,
132 &quot;details&quot;: [
133 {
134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
135 },
136 ],
137 &quot;message&quot;: &quot;A String&quot;,
138 },
139 &quot;time&quot;: &quot;A String&quot;,
140 },
141 &quot;metadata&quot;: {
142 &quot;a_key&quot;: &quot;A String&quot;,
143 },
144 &quot;mimeType&quot;: &quot;A String&quot;,
145 &quot;name&quot;: &quot;A String&quot;,
146 &quot;rawContent&quot;: &quot;A String&quot;,
147 &quot;state&quot;: &quot;A String&quot;,
148 }
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155 Returns:
156 An object of the form:
157
158 {
159 &quot;done&quot;: True or False,
160 &quot;error&quot;: {
161 &quot;code&quot;: 42,
162 &quot;details&quot;: [
163 {
164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
166 ],
167 &quot;message&quot;: &quot;A String&quot;,
168 },
169 &quot;metadata&quot;: {
170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171 },
172 &quot;name&quot;: &quot;A String&quot;,
173 &quot;response&quot;: {
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 }</pre>
177 </div>
178
179 <div class="method">
180 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
181 <pre>
182
183 Args:
184 name: string, A parameter (required)
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 {
194 &quot;done&quot;: True or False,
195 &quot;error&quot;: {
196 &quot;code&quot;: 42,
197 &quot;details&quot;: [
198 {
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 ],
202 &quot;message&quot;: &quot;A String&quot;,
203 },
204 &quot;metadata&quot;: {
205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
206 },
207 &quot;name&quot;: &quot;A String&quot;,
208 &quot;response&quot;: {
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
211 }</pre>
212 </div>
213
214 <div class="method">
215 <code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
216 <pre>
217
218 Args:
219 name: string, A parameter (required)
220 body: object, The request body.
221 The object takes the form of:
222
223 {
224 &quot;exportFullContent&quot;: True or False,
225 &quot;gcsDestination&quot;: {
226 &quot;uri&quot;: &quot;A String&quot;,
227 },
228 &quot;smartMessagingPartialUpdate&quot;: True or False,
229 }
230
231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236 Returns:
237 An object of the form:
238
239 {
240 &quot;done&quot;: True or False,
241 &quot;error&quot;: {
242 &quot;code&quot;: 42,
243 &quot;details&quot;: [
244 {
245 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
246 },
247 ],
248 &quot;message&quot;: &quot;A String&quot;,
249 },
250 &quot;metadata&quot;: {
251 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
252 },
253 &quot;name&quot;: &quot;A String&quot;,
254 &quot;response&quot;: {
255 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
256 },
257 }</pre>
258 </div>
259
260 <div class="method">
261 <code class="details" id="get">get(name, x__xgafv=None)</code>
262 <pre>
263
264 Args:
265 name: string, A parameter (required)
266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271 Returns:
272 An object of the form:
273
274 {
275 &quot;contentUri&quot;: &quot;A String&quot;,
276 &quot;displayName&quot;: &quot;A String&quot;,
277 &quot;enableAutoReload&quot;: True or False,
278 &quot;knowledgeTypes&quot;: [
279 &quot;A String&quot;,
280 ],
281 &quot;latestReloadStatus&quot;: {
282 &quot;status&quot;: {
283 &quot;code&quot;: 42,
284 &quot;details&quot;: [
285 {
286 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
287 },
288 ],
289 &quot;message&quot;: &quot;A String&quot;,
290 },
291 &quot;time&quot;: &quot;A String&quot;,
292 },
293 &quot;metadata&quot;: {
294 &quot;a_key&quot;: &quot;A String&quot;,
295 },
296 &quot;mimeType&quot;: &quot;A String&quot;,
297 &quot;name&quot;: &quot;A String&quot;,
298 &quot;rawContent&quot;: &quot;A String&quot;,
299 &quot;state&quot;: &quot;A String&quot;,
300 }</pre>
301 </div>
302
303 <div class="method">
304 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
305 <pre>
306
307 Args:
308 parent: string, A parameter (required)
309 body: object, The request body.
310 The object takes the form of:
311
312 {
313 &quot;documentTemplate&quot;: {
314 &quot;knowledgeTypes&quot;: [
315 &quot;A String&quot;,
316 ],
317 &quot;metadata&quot;: {
318 &quot;a_key&quot;: &quot;A String&quot;,
319 },
320 &quot;mimeType&quot;: &quot;A String&quot;,
321 },
322 &quot;gcsSource&quot;: {
323 &quot;uris&quot;: [
324 &quot;A String&quot;,
325 ],
326 },
327 &quot;importGcsCustomMetadata&quot;: True or False,
328 }
329
330 x__xgafv: string, V1 error format.
331 Allowed values
332 1 - v1 error format
333 2 - v2 error format
334
335 Returns:
336 An object of the form:
337
338 {
339 &quot;done&quot;: True or False,
340 &quot;error&quot;: {
341 &quot;code&quot;: 42,
342 &quot;details&quot;: [
343 {
344 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
345 },
346 ],
347 &quot;message&quot;: &quot;A String&quot;,
348 },
349 &quot;metadata&quot;: {
350 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
351 },
352 &quot;name&quot;: &quot;A String&quot;,
353 &quot;response&quot;: {
354 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
355 },
356 }</pre>
357 </div>
358
359 <div class="method">
360 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
361 <pre>
362
363 Args:
364 parent: string, A parameter (required)
365 filter: string, A parameter
366 pageSize: integer, A parameter
367 pageToken: string, A parameter
368 x__xgafv: string, V1 error format.
369 Allowed values
370 1 - v1 error format
371 2 - v2 error format
372
373 Returns:
374 An object of the form:
375
376 {
377 &quot;documents&quot;: [
378 {
379 &quot;contentUri&quot;: &quot;A String&quot;,
380 &quot;displayName&quot;: &quot;A String&quot;,
381 &quot;enableAutoReload&quot;: True or False,
382 &quot;knowledgeTypes&quot;: [
383 &quot;A String&quot;,
384 ],
385 &quot;latestReloadStatus&quot;: {
386 &quot;status&quot;: {
387 &quot;code&quot;: 42,
388 &quot;details&quot;: [
389 {
390 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
391 },
392 ],
393 &quot;message&quot;: &quot;A String&quot;,
394 },
395 &quot;time&quot;: &quot;A String&quot;,
396 },
397 &quot;metadata&quot;: {
398 &quot;a_key&quot;: &quot;A String&quot;,
399 },
400 &quot;mimeType&quot;: &quot;A String&quot;,
401 &quot;name&quot;: &quot;A String&quot;,
402 &quot;rawContent&quot;: &quot;A String&quot;,
403 &quot;state&quot;: &quot;A String&quot;,
404 },
405 ],
406 &quot;nextPageToken&quot;: &quot;A String&quot;,
407 }</pre>
408 </div>
409
410 <div class="method">
411 <code class="details" id="list_next">list_next()</code>
412 <pre>Retrieves the next page of results.
413
414 Args:
415 previous_request: The request for the previous page. (required)
416 previous_response: The response from the request for the previous page. (required)
417
418 Returns:
419 A request object that you can call &#x27;execute()&#x27; on to request the next
420 page. Returns None if there are no more items in the collection.
421 </pre>
422 </div>
423
424 <div class="method">
425 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
426 <pre>
427
428 Args:
429 name: string, A parameter (required)
430 body: object, The request body.
431 The object takes the form of:
432
433 {
434 &quot;contentUri&quot;: &quot;A String&quot;,
435 &quot;displayName&quot;: &quot;A String&quot;,
436 &quot;enableAutoReload&quot;: True or False,
437 &quot;knowledgeTypes&quot;: [
438 &quot;A String&quot;,
439 ],
440 &quot;latestReloadStatus&quot;: {
441 &quot;status&quot;: {
442 &quot;code&quot;: 42,
443 &quot;details&quot;: [
444 {
445 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
446 },
447 ],
448 &quot;message&quot;: &quot;A String&quot;,
449 },
450 &quot;time&quot;: &quot;A String&quot;,
451 },
452 &quot;metadata&quot;: {
453 &quot;a_key&quot;: &quot;A String&quot;,
454 },
455 &quot;mimeType&quot;: &quot;A String&quot;,
456 &quot;name&quot;: &quot;A String&quot;,
457 &quot;rawContent&quot;: &quot;A String&quot;,
458 &quot;state&quot;: &quot;A String&quot;,
459 }
460
461 updateMask: string, A parameter
462 x__xgafv: string, V1 error format.
463 Allowed values
464 1 - v1 error format
465 2 - v2 error format
466
467 Returns:
468 An object of the form:
469
470 {
471 &quot;done&quot;: True or False,
472 &quot;error&quot;: {
473 &quot;code&quot;: 42,
474 &quot;details&quot;: [
475 {
476 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
477 },
478 ],
479 &quot;message&quot;: &quot;A String&quot;,
480 },
481 &quot;metadata&quot;: {
482 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
483 },
484 &quot;name&quot;: &quot;A String&quot;,
485 &quot;response&quot;: {
486 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
487 },
488 }</pre>
489 </div>
490
491 <div class="method">
492 <code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
493 <pre>
494
495 Args:
496 name: string, A parameter (required)
497 body: object, The request body.
498 The object takes the form of:
499
500 {
501 &quot;contentUri&quot;: &quot;A String&quot;,
502 &quot;importGcsCustomMetadata&quot;: True or False,
503 &quot;smartMessagingPartialUpdate&quot;: True or False,
504 }
505
506 x__xgafv: string, V1 error format.
507 Allowed values
508 1 - v1 error format
509 2 - v2 error format
510
511 Returns:
512 An object of the form:
513
514 {
515 &quot;done&quot;: True or False,
516 &quot;error&quot;: {
517 &quot;code&quot;: 42,
518 &quot;details&quot;: [
519 {
520 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
521 },
522 ],
523 &quot;message&quot;: &quot;A String&quot;,
524 },
525 &quot;metadata&quot;: {
526 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
527 },
528 &quot;name&quot;: &quot;A String&quot;,
529 &quot;response&quot;: {
530 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
531 },
532 }</pre>
533 </div>
534
535 </body></html>