Skip to content

Commit

Permalink
docs(dialogflow): Update entity documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and quartzmo committed Jan 16, 2020
1 parent aeb3e42 commit d928ff0
Show file tree
Hide file tree
Showing 8 changed files with 217 additions and 23 deletions.
4 changes: 2 additions & 2 deletions google-cloud-dialogflow/lib/google/cloud/dialogflow.rb
Expand Up @@ -259,11 +259,11 @@ module EntityTypes
# data types such as date, time, currency, and so on. A system entity is
# represented by the `EntityType` type.
#
# * **Developer** - entities that are defined by you that represent
# * **Custom** - entities that are defined by you that represent
# actionable data that is meaningful to your application. For example,
# you could define a `pizza.sauce` entity for red or white pizza sauce,
# a `pizza.cheese` entity for the different types of cheese on a pizza,
# a `pizza.topping` entity for different toppings, and so on. A developer
# a `pizza.topping` entity for different toppings, and so on. A custom
# entity is represented by the `EntityType` type.
#
# * **User** - entities that are built for an individual user such as
Expand Down
4 changes: 2 additions & 2 deletions google-cloud-dialogflow/lib/google/cloud/dialogflow/v2.rb
Expand Up @@ -276,11 +276,11 @@ module EntityTypes
# data types such as date, time, currency, and so on. A system entity is
# represented by the `EntityType` type.
#
# * **Developer** - entities that are defined by you that represent
# * **Custom** - entities that are defined by you that represent
# actionable data that is meaningful to your application. For example,
# you could define a `pizza.sauce` entity for red or white pizza sauce,
# a `pizza.cheese` entity for the different types of cheese on a pizza,
# a `pizza.topping` entity for different toppings, and so on. A developer
# a `pizza.topping` entity for different toppings, and so on. A custom
# entity is represented by the `EntityType` type.
#
# * **User** - entities that are built for an individual user such as
Expand Down
Expand Up @@ -102,7 +102,7 @@ module MatchMode
MATCH_MODE_HYBRID = 1

# Can be used for agents with a large number of examples in intents,
# especially the ones using @sys.any or very large developer entities.
# especially the ones using @sys.any or very large custom entities.
MATCH_MODE_ML_ONLY = 2
end

Expand Down
Expand Up @@ -52,7 +52,7 @@ class EntityType
#
# For `KIND_MAP` entity types:
#
# * A canonical value to be used in place of synonyms.
# * A reference value to be used in place of synonyms.
#
# For `KIND_LIST` entity types:
#
Expand Down Expand Up @@ -86,11 +86,11 @@ module Kind
# Not specified. This value should be never used.
KIND_UNSPECIFIED = 0

# Map entity types allow mapping of a group of synonyms to a canonical
# Map entity types allow mapping of a group of synonyms to a reference
# value.
KIND_MAP = 1

# List entity types contain a set of entries that do not map to canonical
# List entity types contain a set of entries that do not map to reference
# values. However, list entity types can contain references to other entity
# types (with or without aliases).
KIND_LIST = 2
Expand Down Expand Up @@ -281,7 +281,7 @@ class BatchUpdateEntitiesRequest; end
# `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
# @!attribute [rw] entity_values
# @return [Array<String>]
# Required. The canonical `values` of the entities to delete. Note that
# Required. The reference `values` of the entities to delete. Note that
# these are not fully-qualified names, i.e. they don't start with
# `projects/<Project ID>`.
# @!attribute [rw] language_code
Expand Down
Expand Up @@ -19,8 +19,8 @@ module Dialogflow
module V2
# Represents a session entity type.
#
# Extends or replaces a developer entity type at the user session level (we
# refer to the entity types defined at the agent level as "developer entity
# 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.
Expand All @@ -35,7 +35,7 @@ module V2
# @!attribute [rw] entity_override_mode
# @return [Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode]
# Required. Indicates whether the additional data should override or
# supplement the developer entity type definition.
# supplement the custom entity type definition.
# @!attribute [rw] entities
# @return [Array<Google::Cloud::Dialogflow::V2::EntityType::Entity>]
# Required. The collection of entities associated with this session entity
Expand All @@ -47,17 +47,17 @@ module EntityOverrideMode
ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0

# The collection of session entities overrides the collection of entities
# in the corresponding developer entity type.
# in the corresponding custom entity type.
ENTITY_OVERRIDE_MODE_OVERRIDE = 1

# The collection of session entities extends the collection of entities in
# the corresponding developer entity type.
# the corresponding custom entity type.
#
# Note: Even in this override mode calls to `ListSessionEntityTypes`,
# `GetSessionEntityType`, `CreateSessionEntityType` and
# `UpdateSessionEntityType` only return the additional entities added in
# this session entity type. If you want to get the supplemented list,
# please call {Google::Cloud::Dialogflow::V2::EntityTypes::GetEntityType EntityTypes::GetEntityType} on the developer entity type
# please call {Google::Cloud::Dialogflow::V2::EntityTypes::GetEntityType EntityTypes::GetEntityType} on the custom entity type
# and merge.
ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
end
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Expand Up @@ -49,11 +49,11 @@ module V2
# data types such as date, time, currency, and so on. A system entity is
# represented by the `EntityType` type.
#
# * **Developer** - entities that are defined by you that represent
# * **Custom** - entities that are defined by you that represent
# actionable data that is meaningful to your application. For example,
# you could define a `pizza.sauce` entity for red or white pizza sauce,
# a `pizza.cheese` entity for the different types of cheese on a pizza,
# a `pizza.topping` entity for different toppings, and so on. A developer
# a `pizza.topping` entity for different toppings, and so on. A custom
# entity is represented by the `EntityType` type.
#
# * **User** - entities that are built for an individual user such as
Expand Down Expand Up @@ -915,7 +915,7 @@ def batch_update_entities \
# Required. The name of the entity type to delete entries for. Format:
# `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
# @param entity_values [Array<String>]
# Required. The canonical `values` of the entities to delete. Note that
# Required. The reference `values` of the entities to delete. Note that
# these are not fully-qualified names, i.e. they don't start with
# `projects/<Project ID>`.
# @param language_code [String]
Expand Down
200 changes: 197 additions & 3 deletions google-cloud-dialogflow/synth.metadata
@@ -1,5 +1,5 @@
{
"updateTime": "2020-01-15T11:42:34.100710Z",
"updateTime": "2020-01-16T11:39:23.051362Z",
"sources": [
{
"generator": {
Expand All @@ -12,8 +12,8 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "d99df0d67057a233c711187e0689baa4f8e6333d",
"internalRef": "289709813"
"sha": "0735b4b096872960568d1f366bfa75b7b0e1f1a3",
"internalRef": "289939042"
}
},
{
Expand All @@ -35,5 +35,199 @@
"config": "google/cloud/dialogflow/v2/artman_dialogflow_v2.yaml"
}
}
],
"newFiles": [
{
"path": ".yardopts"
},
{
"path": "synth.metadata"
},
{
"path": ".repo-metadata.json"
},
{
"path": "synth.py"
},
{
"path": "README.md"
},
{
"path": "LICENSE"
},
{
"path": "google-cloud-dialogflow.gemspec"
},
{
"path": "Gemfile"
},
{
"path": "Rakefile"
},
{
"path": "AUTHENTICATION.md"
},
{
"path": "CHANGELOG.md"
},
{
"path": ".rubocop.yml"
},
{
"path": ".gitignore"
},
{
"path": "test/google/cloud/dialogflow/v2/contexts_client_test.rb"
},
{
"path": "test/google/cloud/dialogflow/v2/intents_client_test.rb"
},
{
"path": "test/google/cloud/dialogflow/v2/sessions_client_test.rb"
},
{
"path": "test/google/cloud/dialogflow/v2/entity_types_client_test.rb"
},
{
"path": "test/google/cloud/dialogflow/v2/agents_client_test.rb"
},
{
"path": "test/google/cloud/dialogflow/v2/session_entity_types_client_test.rb"
},
{
"path": "lib/google/cloud/dialogflow.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2.rb"
},
{
"path": "lib/google/cloud/dialogflow/version.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/audio_config_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/agents_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/context_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/sessions_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/context_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_entity_types_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_entity_types_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/entity_types_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/webhook_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/sessions_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/session_entity_type_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/intents_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/entity_type_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/credentials.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/agent_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/contexts_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/entity_types_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/intent_services_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/contexts_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/agent_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/intent_pb.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/intents_client.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/agents_client_config.json"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/context.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/audio_config.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/protobuf/duration.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/protobuf/any.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/protobuf/struct.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/protobuf/field_mask.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/protobuf/empty.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/longrunning/operations.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/type/latlng.rb"
},
{
"path": "lib/google/cloud/dialogflow/v2/doc/google/rpc/status.rb"
}
]
}

0 comments on commit d928ff0

Please sign in to comment.