Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / dialogflow_v2beta1.projects.agent.knowledgeBases.html
blob: 9377b9b4355bc8c17a330c8bcced2c963f32e489 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 <code><a href="#list">list(parent, pageToken=None, pageSize=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
114{ # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 #
116 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
117 # only use `projects.knowledgeBases`.
118 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
119 # The name must be empty when creating a knowledge base.
120 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
121 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
122 # bytes or less; otherwise, the creation request fails.
123 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
124 # created/updated, this is populated for all non en-us languages. If not
125 # populated, the default language en-us applies.
126}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 #
138 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
139 # only use `projects.knowledgeBases`.
140 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
141 # The name must be empty when creating a knowledge base.
142 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
143 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
144 # bytes or less; otherwise, the creation request fails.
145 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
146 # created/updated, this is populated for all non en-us languages. If not
147 # populated, the default language en-us applies.
148 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149</div>
150
151<div class="method">
152 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
153 <pre>Deletes the specified knowledge base.
154
155Note: The `projects.agent.knowledgeBases` resource is deprecated;
156only use `projects.knowledgeBases`.
157
158Args:
159 name: string, Required. The name of the knowledge base to delete.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]160Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents
162in the knowledge base are also deleted.
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
171 { # A generic empty message that you can re-use to avoid defining duplicated
172 # empty messages in your APIs. A typical example is to use it as the request
173 # or the response type of an API method. For instance:
174 #
175 # service Foo {
176 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
177 # }
178 #
179 # The JSON representation for `Empty` is empty JSON object `{}`.
180 }</pre>
181</div>
182
183<div class="method">
184 <code class="details" id="get">get(name, x__xgafv=None)</code>
185 <pre>Retrieves the specified knowledge base.
186
187Note: The `projects.agent.knowledgeBases` resource is deprecated;
188only use `projects.knowledgeBases`.
189
190Args:
191 name: string, Required. The name of the knowledge base to retrieve.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192Format `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198Returns:
199 An object of the form:
200
201 { # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 #
203 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
204 # only use `projects.knowledgeBases`.
205 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
206 # The name must be empty when creating a knowledge base.
207 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
208 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
209 # bytes or less; otherwise, the creation request fails.
210 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
211 # created/updated, this is populated for all non en-us languages. If not
212 # populated, the default language en-us applies.
213 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214</div>
215
216<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 <pre>Returns the list of all knowledge bases of the specified agent.
219
220Note: The `projects.agent.knowledgeBases` resource is deprecated;
221only use `projects.knowledgeBases`.
222
223Args:
224 parent: string, Required. The project to list of knowledge bases for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]225Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 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]227 pageSize: integer, Optional. The maximum number of items to return in a single page. By
228default 10 and at most 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # Response message for KnowledgeBases.ListKnowledgeBases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &quot;knowledgeBases&quot;: [ # The list of knowledge bases.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 { # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 #
243 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
244 # only use `projects.knowledgeBases`.
245 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
246 # The name must be empty when creating a knowledge base.
247 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
248 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
249 # bytes or less; otherwise, the creation request fails.
250 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
251 # created/updated, this is populated for all non en-us languages. If not
252 # populated, the default language en-us applies.
253 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 ],
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
260 <pre>Retrieves the next page of results.
261
262Args:
263 previous_request: The request for the previous page. (required)
264 previous_response: The response from the request for the previous page. (required)
265
266Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 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]268 page. Returns None if there are no more items in the collection.
269 </pre>
270</div>
271
272<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]273 <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]274 <pre>Updates the specified knowledge base.
275
276Note: The `projects.agent.knowledgeBases` resource is deprecated;
277only use `projects.knowledgeBases`.
278
279Args:
280 name: string, The knowledge base resource name.
281The name must be empty when creating a knowledge base.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 The object takes the form of:
285
286{ # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 #
288 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
289 # only use `projects.knowledgeBases`.
290 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
291 # The name must be empty when creating a knowledge base.
292 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
293 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
294 # bytes or less; otherwise, the creation request fails.
295 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
296 # created/updated, this is populated for all non en-us languages. If not
297 # populated, the default language en-us applies.
298}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299
300 updateMask: string, Optional. Not specified means `update all`.
301Currently, only `display_name` can be updated, an InvalidArgument will be
302returned for attempting to update other fields.
303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
307
308Returns:
309 An object of the form:
310
311 { # Represents knowledge base resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312 #
313 # Note: The `projects.agent.knowledgeBases` resource is deprecated;
314 # only use `projects.knowledgeBases`.
315 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name.
316 # The name must be empty when creating a knowledge base.
317 # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`.
318 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024
319 # bytes or less; otherwise, the creation request fails.
320 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is
321 # created/updated, this is populated for all non en-us languages. If not
322 # populated, the default language en-us applies.
323 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324</div>
325
326</body></html>