# Dialogflow API . projects . agent . entityTypes . entities

## Instance Methods

Creates multiple new entities in the specified entity type.

Deletes entities in the specified entity type.

Updates or creates multiple entities in the specified entity type. This

### Method Details

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

    Creates multiple new entities in the specified entity type.

    Operation

    Args:
      parent: string, Required. The name of the entity type to create entities in. Format:
    `projects//agent/entityTypes/`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request message for EntityTypes.BatchCreateEntities.
        "entities": [ # Required. The entities to create.
          { # 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 canonical 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).
          },
        ],
        "languageCode": "A String", # Optional. The language of entity synonyms defined in `entities`. If not
            # specified, the agent's default language is used.
            # [Many
            # languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
            # are supported. Note: languages must be enabled in the agent before they can
            # be used.
      }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
      }

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

    Deletes entities in the specified entity type.

    Operation

    Args:
      parent: string, Required. The name of the entity type to delete entries for. Format:
    `projects//agent/entityTypes/`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request message for EntityTypes.BatchDeleteEntities.
        "languageCode": "A String", # Optional. The language of entity synonyms defined in `entities`. If not
            # specified, the agent's default language is used.
            # [Many
            # languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
            # are supported. Note: languages must be enabled in the agent before they can
            # be used.
        "entityValues": [ # Required. The canonical `values` of the entities to delete. Note that
            # these are not fully-qualified names, i.e. they don't start with
            # `projects/`.
          "A String",
        ],
      }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
      }

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

    Updates or creates multiple entities in the specified entity type. This
    method does not affect entities in the entity type that aren't explicitly
    specified in the request.

    Operation

    Args:
      parent: string, Required. The name of the entity type to update or create entities in.
    Format: `projects//agent/entityTypes/`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request message for EntityTypes.BatchUpdateEntities.
        "entities": [ # Required. The entities to update or create.
          { # 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 canonical 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": "A String", # Optional. The mask to control which fields get updated.
        "languageCode": "A String", # Optional. The language of entity synonyms defined in `entities`. If not
            # specified, the agent's default language is used.
            # [Many
            # languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language)
            # are supported. Note: languages must be enabled in the agent before they can
            # be used.
      }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
      }