Returns the entities Resource.
batchDelete(parent, body=None, x__xgafv=None)
Deletes entity types in the specified agent.
batchUpdate(parent, body=None, x__xgafv=None)
Updates/Creates multiple entity types in the specified agent.
create(parent, body=None, languageCode=None, x__xgafv=None)
Creates an entity type in the specified agent.
Deletes the specified entity type.
get(name, languageCode=None, x__xgafv=None)
Retrieves the specified entity type.
list(parent, languageCode=None, pageToken=None, pageSize=None, x__xgafv=None)
Returns the list of all entity types in the specified agent.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)
Updates the specified entity type.
batchDelete(parent, body=None, x__xgafv=None)
Deletes entity types in the specified agent.
Operation <response: google.protobuf.Empty>
Args:
parent: string, Required. The name of the agent to delete all entities types for. Format:
`projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for EntityTypes.BatchDeleteEntityTypes.
"entityTypeNames": [ # Required. The names entity types to delete. All names must point to the
# same agent as `parent`.
"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.
"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}`.
"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.
"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.
},
],
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"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.
},
"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.
},
}
batchUpdate(parent, body=None, x__xgafv=None)
Updates/Creates multiple entity types in the specified agent.
Operation <response: BatchUpdateEntityTypesResponse>
Args:
parent: string, Required. The name of the agent to update or create entity types in.
Format: `projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for EntityTypes.BatchUpdateEntityTypes.
"entityTypeBatchUri": "A String", # The URI to a Google Cloud Storage file containing entity types to update
# or create. The file format can either be a serialized proto (of
# EntityBatch type) or a JSON object. Note: The URI must start with
# "gs://".
"entityTypeBatchInline": { # This message is a wrapper around a collection of entity types. # The collection of entity types to update or create.
"entityTypes": [ # A collection of entity types.
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
},
],
},
"languageCode": "A String", # Optional. The language used to access language-specific data.
# If not specified, the agent's default language is used.
# For more information, see
# [Multilingual intent and entity
# data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
"updateMask": "A 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:
{ # This resource represents a long-running operation that is the result of a
# network API call.
"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}`.
"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.
"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.
},
],
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"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.
},
"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.
},
}
create(parent, body=None, languageCode=None, x__xgafv=None)
Creates an entity type in the specified agent.
Args:
parent: string, Required. The agent to create a entity type for.
Format: `projects/<Project ID>/agent`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
}
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
}
delete(name, x__xgafv=None)
Deletes the specified entity type.
Args:
name: string, Required. The name of the entity type to delete.
Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`. (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, languageCode=None, x__xgafv=None)
Retrieves the specified entity type.
Args:
name: string, Required. The name of the entity type.
Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`. (required)
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
}
list(parent, languageCode=None, pageToken=None, pageSize=None, x__xgafv=None)
Returns the list of all entity types in the specified agent.
Args:
parent: string, Required. The agent to list all entity types from.
Format: `projects/<Project ID>/agent`. (required)
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
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 EntityTypes.ListEntityTypes.
"entityTypes": [ # The list of agent entity types. There will be a maximum number of items
# returned based on the page_size field in the request.
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
}
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, languageCode=None, updateMask=None, x__xgafv=None)
Updates the specified entity type.
Args:
name: string, The unique identifier of the entity type.
Required for EntityTypes.UpdateEntityType and
EntityTypes.BatchUpdateEntityTypes methods.
Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
}
languageCode: string, Optional. The language used to access language-specific data.
If not specified, the agent's default language is used.
For more information, see
[Multilingual intent and entity
data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
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 an entity type.
# Entity types serve as a tool for extracting parameter values from natural
# language queries.
"entities": [ # Optional. The collection of entity entries associated with the 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",
],
},
],
"name": "A String", # The unique identifier of the entity type.
# Required for EntityTypes.UpdateEntityType and
# EntityTypes.BatchUpdateEntityTypes methods.
# Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
"autoExpansionMode": "A String", # Optional. Indicates whether the entity type can be automatically
# expanded.
"enableFuzzyExtraction": True or False, # Optional. Enables fuzzy entity extraction during classification.
"displayName": "A String", # Required. The name of the entity type.
"kind": "A String", # Required. Indicates the kind of entity type.
}