| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| 83 | <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> |
| 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"> |
| 92 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 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"> |
| 98 | <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Updates the specified knowledge base.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(parent, body, x__xgafv=None)</code> |
| 103 | <pre>Creates a knowledge base. |
| 104 | |
| 105 | Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 106 | only use `projects.knowledgeBases`. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The project to create a knowledge base for. |
| 110 | Format: `projects/<Project ID>`. (required) |
| 111 | body: object, The request body. (required) |
| 112 | The object takes the form of: |
| 113 | |
| 114 | { # Represents knowledge base resource. |
| 115 | # |
| 116 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 117 | # only use `projects.knowledgeBases`. |
| 118 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 119 | # bytes or less; otherwise, the creation request fails. |
| 120 | "name": "A String", # The knowledge base resource name. |
| 121 | # The name must be empty when creating a knowledge base. |
| 122 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 123 | } |
| 124 | |
| 125 | x__xgafv: string, V1 error format. |
| 126 | Allowed values |
| 127 | 1 - v1 error format |
| 128 | 2 - v2 error format |
| 129 | |
| 130 | Returns: |
| 131 | An object of the form: |
| 132 | |
| 133 | { # Represents knowledge base resource. |
| 134 | # |
| 135 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 136 | # only use `projects.knowledgeBases`. |
| 137 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 138 | # bytes or less; otherwise, the creation request fails. |
| 139 | "name": "A String", # The knowledge base resource name. |
| 140 | # The name must be empty when creating a knowledge base. |
| 141 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 142 | }</pre> |
| 143 | </div> |
| 144 | |
| 145 | <div class="method"> |
| 146 | <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| 147 | <pre>Deletes the specified knowledge base. |
| 148 | |
| 149 | Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 150 | only use `projects.knowledgeBases`. |
| 151 | |
| 152 | Args: |
| 153 | name: string, Required. The name of the knowledge base to delete. |
| 154 | Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required) |
| 155 | force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents |
| 156 | in the knowledge base are also deleted. |
| 157 | x__xgafv: string, V1 error format. |
| 158 | Allowed values |
| 159 | 1 - v1 error format |
| 160 | 2 - v2 error format |
| 161 | |
| 162 | Returns: |
| 163 | An object of the form: |
| 164 | |
| 165 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 166 | # empty messages in your APIs. A typical example is to use it as the request |
| 167 | # or the response type of an API method. For instance: |
| 168 | # |
| 169 | # service Foo { |
| 170 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 171 | # } |
| 172 | # |
| 173 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 174 | }</pre> |
| 175 | </div> |
| 176 | |
| 177 | <div class="method"> |
| 178 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 179 | <pre>Retrieves the specified knowledge base. |
| 180 | |
| 181 | Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 182 | only use `projects.knowledgeBases`. |
| 183 | |
| 184 | Args: |
| 185 | name: string, Required. The name of the knowledge base to retrieve. |
| 186 | Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required) |
| 187 | x__xgafv: string, V1 error format. |
| 188 | Allowed values |
| 189 | 1 - v1 error format |
| 190 | 2 - v2 error format |
| 191 | |
| 192 | Returns: |
| 193 | An object of the form: |
| 194 | |
| 195 | { # Represents knowledge base resource. |
| 196 | # |
| 197 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 198 | # only use `projects.knowledgeBases`. |
| 199 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 200 | # bytes or less; otherwise, the creation request fails. |
| 201 | "name": "A String", # The knowledge base resource name. |
| 202 | # The name must be empty when creating a knowledge base. |
| 203 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 204 | }</pre> |
| 205 | </div> |
| 206 | |
| 207 | <div class="method"> |
| 208 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 209 | <pre>Returns the list of all knowledge bases of the specified agent. |
| 210 | |
| 211 | Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 212 | only use `projects.knowledgeBases`. |
| 213 | |
| 214 | Args: |
| 215 | parent: string, Required. The project to list of knowledge bases for. |
| 216 | Format: `projects/<Project ID>`. (required) |
| 217 | pageSize: integer, Optional. The maximum number of items to return in a single page. By |
| 218 | default 10 and at most 100. |
| 219 | pageToken: string, Optional. The next_page_token value returned from a previous list request. |
| 220 | x__xgafv: string, V1 error format. |
| 221 | Allowed values |
| 222 | 1 - v1 error format |
| 223 | 2 - v2 error format |
| 224 | |
| 225 | Returns: |
| 226 | An object of the form: |
| 227 | |
| 228 | { # Response message for KnowledgeBases.ListKnowledgeBases. |
| 229 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 230 | # more results in the list. |
| 231 | "knowledgeBases": [ # The list of knowledge bases. |
| 232 | { # Represents knowledge base resource. |
| 233 | # |
| 234 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 235 | # only use `projects.knowledgeBases`. |
| 236 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 237 | # bytes or less; otherwise, the creation request fails. |
| 238 | "name": "A String", # The knowledge base resource name. |
| 239 | # The name must be empty when creating a knowledge base. |
| 240 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 241 | }, |
| 242 | ], |
| 243 | }</pre> |
| 244 | </div> |
| 245 | |
| 246 | <div class="method"> |
| 247 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 248 | <pre>Retrieves the next page of results. |
| 249 | |
| 250 | Args: |
| 251 | previous_request: The request for the previous page. (required) |
| 252 | previous_response: The response from the request for the previous page. (required) |
| 253 | |
| 254 | Returns: |
| 255 | A request object that you can call 'execute()' on to request the next |
| 256 | page. Returns None if there are no more items in the collection. |
| 257 | </pre> |
| 258 | </div> |
| 259 | |
| 260 | <div class="method"> |
| 261 | <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> |
| 262 | <pre>Updates the specified knowledge base. |
| 263 | |
| 264 | Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 265 | only use `projects.knowledgeBases`. |
| 266 | |
| 267 | Args: |
| 268 | name: string, The knowledge base resource name. |
| 269 | The name must be empty when creating a knowledge base. |
| 270 | Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required) |
| 271 | body: object, The request body. (required) |
| 272 | The object takes the form of: |
| 273 | |
| 274 | { # Represents knowledge base resource. |
| 275 | # |
| 276 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 277 | # only use `projects.knowledgeBases`. |
| 278 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 279 | # bytes or less; otherwise, the creation request fails. |
| 280 | "name": "A String", # The knowledge base resource name. |
| 281 | # The name must be empty when creating a knowledge base. |
| 282 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 283 | } |
| 284 | |
| 285 | updateMask: string, Optional. Not specified means `update all`. |
| 286 | Currently, only `display_name` can be updated, an InvalidArgument will be |
| 287 | returned for attempting to update other fields. |
| 288 | x__xgafv: string, V1 error format. |
| 289 | Allowed values |
| 290 | 1 - v1 error format |
| 291 | 2 - v2 error format |
| 292 | |
| 293 | Returns: |
| 294 | An object of the form: |
| 295 | |
| 296 | { # Represents knowledge base resource. |
| 297 | # |
| 298 | # Note: The `projects.agent.knowledgeBases` resource is deprecated; |
| 299 | # only use `projects.knowledgeBases`. |
| 300 | "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024 |
| 301 | # bytes or less; otherwise, the creation request fails. |
| 302 | "name": "A String", # The knowledge base resource name. |
| 303 | # The name must be empty when creating a knowledge base. |
| 304 | # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. |
| 305 | }</pre> |
| 306 | </div> |
| 307 | |
| 308 | </body></html> |