| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a session entity type.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified session entity type.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the specified session entity type.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of all session entity types in the specified session.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the specified session entity type.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a session entity type. |
| |
| If the specified session entity type already exists, overrides the |
| session entity type. |
| |
| This method doesn't work with Google Assistant integration. |
| Contact Dialogflow support if you need to use session entities |
| with Google Assistant integration. |
| |
| Args: |
| parent: string, Required. The session to create a session entity type for. |
| Format: `projects/<Project ID>/agent/sessions/<Session ID>` or |
| `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ |
| sessions/<Session ID>`. If `Environment ID` is not specified, we assume |
| default 'draft' environment. If `User ID` is not specified, we assume |
| default '-' user. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified session entity type. |
| |
| This method doesn't work with Google Assistant integration. |
| Contact Dialogflow support if you need to use session entities |
| with Google Assistant integration. |
| |
| Args: |
| name: string, Required. The name of the entity type to delete. Format: |
| `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| Display Name>` or `projects/<Project ID>/agent/environments/<Environment |
| ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display |
| Name>`. If `Environment ID` is not specified, we assume default 'draft' |
| environment. If `User ID` is not specified, we assume default '-' user. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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 `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Retrieves the specified session entity type. |
| |
| This method doesn't work with Google Assistant integration. |
| Contact Dialogflow support if you need to use session entities |
| with Google Assistant integration. |
| |
| Args: |
| name: string, Required. The name of the session entity type. Format: |
| `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| Display Name>` or `projects/<Project ID>/agent/environments/<Environment |
| ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display |
| Name>`. If `Environment ID` is not specified, we assume default 'draft' |
| environment. If `User ID` is not specified, we assume default '-' user. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| <pre>Returns the list of all session entity types in the specified session. |
| |
| This method doesn't work with Google Assistant integration. |
| Contact Dialogflow support if you need to use session entities |
| with Google Assistant integration. |
| |
| Args: |
| parent: string, Required. The session to list all session entity types from. |
| Format: `projects/<Project ID>/agent/sessions/<Session ID>` or |
| `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ |
| sessions/<Session ID>`. |
| If `Environment ID` is not specified, we assume default 'draft' |
| environment. If `User ID` is not specified, we assume default '-' user. (required) |
| pageToken: string, Optional. The next_page_token value returned from a previous list request. |
| pageSize: integer, Optional. The maximum number of items to return in a single page. By |
| default 100 and at most 1000. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response message for SessionEntityTypes.ListSessionEntityTypes. |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| # more results in the list. |
| "sessionEntityTypes": [ # The list of session entity types. There will be a maximum number of items |
| # returned based on the page_size field in the request. |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the specified session entity type. |
| |
| This method doesn't work with Google Assistant integration. |
| Contact Dialogflow support if you need to use session entities |
| with Google Assistant integration. |
| |
| Args: |
| name: string, Required. The unique identifier of this session entity type. Format: |
| `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| Display Name>`, or |
| `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| If `Environment ID` is not specified, we assume default 'draft' |
| environment. If `User ID` is not specified, we assume default '-' user. |
| |
| `<Entity Type Display Name>` must be the display name of an existing entity |
| type in the same agent that will be overridden or supplemented. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| } |
| |
| updateMask: string, Optional. The mask to control which fields get updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A session represents a conversation between a Dialogflow agent and an |
| # end-user. You can create special entities, called session entities, during a |
| # session. Session entities can extend or replace custom entity types and only |
| # exist during the session that they were created for. All session data, |
| # including session entities, is stored by Dialogflow for 20 minutes. |
| # |
| # For more information, see the [session entity |
| # guide](https://cloud.google.com/dialogflow/docs/entities-session). |
| "name": "A String", # Required. The unique identifier of this session entity type. Format: |
| # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type |
| # Display Name>`, or |
| # `projects/<Project ID>/agent/environments/<Environment ID>/users/<User |
| # ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. |
| # If `Environment ID` is not specified, we assume default 'draft' |
| # environment. If `User ID` is not specified, we assume default '-' user. |
| # |
| # `<Entity Type Display Name>` must be the display name of an existing entity |
| # type in the same agent that will be overridden or supplemented. |
| "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or |
| # supplement the custom entity type definition. |
| "entities": [ # Required. The collection of entities associated with this session entity |
| # type. |
| { # An **entity entry** for an associated entity type. |
| "synonyms": [ # Required. A collection of value synonyms. For example, if the entity type |
| # is *vegetable*, and `value` is *scallions*, a synonym could be *green |
| # onions*. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * This collection must contain exactly one synonym equal to `value`. |
| "A String", |
| ], |
| "value": "A String", # Required. The primary value associated with this entity entry. |
| # For example, if the entity type is *vegetable*, the value could be |
| # *scallions*. |
| # |
| # For `KIND_MAP` entity types: |
| # |
| # * A reference value to be used in place of synonyms. |
| # |
| # For `KIND_LIST` entity types: |
| # |
| # * A string that can contain references to other entity types (with or |
| # without aliases). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
