google-cloud-dialogflow-cx-v3 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +32 -0
- data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +122 -0
- data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +82 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +1051 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +666 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +151 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents.rb +52 -0
- data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +94 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +92 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb +67 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +766 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/paths.rb +75 -0
- data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +117 -0
- data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +61 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +950 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +666 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments/paths.rb +98 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments.rb +52 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +177 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +61 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +851 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiments/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiments/paths.rb +102 -0
- data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +145 -0
- data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +88 -0
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +1200 -0
- data/lib/google/cloud/dialogflow/cx/v3/flows/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +666 -0
- data/lib/google/cloud/dialogflow/cx/v3/flows/paths.rb +184 -0
- data/lib/google/cloud/dialogflow/cx/v3/flows.rb +52 -0
- data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +55 -0
- data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +97 -0
- data/lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb +67 -0
- data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +750 -0
- data/lib/google/cloud/dialogflow/cx/v3/intents/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/intents/paths.rb +96 -0
- data/lib/google/cloud/dialogflow/cx/v3/intents.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +113 -0
- data/lib/google/cloud/dialogflow/cx/v3/page_services_pb.rb +67 -0
- data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +805 -0
- data/lib/google/cloud/dialogflow/cx/v3/pages/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/pages/paths.rb +165 -0
- data/lib/google/cloud/dialogflow/cx/v3/pages.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +77 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb +89 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +696 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/paths.rb +157 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +56 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_pb.rb +68 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +55 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +715 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/paths.rb +137 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +209 -0
- data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +71 -0
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +654 -0
- data/lib/google/cloud/dialogflow/cx/v3/sessions/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/sessions/paths.rb +225 -0
- data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +53 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +302 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +73 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +1324 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +666 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/paths.rb +249 -0
- data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +53 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +67 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +67 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +766 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/paths.rb +144 -0
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +59 -0
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +30 -0
- data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +88 -0
- data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +57 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +792 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +666 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions/paths.rb +79 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions.rb +52 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +172 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhook_services_pb.rb +55 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +704 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/paths.rb +96 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3.rb +53 -0
- data/lib/google-cloud-dialogflow-cx-v3.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +57 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +301 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +322 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +306 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +279 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +438 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +438 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +126 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +318 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +478 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +220 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +222 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +798 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +184 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +757 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +195 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb +121 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +182 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +496 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/latlng.rb +38 -0
- metadata +326 -0
@@ -0,0 +1,306 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dialogflow
|
23
|
+
module CX
|
24
|
+
module V3
|
25
|
+
# Entities are extracted from user input and represent parameters that are
|
26
|
+
# meaningful to your application. For example, a date range, a proper name
|
27
|
+
# such as a geographic location or landmark, and so on. Entities represent
|
28
|
+
# actionable data for your application.
|
29
|
+
#
|
30
|
+
# When you define an entity, you can also include synonyms that all map to
|
31
|
+
# that entity. For example, "soft drink", "soda", "pop", and so on.
|
32
|
+
#
|
33
|
+
# There are three types of entities:
|
34
|
+
#
|
35
|
+
# * **System** - entities that are defined by the Dialogflow API for common
|
36
|
+
# data types such as date, time, currency, and so on. A system entity is
|
37
|
+
# represented by the `EntityType` type.
|
38
|
+
#
|
39
|
+
# * **Custom** - entities that are defined by you that represent
|
40
|
+
# actionable data that is meaningful to your application. For example,
|
41
|
+
# you could define a `pizza.sauce` entity for red or white pizza sauce,
|
42
|
+
# a `pizza.cheese` entity for the different types of cheese on a pizza,
|
43
|
+
# a `pizza.topping` entity for different toppings, and so on. A custom
|
44
|
+
# entity is represented by the `EntityType` type.
|
45
|
+
#
|
46
|
+
# * **User** - entities that are built for an individual user such as
|
47
|
+
# favorites, preferences, playlists, and so on. A user entity is
|
48
|
+
# represented by the {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityType} type.
|
49
|
+
#
|
50
|
+
# For more information about entity types, see the [Dialogflow
|
51
|
+
# documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
|
52
|
+
# @!attribute [rw] name
|
53
|
+
# @return [::String]
|
54
|
+
# The unique identifier of the entity type.
|
55
|
+
# Required for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#update_entity_type EntityTypes.UpdateEntityType}.
|
56
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
57
|
+
# ID>/entityTypes/<Entity Type ID>`.
|
58
|
+
# @!attribute [rw] display_name
|
59
|
+
# @return [::String]
|
60
|
+
# Required. The human-readable name of the entity type, unique within the agent.
|
61
|
+
# @!attribute [rw] kind
|
62
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType::Kind]
|
63
|
+
# Required. Indicates the kind of entity type.
|
64
|
+
# @!attribute [rw] auto_expansion_mode
|
65
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType::AutoExpansionMode]
|
66
|
+
# Indicates whether the entity type can be automatically expanded.
|
67
|
+
# @!attribute [rw] entities
|
68
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>]
|
69
|
+
# The collection of entity entries associated with the entity type.
|
70
|
+
# @!attribute [rw] excluded_phrases
|
71
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>]
|
72
|
+
# Collection of exceptional words and phrases that shouldn't be matched.
|
73
|
+
# For example, if you have a size entity type with entry `giant`(an
|
74
|
+
# adjective), you might consider adding `giants`(a noun) as an exclusion.
|
75
|
+
# If the kind of entity type is `KIND_MAP`, then the phrases specified by
|
76
|
+
# entities and excluded phrases should be mutually exclusive.
|
77
|
+
# @!attribute [rw] enable_fuzzy_extraction
|
78
|
+
# @return [::Boolean]
|
79
|
+
# Enables fuzzy entity extraction during classification.
|
80
|
+
# @!attribute [rw] redact
|
81
|
+
# @return [::Boolean]
|
82
|
+
# Indicates whether parameters of the entity type should be redacted in log.
|
83
|
+
# If redaction is enabled, page parameters and intent parameters referring to
|
84
|
+
# the entity type will be replaced by parameter name when logging.
|
85
|
+
class EntityType
|
86
|
+
include ::Google::Protobuf::MessageExts
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
88
|
+
|
89
|
+
# An **entity entry** for an associated entity type.
|
90
|
+
# @!attribute [rw] value
|
91
|
+
# @return [::String]
|
92
|
+
# Required. The primary value associated with this entity entry.
|
93
|
+
# For example, if the entity type is *vegetable*, the value could be
|
94
|
+
# *scallions*.
|
95
|
+
#
|
96
|
+
# For `KIND_MAP` entity types:
|
97
|
+
#
|
98
|
+
# * A canonical value to be used in place of synonyms.
|
99
|
+
#
|
100
|
+
# For `KIND_LIST` entity types:
|
101
|
+
#
|
102
|
+
# * A string that can contain references to other entity types (with or
|
103
|
+
# without aliases).
|
104
|
+
# @!attribute [rw] synonyms
|
105
|
+
# @return [::Array<::String>]
|
106
|
+
# Required. A collection of value synonyms. For example, if the entity type
|
107
|
+
# is *vegetable*, and `value` is *scallions*, a synonym could be *green
|
108
|
+
# onions*.
|
109
|
+
#
|
110
|
+
# For `KIND_LIST` entity types:
|
111
|
+
#
|
112
|
+
# * This collection must contain exactly one synonym equal to `value`.
|
113
|
+
class Entity
|
114
|
+
include ::Google::Protobuf::MessageExts
|
115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
116
|
+
end
|
117
|
+
|
118
|
+
# An excluded entity phrase that should not be matched.
|
119
|
+
# @!attribute [rw] value
|
120
|
+
# @return [::String]
|
121
|
+
# Required. The word or phrase to be excluded.
|
122
|
+
class ExcludedPhrase
|
123
|
+
include ::Google::Protobuf::MessageExts
|
124
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
125
|
+
end
|
126
|
+
|
127
|
+
# Represents kinds of entities.
|
128
|
+
module Kind
|
129
|
+
# Not specified. This value should be never used.
|
130
|
+
KIND_UNSPECIFIED = 0
|
131
|
+
|
132
|
+
# Map entity types allow mapping of a group of synonyms to a canonical
|
133
|
+
# value.
|
134
|
+
KIND_MAP = 1
|
135
|
+
|
136
|
+
# List entity types contain a set of entries that do not map to canonical
|
137
|
+
# values. However, list entity types can contain references to other entity
|
138
|
+
# types (with or without aliases).
|
139
|
+
KIND_LIST = 2
|
140
|
+
|
141
|
+
# Regexp entity types allow to specify regular expressions in entries
|
142
|
+
# values.
|
143
|
+
KIND_REGEXP = 3
|
144
|
+
end
|
145
|
+
|
146
|
+
# Represents different entity type expansion modes. Automated expansion
|
147
|
+
# allows an agent to recognize values that have not been explicitly listed in
|
148
|
+
# the entity (for example, new kinds of shopping list items).
|
149
|
+
module AutoExpansionMode
|
150
|
+
# Auto expansion disabled for the entity.
|
151
|
+
AUTO_EXPANSION_MODE_UNSPECIFIED = 0
|
152
|
+
|
153
|
+
# Allows an agent to recognize values that have not been explicitly
|
154
|
+
# listed in the entity.
|
155
|
+
AUTO_EXPANSION_MODE_DEFAULT = 1
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#list_entity_types EntityTypes.ListEntityTypes}.
|
160
|
+
# @!attribute [rw] parent
|
161
|
+
# @return [::String]
|
162
|
+
# Required. The agent to list all entity types for.
|
163
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
164
|
+
# @!attribute [rw] language_code
|
165
|
+
# @return [::String]
|
166
|
+
# The language to list entity types for. The following fields are language
|
167
|
+
# dependent:
|
168
|
+
#
|
169
|
+
# * `EntityType.entities.value`
|
170
|
+
# * `EntityType.entities.synonyms`
|
171
|
+
# * `EntityType.excluded_phrases.value`
|
172
|
+
#
|
173
|
+
# If not specified, the agent's default language is used.
|
174
|
+
# [Many
|
175
|
+
# languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
176
|
+
# are supported.
|
177
|
+
# Note: languages must be enabled in the agent before they can be used.
|
178
|
+
# @!attribute [rw] page_size
|
179
|
+
# @return [::Integer]
|
180
|
+
# The maximum number of items to return in a single page. By default 100 and
|
181
|
+
# at most 1000.
|
182
|
+
# @!attribute [rw] page_token
|
183
|
+
# @return [::String]
|
184
|
+
# The next_page_token value returned from a previous list request.
|
185
|
+
class ListEntityTypesRequest
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# The response message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#list_entity_types EntityTypes.ListEntityTypes}.
|
191
|
+
# @!attribute [rw] entity_types
|
192
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType>]
|
193
|
+
# The list of entity types. There will be a maximum number of items returned
|
194
|
+
# based on the page_size field in the request.
|
195
|
+
# @!attribute [rw] next_page_token
|
196
|
+
# @return [::String]
|
197
|
+
# Token to retrieve the next page of results, or empty if there are no
|
198
|
+
# more results in the list.
|
199
|
+
class ListEntityTypesResponse
|
200
|
+
include ::Google::Protobuf::MessageExts
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
|
+
end
|
203
|
+
|
204
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType}.
|
205
|
+
# @!attribute [rw] name
|
206
|
+
# @return [::String]
|
207
|
+
# Required. The name of the entity type.
|
208
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
209
|
+
# ID>/entityTypes/<Entity Type ID>`.
|
210
|
+
# @!attribute [rw] language_code
|
211
|
+
# @return [::String]
|
212
|
+
# The language to retrieve the entity type for. The following fields are
|
213
|
+
# language dependent:
|
214
|
+
#
|
215
|
+
# * `EntityType.entities.value`
|
216
|
+
# * `EntityType.entities.synonyms`
|
217
|
+
# * `EntityType.excluded_phrases.value`
|
218
|
+
#
|
219
|
+
# If not specified, the agent's default language is used.
|
220
|
+
# [Many
|
221
|
+
# languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
222
|
+
# are supported.
|
223
|
+
# Note: languages must be enabled in the agent before they can be used.
|
224
|
+
class GetEntityTypeRequest
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
|
229
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#create_entity_type EntityTypes.CreateEntityType}.
|
230
|
+
# @!attribute [rw] parent
|
231
|
+
# @return [::String]
|
232
|
+
# Required. The agent to create a entity type for.
|
233
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
234
|
+
# @!attribute [rw] entity_type
|
235
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType]
|
236
|
+
# Required. The entity type to create.
|
237
|
+
# @!attribute [rw] language_code
|
238
|
+
# @return [::String]
|
239
|
+
# The language of the following fields in `entity_type`:
|
240
|
+
#
|
241
|
+
# * `EntityType.entities.value`
|
242
|
+
# * `EntityType.entities.synonyms`
|
243
|
+
# * `EntityType.excluded_phrases.value`
|
244
|
+
#
|
245
|
+
# If not specified, the agent's default language is used.
|
246
|
+
# [Many
|
247
|
+
# languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
248
|
+
# are supported.
|
249
|
+
# Note: languages must be enabled in the agent before they can be used.
|
250
|
+
class CreateEntityTypeRequest
|
251
|
+
include ::Google::Protobuf::MessageExts
|
252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
253
|
+
end
|
254
|
+
|
255
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#update_entity_type EntityTypes.UpdateEntityType}.
|
256
|
+
# @!attribute [rw] entity_type
|
257
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::EntityType]
|
258
|
+
# Required. The entity type to update.
|
259
|
+
# @!attribute [rw] language_code
|
260
|
+
# @return [::String]
|
261
|
+
# The language of the following fields in `entity_type`:
|
262
|
+
#
|
263
|
+
# * `EntityType.entities.value`
|
264
|
+
# * `EntityType.entities.synonyms`
|
265
|
+
# * `EntityType.excluded_phrases.value`
|
266
|
+
#
|
267
|
+
# If not specified, the agent's default language is used.
|
268
|
+
# [Many
|
269
|
+
# languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
270
|
+
# are supported.
|
271
|
+
# Note: languages must be enabled in the agent before they can be used.
|
272
|
+
# @!attribute [rw] update_mask
|
273
|
+
# @return [::Google::Protobuf::FieldMask]
|
274
|
+
# The mask to control which fields get updated.
|
275
|
+
class UpdateEntityTypeRequest
|
276
|
+
include ::Google::Protobuf::MessageExts
|
277
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
278
|
+
end
|
279
|
+
|
280
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#delete_entity_type EntityTypes.DeleteEntityType}.
|
281
|
+
# @!attribute [rw] name
|
282
|
+
# @return [::String]
|
283
|
+
# Required. The name of the entity type to delete.
|
284
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
285
|
+
# ID>/entityTypes/<Entity Type ID>`.
|
286
|
+
# @!attribute [rw] force
|
287
|
+
# @return [::Boolean]
|
288
|
+
# This field has no effect for entity type not being used.
|
289
|
+
# For entity types that are used by intents or pages:
|
290
|
+
#
|
291
|
+
# * If `force` is set to false, an error will be returned with message
|
292
|
+
# indicating the referencing resources.
|
293
|
+
# * If `force` is set to true, Dialogflow will remove the entity type, as
|
294
|
+
# well as any references to the entity type (i.e. Page
|
295
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity type will be changed to
|
296
|
+
# '@sys.any' and intent {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} of the entity type
|
297
|
+
# will be removed).
|
298
|
+
class DeleteEntityTypeRequest
|
299
|
+
include ::Google::Protobuf::MessageExts
|
300
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
301
|
+
end
|
302
|
+
end
|
303
|
+
end
|
304
|
+
end
|
305
|
+
end
|
306
|
+
end
|
@@ -0,0 +1,279 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dialogflow
|
23
|
+
module CX
|
24
|
+
module V3
|
25
|
+
# Represents an environment for an agent. You can create multiple versions
|
26
|
+
# of your agent and publish them to separate environments. When you edit an
|
27
|
+
# agent, you are editing the draft agent. At any point, you can save the draft
|
28
|
+
# agent as an agent version, which is an immutable snapshot of your agent. When
|
29
|
+
# you save the draft agent, it is published to the default environment. When
|
30
|
+
# you create agent versions, you can publish them to custom environments. You
|
31
|
+
# can create a variety of custom environments for testing, development,
|
32
|
+
# production, etc.
|
33
|
+
# @!attribute [rw] name
|
34
|
+
# @return [::String]
|
35
|
+
# The name of the environment.
|
36
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
37
|
+
# ID>/environments/<Environment ID>`.
|
38
|
+
# @!attribute [rw] display_name
|
39
|
+
# @return [::String]
|
40
|
+
# Required. The human-readable name of the environment (unique in an agent). Limit of
|
41
|
+
# 64 characters.
|
42
|
+
# @!attribute [rw] description
|
43
|
+
# @return [::String]
|
44
|
+
# The human-readable description of the environment. The maximum length is
|
45
|
+
# 500 characters. If exceeded, the request is rejected.
|
46
|
+
# @!attribute [rw] version_configs
|
47
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>]
|
48
|
+
# Required. A list of configurations for flow versions. You should include version
|
49
|
+
# configs for all flows that are reachable from [`Start
|
50
|
+
# Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
|
51
|
+
# returned.
|
52
|
+
# @!attribute [r] update_time
|
53
|
+
# @return [::Google::Protobuf::Timestamp]
|
54
|
+
# Output only. Update time of this environment.
|
55
|
+
class Environment
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
|
59
|
+
# Configuration for the version.
|
60
|
+
# @!attribute [rw] version
|
61
|
+
# @return [::String]
|
62
|
+
# Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
63
|
+
# ID>/flows/<Flow ID>/versions/<Version ID>.
|
64
|
+
class VersionConfig
|
65
|
+
include ::Google::Protobuf::MessageExts
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
|
71
|
+
# @!attribute [rw] parent
|
72
|
+
# @return [::String]
|
73
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to list all environments for.
|
74
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
75
|
+
# @!attribute [rw] page_size
|
76
|
+
# @return [::Integer]
|
77
|
+
# The maximum number of items to return in a single page. By default 20 and
|
78
|
+
# at most 100.
|
79
|
+
# @!attribute [rw] page_token
|
80
|
+
# @return [::String]
|
81
|
+
# The next_page_token value returned from a previous list request.
|
82
|
+
class ListEnvironmentsRequest
|
83
|
+
include ::Google::Protobuf::MessageExts
|
84
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
85
|
+
end
|
86
|
+
|
87
|
+
# The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
|
88
|
+
# @!attribute [rw] environments
|
89
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment>]
|
90
|
+
# The list of environments. There will be a maximum number of items
|
91
|
+
# returned based on the page_size field in the request. The list may in some
|
92
|
+
# cases be empty or contain fewer entries than page_size even if this isn't
|
93
|
+
# the last page.
|
94
|
+
# @!attribute [rw] next_page_token
|
95
|
+
# @return [::String]
|
96
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
97
|
+
# results in the list.
|
98
|
+
class ListEnvironmentsResponse
|
99
|
+
include ::Google::Protobuf::MessageExts
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
end
|
102
|
+
|
103
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#get_environment Environments.GetEnvironment}.
|
104
|
+
# @!attribute [rw] name
|
105
|
+
# @return [::String]
|
106
|
+
# Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
|
107
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
108
|
+
# ID>/environments/<Environment ID>`.
|
109
|
+
class GetEnvironmentRequest
|
110
|
+
include ::Google::Protobuf::MessageExts
|
111
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
112
|
+
end
|
113
|
+
|
114
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#create_environment Environments.CreateEnvironment}.
|
115
|
+
# @!attribute [rw] parent
|
116
|
+
# @return [::String]
|
117
|
+
# Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for.
|
118
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
|
119
|
+
# @!attribute [rw] environment
|
120
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
|
121
|
+
# Required. The environment to create.
|
122
|
+
class CreateEnvironmentRequest
|
123
|
+
include ::Google::Protobuf::MessageExts
|
124
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
125
|
+
end
|
126
|
+
|
127
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#update_environment Environments.UpdateEnvironment}.
|
128
|
+
# @!attribute [rw] environment
|
129
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
|
130
|
+
# Required. The environment to update.
|
131
|
+
# @!attribute [rw] update_mask
|
132
|
+
# @return [::Google::Protobuf::FieldMask]
|
133
|
+
# Required. The mask to control which fields get updated.
|
134
|
+
class UpdateEnvironmentRequest
|
135
|
+
include ::Google::Protobuf::MessageExts
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
137
|
+
end
|
138
|
+
|
139
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#delete_environment Environments.DeleteEnvironment}.
|
140
|
+
# @!attribute [rw] name
|
141
|
+
# @return [::String]
|
142
|
+
# Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete.
|
143
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
144
|
+
# ID>/environments/<Environment ID>`.
|
145
|
+
class DeleteEnvironmentRequest
|
146
|
+
include ::Google::Protobuf::MessageExts
|
147
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
148
|
+
end
|
149
|
+
|
150
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
|
151
|
+
# @!attribute [rw] name
|
152
|
+
# @return [::String]
|
153
|
+
# Required. Resource name of the environment to look up the history for.
|
154
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
155
|
+
# ID>/environments/<Environment ID>`.
|
156
|
+
# @!attribute [rw] page_size
|
157
|
+
# @return [::Integer]
|
158
|
+
# The maximum number of items to return in a single page. By default 100 and
|
159
|
+
# at most 1000.
|
160
|
+
# @!attribute [rw] page_token
|
161
|
+
# @return [::String]
|
162
|
+
# The next_page_token value returned from a previous list request.
|
163
|
+
class LookupEnvironmentHistoryRequest
|
164
|
+
include ::Google::Protobuf::MessageExts
|
165
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
166
|
+
end
|
167
|
+
|
168
|
+
# The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#lookup_environment_history Environments.LookupEnvironmentHistory}.
|
169
|
+
# @!attribute [rw] environments
|
170
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment>]
|
171
|
+
# Represents a list of snapshots for an environment. Time of the snapshots is
|
172
|
+
# stored in {::Google::Cloud::Dialogflow::CX::V3::Environment#update_time `update_time`}.
|
173
|
+
# @!attribute [rw] next_page_token
|
174
|
+
# @return [::String]
|
175
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
176
|
+
# results in the list.
|
177
|
+
class LookupEnvironmentHistoryResponse
|
178
|
+
include ::Google::Protobuf::MessageExts
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
|
+
end
|
181
|
+
|
182
|
+
# Represents a result from running a test case in an agent environment.
|
183
|
+
# @!attribute [rw] name
|
184
|
+
# @return [::String]
|
185
|
+
# The resource name for the continuous test result. Format:
|
186
|
+
# `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
187
|
+
# ID>/environments/<Environment
|
188
|
+
# ID>/continuousTestResults/<ContinuousTestResult ID>`.
|
189
|
+
# @!attribute [rw] result
|
190
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult::AggregatedTestResult]
|
191
|
+
# The result of this continuous test run, i.e. whether all the tests in this
|
192
|
+
# continuous test run pass or not.
|
193
|
+
# @!attribute [rw] test_case_results
|
194
|
+
# @return [::Array<::String>]
|
195
|
+
# A list of individual test case results names in this continuous test run.
|
196
|
+
# @!attribute [rw] run_time
|
197
|
+
# @return [::Google::Protobuf::Timestamp]
|
198
|
+
# Time when the continuous testing run starts.
|
199
|
+
class ContinuousTestResult
|
200
|
+
include ::Google::Protobuf::MessageExts
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
|
+
|
203
|
+
# The overall result for a continuous test run in an agent environment.
|
204
|
+
module AggregatedTestResult
|
205
|
+
# Not specified. Should never be used.
|
206
|
+
AGGREGATED_TEST_RESULT_UNSPECIFIED = 0
|
207
|
+
|
208
|
+
# All the tests passed.
|
209
|
+
PASSED = 1
|
210
|
+
|
211
|
+
# At least one test did not pass.
|
212
|
+
FAILED = 2
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
|
217
|
+
# @!attribute [rw] environment
|
218
|
+
# @return [::String]
|
219
|
+
# Required. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
220
|
+
# ID>/environments/<Environment ID>`.
|
221
|
+
class RunContinuousTestRequest
|
222
|
+
include ::Google::Protobuf::MessageExts
|
223
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
224
|
+
end
|
225
|
+
|
226
|
+
# The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest}.
|
227
|
+
# @!attribute [rw] continuous_test_result
|
228
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult]
|
229
|
+
# The result for a continuous test run.
|
230
|
+
class RunContinuousTestResponse
|
231
|
+
include ::Google::Protobuf::MessageExts
|
232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
233
|
+
end
|
234
|
+
|
235
|
+
# Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#run_continuous_test Environments.RunContinuousTest} long running
|
236
|
+
# operation.
|
237
|
+
# @!attribute [rw] errors
|
238
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestError>]
|
239
|
+
# The test errors.
|
240
|
+
class RunContinuousTestMetadata
|
241
|
+
include ::Google::Protobuf::MessageExts
|
242
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
end
|
244
|
+
|
245
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_continuous_test_results Environments.ListContinuousTestResults}.
|
246
|
+
# @!attribute [rw] parent
|
247
|
+
# @return [::String]
|
248
|
+
# Required. The environment to list results for.
|
249
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
|
250
|
+
# environments/<Environment ID>`.
|
251
|
+
# @!attribute [rw] page_size
|
252
|
+
# @return [::Integer]
|
253
|
+
# The maximum number of items to return in a single page. By default 100 and
|
254
|
+
# at most 1000.
|
255
|
+
# @!attribute [rw] page_token
|
256
|
+
# @return [::String]
|
257
|
+
# The next_page_token value returned from a previous list request.
|
258
|
+
class ListContinuousTestResultsRequest
|
259
|
+
include ::Google::Protobuf::MessageExts
|
260
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
261
|
+
end
|
262
|
+
|
263
|
+
# The response message for [Environments.ListTestCaseResults][].
|
264
|
+
# @!attribute [rw] continuous_test_results
|
265
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ContinuousTestResult>]
|
266
|
+
# The list of continuous test results.
|
267
|
+
# @!attribute [rw] next_page_token
|
268
|
+
# @return [::String]
|
269
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
270
|
+
# results in the list.
|
271
|
+
class ListContinuousTestResultsResponse
|
272
|
+
include ::Google::Protobuf::MessageExts
|
273
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
274
|
+
end
|
275
|
+
end
|
276
|
+
end
|
277
|
+
end
|
278
|
+
end
|
279
|
+
end
|