Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / dyn / dialogflow_v2.projects.agent.knowledgeBases.html
blob: c80cf437f4d13ccb4eb97ea119b263facb67479a [file] [log] [blame]
yoshi-code-bota8b35b92021-03-31 13:33:30 -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_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a> . <a href="dialogflow_v2.projects.agent.knowledgeBases.html">knowledgeBases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2.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">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a knowledge base.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes the specified knowledge base.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Retrieves the specified knowledge base.</p>
94<p class="toc_element">
95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Returns the list of all knowledge bases of the specified agent.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Updates the specified knowledge base.</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
111 <pre>Creates a knowledge base.
112
113Args:
114 parent: string, Required. The project to create a knowledge base for. Format: `projects//locations/`. (required)
115 body: object, The request body.
116 The object takes the form of:
117
118{ # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
119 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
120 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
121 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
122}
123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
132 { # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
133 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
134 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
135 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
136}</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
141 <pre>Deletes the specified knowledge base.
142
143Args:
144 name: string, Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`. (required)
145 force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
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 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
155}</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="get">get(name, x__xgafv=None)</code>
160 <pre>Retrieves the specified knowledge base.
161
162Args:
163 name: string, Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`. (required)
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
172 { # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
173 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
174 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
175 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
176}</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
181 <pre>Returns the list of all knowledge bases of the specified agent.
182
183Args:
184 parent: string, Required. The project to list of knowledge bases for. Format: `projects//locations/`. (required)
185 pageSize: integer, The maximum number of items to return in a single page. By default 10 and at most 100.
186 pageToken: string, The next_page_token value returned from a previous list request.
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # Response message for KnowledgeBases.ListKnowledgeBases.
196 &quot;knowledgeBases&quot;: [ # The list of knowledge bases.
197 { # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
198 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
199 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
200 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
201 },
202 ],
203 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
204}</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
209 <pre>Retrieves the next page of results.
210
211Args:
212 previous_request: The request for the previous page. (required)
213 previous_response: The response from the request for the previous page. (required)
214
215Returns:
216 A request object that you can call &#x27;execute()&#x27; on to request the next
217 page. Returns None if there are no more items in the collection.
218 </pre>
219</div>
220
221<div class="method">
222 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
223 <pre>Updates the specified knowledge base.
224
225Args:
226 name: string, The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`. (required)
227 body: object, The request body.
228 The object takes the form of:
229
230{ # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
231 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
232 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
233 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
234}
235
236 updateMask: string, Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242Returns:
243 An object of the form:
244
245 { # A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
246 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
247 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies.
248 &quot;name&quot;: &quot;A String&quot;, # The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.
249}</pre>
250</div>
251
252</body></html>