Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4c9ccb08aa866b5402c5e63c70306b5a3c121ba1 / . / docs / dyn / dialogflow_v2beta1.projects.agent.knowledgeBases.html
blob: d305377cf212cb7ffd696a37d21271a01a6b5a9a [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87<p class="firstline">Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90<p class="firstline">Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93<p class="firstline">Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]95 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96<p class="firstline">Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102<p class="firstline">Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109<div class="method">
110 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
111 <pre>Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112
113Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]114 parent: string, Required. The project to create a knowledge base for. Format: `projects//locations/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 The object takes the form of:
117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]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, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]122}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]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, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137</div>
138
139<div class="method">
140 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 <pre>Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142
143Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]144 name: string, Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]155}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156</div>
157
158<div class="method">
159 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 <pre>Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161
162Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]163 name: string, Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]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, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]176}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177</div>
178
179<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]180 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181 <pre>Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182
183Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]184 parent: string, Required. The project to list of knowledge bases for. Format: `projects//locations/`. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]185 filter: string, The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * &#x27;language_code=en-us&#x27; matches knowledge bases with en-us language code. * &#x27;display_name:articles&#x27; matches knowledge bases whose display name contains &quot;articles&quot;. * &#x27;display_name:&quot;Best Articles&quot;&#x27; matches knowledge bases whose display name contains &quot;Best Articles&quot;. * &#x27;language_code=en-gb AND display_name=articles&#x27; matches all knowledge bases whose display name contains &quot;articles&quot; and whose language code is &quot;en-gb&quot;. Note: An empty filter string (i.e. &quot;&quot;) is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]186 pageSize: integer, The maximum number of items to return in a single page. By default 10 and at most 100.
187 pageToken: string, The next_page_token value returned from a previous list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # Response message for KnowledgeBases.ListKnowledgeBases.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]197 &quot;knowledgeBases&quot;: [ # The list of knowledge bases.
198 { # 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`.
199 &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.
200 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]201 &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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]202 },
203 ],
204 &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.
205}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206</div>
207
208<div class="method">
209 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
210 <pre>Retrieves the next page of results.
211
212Args:
213 previous_request: The request for the previous page. (required)
214 previous_response: The response from the request for the previous page. (required)
215
216Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 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]218 page. Returns None if there are no more items in the collection.
219 </pre>
220</div>
221
222<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]223 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]224 <pre>Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225
226Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]227 name: string, The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 The object takes the form of:
230
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]231{ # 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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]232 &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.
233 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]234 &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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]235}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]237 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 x__xgafv: string, V1 error format.
239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
242
243Returns:
244 An object of the form:
245
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]246 { # 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`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]247 &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.
248 &quot;languageCode&quot;: &quot;A String&quot;, # Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]249 &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/`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]250}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251</div>
252
253</body></html>