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.sessions.html">sessions</a> . <a href="dialogflow_v2.projects.agent.sessions.entityTypes.html">entityTypes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a session entity type.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified session entity type.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves the specified session entity type.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns the list of all session entity types in the specified session.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates the specified session entity type.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 98 <pre>Creates a session entity type. 99 100If the specified session entity type already exists, overrides the session 101entity type. 102 103Args: 104 parent: string, Required. The session to create a session entity type for. 105Format: `projects/<Project ID>/agent/sessions/<Session ID>`. (required) 106 body: object, The request body. (required) 107 The object takes the form of: 108 109{ # Represents a session entity type. 110 # 111 # Extends or replaces a developer entity type at the user session level (we 112 # refer to the entity types defined at the agent level as "developer entity 113 # types"). 114 # 115 # Note: session entity types apply to all queries, regardless of the language. 116 "entities": [ # Required. The collection of entities associated with this session entity 117 # type. 118 { # An **entity entry** for an associated entity type. 119 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 120 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 121 # onions*. 122 # 123 # For `KIND_LIST` entity types: 124 # 125 # * This collection must contain exactly one synonym equal to `value`. 126 "A String", 127 ], 128 "value": "A String", # Required. The primary value associated with this entity entry. 129 # For example, if the entity type is *vegetable*, the value could be 130 # *scallions*. 131 # 132 # For `KIND_MAP` entity types: 133 # 134 # * A canonical value to be used in place of synonyms. 135 # 136 # For `KIND_LIST` entity types: 137 # 138 # * A string that can contain references to other entity types (with or 139 # without aliases). 140 }, 141 ], 142 "name": "A String", # Required. The unique identifier of this session entity type. Format: 143 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 144 # Display Name>`. 145 # 146 # `<Entity Type Display Name>` must be the display name of an existing entity 147 # type in the same agent that will be overridden or supplemented. 148 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 149 # supplement the developer entity type definition. 150} 151 152 x__xgafv: string, V1 error format. 153 Allowed values 154 1 - v1 error format 155 2 - v2 error format 156 157Returns: 158 An object of the form: 159 160 { # Represents a session entity type. 161 # 162 # Extends or replaces a developer entity type at the user session level (we 163 # refer to the entity types defined at the agent level as "developer entity 164 # types"). 165 # 166 # Note: session entity types apply to all queries, regardless of the language. 167 "entities": [ # Required. The collection of entities associated with this session entity 168 # type. 169 { # An **entity entry** for an associated entity type. 170 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 171 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 172 # onions*. 173 # 174 # For `KIND_LIST` entity types: 175 # 176 # * This collection must contain exactly one synonym equal to `value`. 177 "A String", 178 ], 179 "value": "A String", # Required. The primary value associated with this entity entry. 180 # For example, if the entity type is *vegetable*, the value could be 181 # *scallions*. 182 # 183 # For `KIND_MAP` entity types: 184 # 185 # * A canonical value to be used in place of synonyms. 186 # 187 # For `KIND_LIST` entity types: 188 # 189 # * A string that can contain references to other entity types (with or 190 # without aliases). 191 }, 192 ], 193 "name": "A String", # Required. The unique identifier of this session entity type. Format: 194 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 195 # Display Name>`. 196 # 197 # `<Entity Type Display Name>` must be the display name of an existing entity 198 # type in the same agent that will be overridden or supplemented. 199 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 200 # supplement the developer entity type definition. 201 }</pre> 202</div> 203 204<div class="method"> 205 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 206 <pre>Deletes the specified session entity type. 207 208Args: 209 name: string, Required. The name of the entity type to delete. Format: 210`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 211Display Name>`. (required) 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { # A generic empty message that you can re-use to avoid defining duplicated 221 # empty messages in your APIs. A typical example is to use it as the request 222 # or the response type of an API method. For instance: 223 # 224 # service Foo { 225 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 226 # } 227 # 228 # The JSON representation for `Empty` is empty JSON object `{}`. 229 }</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="get">get(name, x__xgafv=None)</code> 234 <pre>Retrieves the specified session entity type. 235 236Args: 237 name: string, Required. The name of the session entity type. Format: 238`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 239Display Name>`. (required) 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { # Represents a session entity type. 249 # 250 # Extends or replaces a developer entity type at the user session level (we 251 # refer to the entity types defined at the agent level as "developer entity 252 # types"). 253 # 254 # Note: session entity types apply to all queries, regardless of the language. 255 "entities": [ # Required. The collection of entities associated with this session entity 256 # type. 257 { # An **entity entry** for an associated entity type. 258 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 259 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 260 # onions*. 261 # 262 # For `KIND_LIST` entity types: 263 # 264 # * This collection must contain exactly one synonym equal to `value`. 265 "A String", 266 ], 267 "value": "A String", # Required. The primary value associated with this entity entry. 268 # For example, if the entity type is *vegetable*, the value could be 269 # *scallions*. 270 # 271 # For `KIND_MAP` entity types: 272 # 273 # * A canonical value to be used in place of synonyms. 274 # 275 # For `KIND_LIST` entity types: 276 # 277 # * A string that can contain references to other entity types (with or 278 # without aliases). 279 }, 280 ], 281 "name": "A String", # Required. The unique identifier of this session entity type. Format: 282 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 283 # Display Name>`. 284 # 285 # `<Entity Type Display Name>` must be the display name of an existing entity 286 # type in the same agent that will be overridden or supplemented. 287 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 288 # supplement the developer entity type definition. 289 }</pre> 290</div> 291 292<div class="method"> 293 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 294 <pre>Returns the list of all session entity types in the specified session. 295 296Args: 297 parent: string, Required. The session to list all session entity types from. 298Format: `projects/<Project ID>/agent/sessions/<Session ID>`. (required) 299 pageSize: integer, Optional. The maximum number of items to return in a single page. By 300default 100 and at most 1000. 301 pageToken: string, Optional. The next_page_token value returned from a previous list request. 302 x__xgafv: string, V1 error format. 303 Allowed values 304 1 - v1 error format 305 2 - v2 error format 306 307Returns: 308 An object of the form: 309 310 { # The response message for SessionEntityTypes.ListSessionEntityTypes. 311 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no 312 # more results in the list. 313 "sessionEntityTypes": [ # The list of session entity types. There will be a maximum number of items 314 # returned based on the page_size field in the request. 315 { # Represents a session entity type. 316 # 317 # Extends or replaces a developer entity type at the user session level (we 318 # refer to the entity types defined at the agent level as "developer entity 319 # types"). 320 # 321 # Note: session entity types apply to all queries, regardless of the language. 322 "entities": [ # Required. The collection of entities associated with this session entity 323 # type. 324 { # An **entity entry** for an associated entity type. 325 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 326 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 327 # onions*. 328 # 329 # For `KIND_LIST` entity types: 330 # 331 # * This collection must contain exactly one synonym equal to `value`. 332 "A String", 333 ], 334 "value": "A String", # Required. The primary value associated with this entity entry. 335 # For example, if the entity type is *vegetable*, the value could be 336 # *scallions*. 337 # 338 # For `KIND_MAP` entity types: 339 # 340 # * A canonical value to be used in place of synonyms. 341 # 342 # For `KIND_LIST` entity types: 343 # 344 # * A string that can contain references to other entity types (with or 345 # without aliases). 346 }, 347 ], 348 "name": "A String", # Required. The unique identifier of this session entity type. Format: 349 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 350 # Display Name>`. 351 # 352 # `<Entity Type Display Name>` must be the display name of an existing entity 353 # type in the same agent that will be overridden or supplemented. 354 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 355 # supplement the developer entity type definition. 356 }, 357 ], 358 }</pre> 359</div> 360 361<div class="method"> 362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 363 <pre>Retrieves the next page of results. 364 365Args: 366 previous_request: The request for the previous page. (required) 367 previous_response: The response from the request for the previous page. (required) 368 369Returns: 370 A request object that you can call 'execute()' on to request the next 371 page. Returns None if there are no more items in the collection. 372 </pre> 373</div> 374 375<div class="method"> 376 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 377 <pre>Updates the specified session entity type. 378 379Args: 380 name: string, Required. The unique identifier of this session entity type. Format: 381`projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 382Display Name>`. 383 384`<Entity Type Display Name>` must be the display name of an existing entity 385type in the same agent that will be overridden or supplemented. (required) 386 body: object, The request body. (required) 387 The object takes the form of: 388 389{ # Represents a session entity type. 390 # 391 # Extends or replaces a developer entity type at the user session level (we 392 # refer to the entity types defined at the agent level as "developer entity 393 # types"). 394 # 395 # Note: session entity types apply to all queries, regardless of the language. 396 "entities": [ # Required. The collection of entities associated with this session entity 397 # type. 398 { # An **entity entry** for an associated entity type. 399 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 400 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 401 # onions*. 402 # 403 # For `KIND_LIST` entity types: 404 # 405 # * This collection must contain exactly one synonym equal to `value`. 406 "A String", 407 ], 408 "value": "A String", # Required. The primary value associated with this entity entry. 409 # For example, if the entity type is *vegetable*, the value could be 410 # *scallions*. 411 # 412 # For `KIND_MAP` entity types: 413 # 414 # * A canonical value to be used in place of synonyms. 415 # 416 # For `KIND_LIST` entity types: 417 # 418 # * A string that can contain references to other entity types (with or 419 # without aliases). 420 }, 421 ], 422 "name": "A String", # Required. The unique identifier of this session entity type. Format: 423 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 424 # Display Name>`. 425 # 426 # `<Entity Type Display Name>` must be the display name of an existing entity 427 # type in the same agent that will be overridden or supplemented. 428 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 429 # supplement the developer entity type definition. 430} 431 432 updateMask: string, Optional. The mask to control which fields get updated. 433 x__xgafv: string, V1 error format. 434 Allowed values 435 1 - v1 error format 436 2 - v2 error format 437 438Returns: 439 An object of the form: 440 441 { # Represents a session entity type. 442 # 443 # Extends or replaces a developer entity type at the user session level (we 444 # refer to the entity types defined at the agent level as "developer entity 445 # types"). 446 # 447 # Note: session entity types apply to all queries, regardless of the language. 448 "entities": [ # Required. The collection of entities associated with this session entity 449 # type. 450 { # An **entity entry** for an associated entity type. 451 "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type 452 # is *vegetable*, and `value` is *scallions*, a synonym could be *green 453 # onions*. 454 # 455 # For `KIND_LIST` entity types: 456 # 457 # * This collection must contain exactly one synonym equal to `value`. 458 "A String", 459 ], 460 "value": "A String", # Required. The primary value associated with this entity entry. 461 # For example, if the entity type is *vegetable*, the value could be 462 # *scallions*. 463 # 464 # For `KIND_MAP` entity types: 465 # 466 # * A canonical value to be used in place of synonyms. 467 # 468 # For `KIND_LIST` entity types: 469 # 470 # * A string that can contain references to other entity types (with or 471 # without aliases). 472 }, 473 ], 474 "name": "A String", # Required. The unique identifier of this session entity type. Format: 475 # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type 476 # Display Name>`. 477 # 478 # `<Entity Type Display Name>` must be the display name of an existing entity 479 # type in the same agent that will be overridden or supplemented. 480 "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or 481 # supplement the developer entity type definition. 482 }</pre> 483</div> 484 485</body></html>