Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / dialogflow_v2beta1.projects.agent.knowledgeBases.html
blob: 5f9e1de3e07417596380dff9d735b8b7e09ff8d1 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html">documents()</a></code>
79</p>
80<p class="firstline">Returns the documents Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Creates a knowledge base.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified knowledge base.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Retrieves the specified knowledge base.</p>
91<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]92 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="firstline">Returns the list of all knowledge bases of the specified agent.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="firstline">Updates the specified knowledge base.</p>
100<h3>Method Details</h3>
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 <pre>Creates a knowledge base.
104
105Note: The `projects.agent.knowledgeBases` resource is deprecated;
106only use `projects.knowledgeBases`.
107
108Args:
109 parent: string, Required. The project to create a knowledge base for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110Format: `projects/&lt;Project ID&gt;`. (required)
111 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 The object takes the form of:
113
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114{ # A knowledge base represents a collection of knowledge documents that you
115 # provide to Dialogflow. Your knowledge documents contain information that may
116 # be useful during conversations with end-users. Some Dialogflow features use
117 # knowledge bases when looking for a response to an end-user input.
118 #
119 # For more information, see the [knowledge base
120 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]121 #
122 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
123 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]124 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
125 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]126 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
127 # The name must be empty when creating a knowledge base.
128 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]129 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
130 # created/updated, this is populated for all non en-us languages. If not
131 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]132 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]142 { # A knowledge base represents a collection of knowledge documents that you
143 # provide to Dialogflow. Your knowledge documents contain information that may
144 # be useful during conversations with end-users. Some Dialogflow features use
145 # knowledge bases when looking for a response to an end-user input.
146 #
147 # For more information, see the [knowledge base
148 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]149 #
150 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
151 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]152 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
153 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]154 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
155 # The name must be empty when creating a knowledge base.
156 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]157 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
158 # created/updated, this is populated for all non en-us languages. If not
159 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161</div>
162
163<div class="method">
164 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
165 <pre>Deletes the specified knowledge base.
166
167Note: The `projects.agent.knowledgeBases` resource is deprecated;
168only use `projects.knowledgeBases`.
169
170Args:
171 name: string, Required. The name of the knowledge base to delete.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]172Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents
174in the knowledge base are also deleted.
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # A generic empty message that you can re-use to avoid defining duplicated
184 # empty messages in your APIs. A typical example is to use it as the request
185 # or the response type of an API method. For instance:
186 #
187 # service Foo {
188 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
189 # }
190 #
191 # The JSON representation for `Empty` is empty JSON object `{}`.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="get">get(name, x__xgafv=None)</code>
197 <pre>Retrieves the specified knowledge base.
198
199Note: The `projects.agent.knowledgeBases` resource is deprecated;
200only use `projects.knowledgeBases`.
201
202Args:
203 name: string, Required. The name of the knowledge base to retrieve.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]204Format `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]213 { # A knowledge base represents a collection of knowledge documents that you
214 # provide to Dialogflow. Your knowledge documents contain information that may
215 # be useful during conversations with end-users. Some Dialogflow features use
216 # knowledge bases when looking for a response to an end-user input.
217 #
218 # For more information, see the [knowledge base
219 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]220 #
221 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
222 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]223 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
224 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]225 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
226 # The name must be empty when creating a knowledge base.
227 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]228 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
229 # created/updated, this is populated for all non en-us languages. If not
230 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]231 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232</div>
233
234<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]235 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 <pre>Returns the list of all knowledge bases of the specified agent.
237
238Note: The `projects.agent.knowledgeBases` resource is deprecated;
239only use `projects.knowledgeBases`.
240
241Args:
242 parent: string, Required. The project to list of knowledge bases for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 pageSize: integer, Optional. The maximum number of items to return in a single page. By
245default 10 and at most 100.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]246 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
251
252Returns:
253 An object of the form:
254
255 { # Response message for KnowledgeBases.ListKnowledgeBases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 &quot;knowledgeBases&quot;: [ # The list of knowledge bases.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]257 { # A knowledge base represents a collection of knowledge documents that you
258 # provide to Dialogflow. Your knowledge documents contain information that may
259 # be useful during conversations with end-users. Some Dialogflow features use
260 # knowledge bases when looking for a response to an end-user input.
261 #
262 # For more information, see the [knowledge base
263 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]264 #
265 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
266 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]267 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
268 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]269 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
270 # The name must be empty when creating a knowledge base.
271 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]272 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
273 # created/updated, this is populated for all non en-us languages. If not
274 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]275 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]277 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
278 # more results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 }</pre>
280</div>
281
282<div class="method">
283 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
284 <pre>Retrieves the next page of results.
285
286Args:
287 previous_request: The request for the previous page. (required)
288 previous_response: The response from the request for the previous page. (required)
289
290Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 page. Returns None if there are no more items in the collection.
293 </pre>
294</div>
295
296<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 <pre>Updates the specified knowledge base.
299
300Note: The `projects.agent.knowledgeBases` resource is deprecated;
301only use `projects.knowledgeBases`.
302
303Args:
304 name: string, The knowledge base resource name.
305The name must be empty when creating a knowledge base.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]306Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
307 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 The object takes the form of:
309
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]310{ # A knowledge base represents a collection of knowledge documents that you
311 # provide to Dialogflow. Your knowledge documents contain information that may
312 # be useful during conversations with end-users. Some Dialogflow features use
313 # knowledge bases when looking for a response to an end-user input.
314 #
315 # For more information, see the [knowledge base
316 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]317 #
318 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
319 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]320 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
321 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]322 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
323 # The name must be empty when creating a knowledge base.
324 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]325 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
326 # created/updated, this is populated for all non en-us languages. If not
327 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]328 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329
330 updateMask: string, Optional. Not specified means `update all`.
331Currently, only `display_name` can be updated, an InvalidArgument will be
332returned for attempting to update other fields.
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]341 { # A knowledge base represents a collection of knowledge documents that you
342 # provide to Dialogflow. Your knowledge documents contain information that may
343 # be useful during conversations with end-users. Some Dialogflow features use
344 # knowledge bases when looking for a response to an end-user input.
345 #
346 # For more information, see the [knowledge base
347 # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]348 #
349 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
350 # only use `projects.knowledgeBases`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]351 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
352 # bytes or less; otherwise, the creation request fails.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]353 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
354 # The name must be empty when creating a knowledge base.
355 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]356 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
357 # created/updated, this is populated for all non en-us languages. If not
358 # populated, the default language en-us applies.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]359 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360</div>
361
362</body></html>