Debian Codegraph @

docs/dyn/dialogflow_v2beta1.projects.agent.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.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2beta1.projects.agent.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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline"></p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline"></p>
98 <p class="toc_element">
99 <code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline"></p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="create">create(parent, body=None, importGcsCustomMetadata=None, x__xgafv=None)</code>
109 <pre>
110
111 Args:
112 parent: string, A parameter (required)
113 body: object, The request body.
114 The object takes the form of:
115
116 {
117 &quot;content&quot;: &quot;A String&quot;,
118 &quot;contentUri&quot;: &quot;A String&quot;,
119 &quot;displayName&quot;: &quot;A String&quot;,
120 &quot;enableAutoReload&quot;: True or False,
121 &quot;knowledgeTypes&quot;: [
122 &quot;A String&quot;,
123 ],
124 &quot;latestReloadStatus&quot;: {
125 &quot;status&quot;: {
126 &quot;code&quot;: 42,
127 &quot;details&quot;: [
128 {
129 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130 },
131 ],
132 &quot;message&quot;: &quot;A String&quot;,
133 },
134 &quot;time&quot;: &quot;A String&quot;,
135 },
136 &quot;metadata&quot;: {
137 &quot;a_key&quot;: &quot;A String&quot;,
138 },
139 &quot;mimeType&quot;: &quot;A String&quot;,
140 &quot;name&quot;: &quot;A String&quot;,
141 &quot;rawContent&quot;: &quot;A String&quot;,
142 &quot;state&quot;: &quot;A String&quot;,
143 }
144
145 importGcsCustomMetadata: boolean, A parameter
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151 Returns:
152 An object of the form:
153
154 {
155 &quot;done&quot;: True or False,
156 &quot;error&quot;: {
157 &quot;code&quot;: 42,
158 &quot;details&quot;: [
159 {
160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
161 },
162 ],
163 &quot;message&quot;: &quot;A String&quot;,
164 },
165 &quot;metadata&quot;: {
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167 },
168 &quot;name&quot;: &quot;A String&quot;,
169 &quot;response&quot;: {
170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171 },
172 }</pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
177 <pre>
178
179 Args:
180 name: string, A parameter (required)
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186 Returns:
187 An object of the form:
188
189 {
190 &quot;done&quot;: True or False,
191 &quot;error&quot;: {
192 &quot;code&quot;: 42,
193 &quot;details&quot;: [
194 {
195 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
196 },
197 ],
198 &quot;message&quot;: &quot;A String&quot;,
199 },
200 &quot;metadata&quot;: {
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
203 &quot;name&quot;: &quot;A String&quot;,
204 &quot;response&quot;: {
205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
206 },
207 }</pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="get">get(name, x__xgafv=None)</code>
212 <pre>
213
214 Args:
215 name: string, A parameter (required)
216 x__xgafv: string, V1 error format.
217 Allowed values
218 1 - v1 error format
219 2 - v2 error format
220
221 Returns:
222 An object of the form:
223
224 {
225 &quot;content&quot;: &quot;A String&quot;,
226 &quot;contentUri&quot;: &quot;A String&quot;,
227 &quot;displayName&quot;: &quot;A String&quot;,
228 &quot;enableAutoReload&quot;: True or False,
229 &quot;knowledgeTypes&quot;: [
230 &quot;A String&quot;,
231 ],
232 &quot;latestReloadStatus&quot;: {
233 &quot;status&quot;: {
234 &quot;code&quot;: 42,
235 &quot;details&quot;: [
236 {
237 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
238 },
239 ],
240 &quot;message&quot;: &quot;A String&quot;,
241 },
242 &quot;time&quot;: &quot;A String&quot;,
243 },
244 &quot;metadata&quot;: {
245 &quot;a_key&quot;: &quot;A String&quot;,
246 },
247 &quot;mimeType&quot;: &quot;A String&quot;,
248 &quot;name&quot;: &quot;A String&quot;,
249 &quot;rawContent&quot;: &quot;A String&quot;,
250 &quot;state&quot;: &quot;A String&quot;,
251 }</pre>
252 </div>
253
254 <div class="method">
255 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
256 <pre>
257
258 Args:
259 parent: string, A parameter (required)
260 filter: string, A parameter
261 pageSize: integer, A parameter
262 pageToken: string, A parameter
263 x__xgafv: string, V1 error format.
264 Allowed values
265 1 - v1 error format
266 2 - v2 error format
267
268 Returns:
269 An object of the form:
270
271 {
272 &quot;documents&quot;: [
273 {
274 &quot;content&quot;: &quot;A String&quot;,
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 },
301 ],
302 &quot;nextPageToken&quot;: &quot;A String&quot;,
303 }</pre>
304 </div>
305
306 <div class="method">
307 <code class="details" id="list_next">list_next()</code>
308 <pre>Retrieves the next page of results.
309
310 Args:
311 previous_request: The request for the previous page. (required)
312 previous_response: The response from the request for the previous page. (required)
313
314 Returns:
315 A request object that you can call &#x27;execute()&#x27; on to request the next
316 page. Returns None if there are no more items in the collection.
317 </pre>
318 </div>
319
320 <div class="method">
321 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
322 <pre>
323
324 Args:
325 name: string, A parameter (required)
326 body: object, The request body.
327 The object takes the form of:
328
329 {
330 &quot;content&quot;: &quot;A String&quot;,
331 &quot;contentUri&quot;: &quot;A String&quot;,
332 &quot;displayName&quot;: &quot;A String&quot;,
333 &quot;enableAutoReload&quot;: True or False,
334 &quot;knowledgeTypes&quot;: [
335 &quot;A String&quot;,
336 ],
337 &quot;latestReloadStatus&quot;: {
338 &quot;status&quot;: {
339 &quot;code&quot;: 42,
340 &quot;details&quot;: [
341 {
342 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
343 },
344 ],
345 &quot;message&quot;: &quot;A String&quot;,
346 },
347 &quot;time&quot;: &quot;A String&quot;,
348 },
349 &quot;metadata&quot;: {
350 &quot;a_key&quot;: &quot;A String&quot;,
351 },
352 &quot;mimeType&quot;: &quot;A String&quot;,
353 &quot;name&quot;: &quot;A String&quot;,
354 &quot;rawContent&quot;: &quot;A String&quot;,
355 &quot;state&quot;: &quot;A String&quot;,
356 }
357
358 updateMask: string, A parameter
359 x__xgafv: string, V1 error format.
360 Allowed values
361 1 - v1 error format
362 2 - v2 error format
363
364 Returns:
365 An object of the form:
366
367 {
368 &quot;done&quot;: True or False,
369 &quot;error&quot;: {
370 &quot;code&quot;: 42,
371 &quot;details&quot;: [
372 {
373 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
374 },
375 ],
376 &quot;message&quot;: &quot;A String&quot;,
377 },
378 &quot;metadata&quot;: {
379 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
380 },
381 &quot;name&quot;: &quot;A String&quot;,
382 &quot;response&quot;: {
383 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
384 },
385 }</pre>
386 </div>
387
388 <div class="method">
389 <code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
390 <pre>
391
392 Args:
393 name: string, A parameter (required)
394 body: object, The request body.
395 The object takes the form of:
396
397 {
398 &quot;gcsSource&quot;: {
399 &quot;uri&quot;: &quot;A String&quot;,
400 },
401 &quot;importGcsCustomMetadata&quot;: True or False,
402 }
403
404 x__xgafv: string, V1 error format.
405 Allowed values
406 1 - v1 error format
407 2 - v2 error format
408
409 Returns:
410 An object of the form:
411
412 {
413 &quot;done&quot;: True or False,
414 &quot;error&quot;: {
415 &quot;code&quot;: 42,
416 &quot;details&quot;: [
417 {
418 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
419 },
420 ],
421 &quot;message&quot;: &quot;A String&quot;,
422 },
423 &quot;metadata&quot;: {
424 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
425 },
426 &quot;name&quot;: &quot;A String&quot;,
427 &quot;response&quot;: {
428 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
429 },
430 }</pre>
431 </div>
432
433 </body></html>