# Dialogflow API . projects . agent . sessions . entityTypes

## Instance Methods

Creates a session entity type.

Deletes the specified session entity type.

Retrieves the specified session entity type.

Returns the list of all session entity types in the specified session.

Retrieves the next page of results.

Updates the specified session entity type.

### Method Details

`create(parent, body=None, x__xgafv=None)`

    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:

    { # Represents a session entity type.
        #
        # Extends or replaces a custom entity type at the user session level (we
        # refer to the entity types defined at the agent level as "custom entity
        # types").
        #
        # Note: session entity types apply to all queries, regardless of the language.
      "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.
          "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).
          "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",
          ],
        },
      ],
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents a session entity type.
          #
          # Extends or replaces a custom entity type at the user session level (we
          # refer to the entity types defined at the agent level as "custom entity
          # types").
          #
          # Note: session entity types apply to all queries, regardless of the language.
        "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.
            "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).
            "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",
            ],
          },
        ],
      }

`delete(name, x__xgafv=None)`

    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 `{}`.
      }

`get(name, x__xgafv=None)`

    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:

        { # Represents a session entity type.
          #
          # Extends or replaces a custom entity type at the user session level (we
          # refer to the entity types defined at the agent level as "custom entity
          # types").
          #
          # Note: session entity types apply to all queries, regardless of the language.
        "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.
            "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).
            "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",
            ],
          },
        ],
      }

`list(parent, pageToken=None, pageSize=None, x__xgafv=None)`

    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.
          { # Represents a session entity type.
              #
              # Extends or replaces a custom entity type at the user session level (we
              # refer to the entity types defined at the agent level as "custom entity
              # types").
              #
              # Note: session entity types apply to all queries, regardless of the language.
            "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.
                "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).
                "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",
                ],
              },
            ],
          },
        ],
      }

`list_next(previous_request, previous_response)`

    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.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    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:

    { # Represents a session entity type.
        #
        # Extends or replaces a custom entity type at the user session level (we
        # refer to the entity types defined at the agent level as "custom entity
        # types").
        #
        # Note: session entity types apply to all queries, regardless of the language.
      "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.
          "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).
          "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",
          ],
        },
      ],
    }

      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:

        { # Represents a session entity type.
          #
          # Extends or replaces a custom entity type at the user session level (we
          # refer to the entity types defined at the agent level as "custom entity
          # types").
          #
          # Note: session entity types apply to all queries, regardless of the language.
        "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.
            "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).
            "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",
            ],
          },
        ],
      }