Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
blob: c7a251a2517a12f96a6b7330edfebf222f8d75fd [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new document.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the specified document.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the specified document.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
88<p class="firstline">Returns the list of all documents of the knowledge base.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates the specified document.</p>
95<p class="toc_element">
96 <code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Reloads the specified document from its specified source, content_uri or</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
101 <pre>Creates a new document.
102
103Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
104only use `projects.knowledgeBases.documents`.
105
106Operation <response: Document,
107 metadata: KnowledgeOperationMetadata>
108
109Args:
110 parent: string, Required. The knoweldge base to create a document for.
111Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # A document resource.
116 #
117 # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
118 # only use `projects.knowledgeBases.documents`.
119 "mimeType": "A String", # Required. The MIME type of this document.
120 "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
121 # less; otherwise, the creation request fails.
122 "contentUri": "A String", # The URI where the file content is located.
123 #
124 # For documents stored in Google Cloud Storage, these URIs must have
125 # the form `gs://<bucket-name>/<object-name>`.
126 #
127 # NOTE: External URLs must correspond to public webpages, i.e., they must
128 # be indexed by Google Search. In particular, URLs for showing documents in
129 # Google Cloud Storage (i.e. the URL in your browser) are not supported.
130 # Instead use the `gs://` format URI described above.
131 "content": "A String", # The raw content of the document. This field is only permitted for
132 # EXTRACTIVE_QA and FAQ knowledge types.
133 # Note: This field is in the process of being deprecated, please use
134 # raw_content instead.
135 "knowledgeTypes": [ # Required. The knowledge type of document content.
136 "A String",
137 ],
138 "rawContent": "A String", # The raw content of the document. This field is only permitted for
139 # EXTRACTIVE_QA and FAQ knowledge types.
140 "name": "A String", # The document resource name.
141 # The name must be empty when creating a document.
142 # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
143 # ID>/documents/<Document ID>`.
144}
145
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
154 { # This resource represents a long-running operation that is the result of a
155 # network API call.
156 "metadata": { # Service-specific metadata associated with the operation. It typically
157 # contains progress information and common metadata such as create time.
158 # Some services might not provide such metadata. Any method that returns a
159 # long-running operation should document the metadata type, if any.
160 "a_key": "", # Properties of the object. Contains field @type with type URL.
161 },
162 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
163 # different programming environments, including REST APIs and RPC APIs. It is
164 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
165 # three pieces of data: error code, error message, and error details.
166 #
167 # You can find out more about this error model and how to work with it in the
168 # [API Design Guide](https://cloud.google.com/apis/design/errors).
169 "message": "A String", # A developer-facing error message, which should be in English. Any
170 # user-facing error message should be localized and sent in the
171 # google.rpc.Status.details field, or localized by the client.
172 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
173 "details": [ # A list of messages that carry the error details. There is a common set of
174 # message types for APIs to use.
175 {
176 "a_key": "", # Properties of the object. Contains field @type with type URL.
177 },
178 ],
179 },
180 "done": True or False, # If the value is `false`, it means the operation is still in progress.
181 # If `true`, the operation is completed, and either `error` or `response` is
182 # available.
183 "response": { # The normal response of the operation in case of success. If the original
184 # method returns no data on success, such as `Delete`, the response is
185 # `google.protobuf.Empty`. If the original method is standard
186 # `Get`/`Create`/`Update`, the response should be the resource. For other
187 # methods, the response should have the type `XxxResponse`, where `Xxx`
188 # is the original method name. For example, if the original method name
189 # is `TakeSnapshot()`, the inferred response type is
190 # `TakeSnapshotResponse`.
191 "a_key": "", # Properties of the object. Contains field @type with type URL.
192 },
193 "name": "A String", # The server-assigned name, which is only unique within the same service that
194 # originally returns it. If you use the default HTTP mapping, the
195 # `name` should be a resource name ending with `operations/{unique_id}`.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
201 <pre>Deletes the specified document.
202
203Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
204only use `projects.knowledgeBases.documents`.
205
206Operation <response: google.protobuf.Empty,
207 metadata: KnowledgeOperationMetadata>
208
209Args:
210 name: string, The name of the document to delete.
211Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
212ID>/documents/<Document ID>`. (required)
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # This resource represents a long-running operation that is the result of a
222 # network API call.
223 "metadata": { # Service-specific metadata associated with the operation. It typically
224 # contains progress information and common metadata such as create time.
225 # Some services might not provide such metadata. Any method that returns a
226 # long-running operation should document the metadata type, if any.
227 "a_key": "", # Properties of the object. Contains field @type with type URL.
228 },
229 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
230 # different programming environments, including REST APIs and RPC APIs. It is
231 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
232 # three pieces of data: error code, error message, and error details.
233 #
234 # You can find out more about this error model and how to work with it in the
235 # [API Design Guide](https://cloud.google.com/apis/design/errors).
236 "message": "A String", # A developer-facing error message, which should be in English. Any
237 # user-facing error message should be localized and sent in the
238 # google.rpc.Status.details field, or localized by the client.
239 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
240 "details": [ # A list of messages that carry the error details. There is a common set of
241 # message types for APIs to use.
242 {
243 "a_key": "", # Properties of the object. Contains field @type with type URL.
244 },
245 ],
246 },
247 "done": True or False, # If the value is `false`, it means the operation is still in progress.
248 # If `true`, the operation is completed, and either `error` or `response` is
249 # available.
250 "response": { # The normal response of the operation in case of success. If the original
251 # method returns no data on success, such as `Delete`, the response is
252 # `google.protobuf.Empty`. If the original method is standard
253 # `Get`/`Create`/`Update`, the response should be the resource. For other
254 # methods, the response should have the type `XxxResponse`, where `Xxx`
255 # is the original method name. For example, if the original method name
256 # is `TakeSnapshot()`, the inferred response type is
257 # `TakeSnapshotResponse`.
258 "a_key": "", # Properties of the object. Contains field @type with type URL.
259 },
260 "name": "A String", # The server-assigned name, which is only unique within the same service that
261 # originally returns it. If you use the default HTTP mapping, the
262 # `name` should be a resource name ending with `operations/{unique_id}`.
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="get">get(name, x__xgafv=None)</code>
268 <pre>Retrieves the specified document.
269
270Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
271only use `projects.knowledgeBases.documents`.
272
273Args:
274 name: string, Required. The name of the document to retrieve.
275Format `projects/<Project ID>/knowledgeBases/<Knowledge Base
276ID>/documents/<Document ID>`. (required)
277 x__xgafv: string, V1 error format.
278 Allowed values
279 1 - v1 error format
280 2 - v2 error format
281
282Returns:
283 An object of the form:
284
285 { # A document resource.
286 #
287 # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
288 # only use `projects.knowledgeBases.documents`.
289 "mimeType": "A String", # Required. The MIME type of this document.
290 "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
291 # less; otherwise, the creation request fails.
292 "contentUri": "A String", # The URI where the file content is located.
293 #
294 # For documents stored in Google Cloud Storage, these URIs must have
295 # the form `gs://<bucket-name>/<object-name>`.
296 #
297 # NOTE: External URLs must correspond to public webpages, i.e., they must
298 # be indexed by Google Search. In particular, URLs for showing documents in
299 # Google Cloud Storage (i.e. the URL in your browser) are not supported.
300 # Instead use the `gs://` format URI described above.
301 "content": "A String", # The raw content of the document. This field is only permitted for
302 # EXTRACTIVE_QA and FAQ knowledge types.
303 # Note: This field is in the process of being deprecated, please use
304 # raw_content instead.
305 "knowledgeTypes": [ # Required. The knowledge type of document content.
306 "A String",
307 ],
308 "rawContent": "A String", # The raw content of the document. This field is only permitted for
309 # EXTRACTIVE_QA and FAQ knowledge types.
310 "name": "A String", # The document resource name.
311 # The name must be empty when creating a document.
312 # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
313 # ID>/documents/<Document ID>`.
314 }</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
319 <pre>Returns the list of all documents of the knowledge base.
320
321Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
322only use `projects.knowledgeBases.documents`.
323
324Args:
325 parent: string, Required. The knowledge base to list all documents for.
326Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
327 pageToken: string, Optional. The next_page_token value returned from a previous list request.
328 x__xgafv: string, V1 error format.
329 Allowed values
330 1 - v1 error format
331 2 - v2 error format
332 pageSize: integer, Optional. The maximum number of items to return in a single page. By
333default 10 and at most 100.
334
335Returns:
336 An object of the form:
337
338 { # Response message for Documents.ListDocuments.
339 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
340 # more results in the list.
341 "documents": [ # The list of documents.
342 { # A document resource.
343 #
344 # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
345 # only use `projects.knowledgeBases.documents`.
346 "mimeType": "A String", # Required. The MIME type of this document.
347 "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
348 # less; otherwise, the creation request fails.
349 "contentUri": "A String", # The URI where the file content is located.
350 #
351 # For documents stored in Google Cloud Storage, these URIs must have
352 # the form `gs://<bucket-name>/<object-name>`.
353 #
354 # NOTE: External URLs must correspond to public webpages, i.e., they must
355 # be indexed by Google Search. In particular, URLs for showing documents in
356 # Google Cloud Storage (i.e. the URL in your browser) are not supported.
357 # Instead use the `gs://` format URI described above.
358 "content": "A String", # The raw content of the document. This field is only permitted for
359 # EXTRACTIVE_QA and FAQ knowledge types.
360 # Note: This field is in the process of being deprecated, please use
361 # raw_content instead.
362 "knowledgeTypes": [ # Required. The knowledge type of document content.
363 "A String",
364 ],
365 "rawContent": "A String", # The raw content of the document. This field is only permitted for
366 # EXTRACTIVE_QA and FAQ knowledge types.
367 "name": "A String", # The document resource name.
368 # The name must be empty when creating a document.
369 # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
370 # ID>/documents/<Document ID>`.
371 },
372 ],
373 }</pre>
374</div>
375
376<div class="method">
377 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
378 <pre>Retrieves the next page of results.
379
380Args:
381 previous_request: The request for the previous page. (required)
382 previous_response: The response from the request for the previous page. (required)
383
384Returns:
385 A request object that you can call 'execute()' on to request the next
386 page. Returns None if there are no more items in the collection.
387 </pre>
388</div>
389
390<div class="method">
391 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
392 <pre>Updates the specified document.
393
394Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
395only use `projects.knowledgeBases.documents`.
396
397Operation <response: Document,
398 metadata: KnowledgeOperationMetadata>
399
400Args:
401 name: string, The document resource name.
402The name must be empty when creating a document.
403Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
404ID>/documents/<Document ID>`. (required)
405 body: object, The request body. (required)
406 The object takes the form of:
407
408{ # A document resource.
409 #
410 # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
411 # only use `projects.knowledgeBases.documents`.
412 "mimeType": "A String", # Required. The MIME type of this document.
413 "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
414 # less; otherwise, the creation request fails.
415 "contentUri": "A String", # The URI where the file content is located.
416 #
417 # For documents stored in Google Cloud Storage, these URIs must have
418 # the form `gs://<bucket-name>/<object-name>`.
419 #
420 # NOTE: External URLs must correspond to public webpages, i.e., they must
421 # be indexed by Google Search. In particular, URLs for showing documents in
422 # Google Cloud Storage (i.e. the URL in your browser) are not supported.
423 # Instead use the `gs://` format URI described above.
424 "content": "A String", # The raw content of the document. This field is only permitted for
425 # EXTRACTIVE_QA and FAQ knowledge types.
426 # Note: This field is in the process of being deprecated, please use
427 # raw_content instead.
428 "knowledgeTypes": [ # Required. The knowledge type of document content.
429 "A String",
430 ],
431 "rawContent": "A String", # The raw content of the document. This field is only permitted for
432 # EXTRACTIVE_QA and FAQ knowledge types.
433 "name": "A String", # The document resource name.
434 # The name must be empty when creating a document.
435 # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
436 # ID>/documents/<Document ID>`.
437}
438
439 updateMask: string, Optional. Not specified means `update all`.
440Currently, only `display_name` can be updated, an InvalidArgument will be
441returned for attempting to update other fields.
442 x__xgafv: string, V1 error format.
443 Allowed values
444 1 - v1 error format
445 2 - v2 error format
446
447Returns:
448 An object of the form:
449
450 { # This resource represents a long-running operation that is the result of a
451 # network API call.
452 "metadata": { # Service-specific metadata associated with the operation. It typically
453 # contains progress information and common metadata such as create time.
454 # Some services might not provide such metadata. Any method that returns a
455 # long-running operation should document the metadata type, if any.
456 "a_key": "", # Properties of the object. Contains field @type with type URL.
457 },
458 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
459 # different programming environments, including REST APIs and RPC APIs. It is
460 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
461 # three pieces of data: error code, error message, and error details.
462 #
463 # You can find out more about this error model and how to work with it in the
464 # [API Design Guide](https://cloud.google.com/apis/design/errors).
465 "message": "A String", # A developer-facing error message, which should be in English. Any
466 # user-facing error message should be localized and sent in the
467 # google.rpc.Status.details field, or localized by the client.
468 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
469 "details": [ # A list of messages that carry the error details. There is a common set of
470 # message types for APIs to use.
471 {
472 "a_key": "", # Properties of the object. Contains field @type with type URL.
473 },
474 ],
475 },
476 "done": True or False, # If the value is `false`, it means the operation is still in progress.
477 # If `true`, the operation is completed, and either `error` or `response` is
478 # available.
479 "response": { # The normal response of the operation in case of success. If the original
480 # method returns no data on success, such as `Delete`, the response is
481 # `google.protobuf.Empty`. If the original method is standard
482 # `Get`/`Create`/`Update`, the response should be the resource. For other
483 # methods, the response should have the type `XxxResponse`, where `Xxx`
484 # is the original method name. For example, if the original method name
485 # is `TakeSnapshot()`, the inferred response type is
486 # `TakeSnapshotResponse`.
487 "a_key": "", # Properties of the object. Contains field @type with type URL.
488 },
489 "name": "A String", # The server-assigned name, which is only unique within the same service that
490 # originally returns it. If you use the default HTTP mapping, the
491 # `name` should be a resource name ending with `operations/{unique_id}`.
492 }</pre>
493</div>
494
495<div class="method">
496 <code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
497 <pre>Reloads the specified document from its specified source, content_uri or
498content. The previously loaded content of the document will be deleted.
499Note: Even when the content of the document has not changed, there still
500may be side effects because of internal implementation changes.
501
502Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
503only use `projects.knowledgeBases.documents`.
504
505Operation <response: Document,
506 metadata: KnowledgeOperationMetadata>
507
508Args:
509 name: string, The name of the document to reload.
510Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
511ID>/documents/<Document ID>` (required)
512 body: object, The request body.
513 The object takes the form of:
514
515{ # Request message for Documents.ReloadDocument.
516 }
517
518 x__xgafv: string, V1 error format.
519 Allowed values
520 1 - v1 error format
521 2 - v2 error format
522
523Returns:
524 An object of the form:
525
526 { # This resource represents a long-running operation that is the result of a
527 # network API call.
528 "metadata": { # Service-specific metadata associated with the operation. It typically
529 # contains progress information and common metadata such as create time.
530 # Some services might not provide such metadata. Any method that returns a
531 # long-running operation should document the metadata type, if any.
532 "a_key": "", # Properties of the object. Contains field @type with type URL.
533 },
534 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
535 # different programming environments, including REST APIs and RPC APIs. It is
536 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
537 # three pieces of data: error code, error message, and error details.
538 #
539 # You can find out more about this error model and how to work with it in the
540 # [API Design Guide](https://cloud.google.com/apis/design/errors).
541 "message": "A String", # A developer-facing error message, which should be in English. Any
542 # user-facing error message should be localized and sent in the
543 # google.rpc.Status.details field, or localized by the client.
544 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
545 "details": [ # A list of messages that carry the error details. There is a common set of
546 # message types for APIs to use.
547 {
548 "a_key": "", # Properties of the object. Contains field @type with type URL.
549 },
550 ],
551 },
552 "done": True or False, # If the value is `false`, it means the operation is still in progress.
553 # If `true`, the operation is completed, and either `error` or `response` is
554 # available.
555 "response": { # The normal response of the operation in case of success. If the original
556 # method returns no data on success, such as `Delete`, the response is
557 # `google.protobuf.Empty`. If the original method is standard
558 # `Get`/`Create`/`Update`, the response should be the resource. For other
559 # methods, the response should have the type `XxxResponse`, where `Xxx`
560 # is the original method name. For example, if the original method name
561 # is `TakeSnapshot()`, the inferred response type is
562 # `TakeSnapshotResponse`.
563 "a_key": "", # Properties of the object. Contains field @type with type URL.
564 },
565 "name": "A String", # The server-assigned name, which is only unique within the same service that
566 # originally returns it. If you use the default HTTP mapping, the
567 # `name` should be a resource name ending with `operations/{unique_id}`.
568 }</pre>
569</div>
570
571</body></html>