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