google-cloud-dialogflow-cx-v3 1.1.1 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +44 -25
- data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +44 -25
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +102 -68
- data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +32 -6
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +32 -6
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +32 -8
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +32 -8
- data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +30 -14
- data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +50 -27
- data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +50 -27
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +86 -56
- data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +38 -21
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +38 -21
- data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +94 -62
- data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +2 -1
- data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +41 -19
- data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +41 -19
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +37 -14
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +37 -14
- data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +54 -29
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +54 -29
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +5 -1
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +40 -16
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +40 -14
- data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +47 -26
- data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +59 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +59 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/service_stub.rb +110 -74
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +43 -21
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +54 -32
- data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +44 -22
- data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +12 -15
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +44 -22
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +43 -38
- data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +70 -44
- data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +35 -12
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +54 -32
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +1 -1
- data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -20
- data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +6 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +5 -5
- data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +11 -13
- data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +16 -17
- data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +26 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +15 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +28 -27
- data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +2 -2
- data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +2 -2
- data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +41 -8
- data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +19 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +33 -33
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +2 -1
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +14 -14
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +107 -22
- data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +30 -28
- data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +41 -43
- data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +16 -18
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +19 -19
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +24 -25
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +5 -5
@@ -91,9 +91,10 @@ module Google
|
|
91
91
|
# @!attribute [rw] session
|
92
92
|
# @return [::String]
|
93
93
|
# Required. The name of the session this query is sent to.
|
94
|
-
# Format:
|
95
|
-
#
|
96
|
-
# ID
|
94
|
+
# Format:
|
95
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session
|
96
|
+
# ID>` or
|
97
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
|
97
98
|
# If `Environment ID` is not specified, we assume default 'draft'
|
98
99
|
# environment.
|
99
100
|
# It's up to the API caller to choose an appropriate `Session ID`. It can be
|
@@ -207,9 +208,10 @@ module Google
|
|
207
208
|
# @!attribute [rw] session
|
208
209
|
# @return [::String]
|
209
210
|
# The name of the session this query is sent to.
|
210
|
-
# Format:
|
211
|
-
#
|
212
|
-
#
|
211
|
+
# Format:
|
212
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
|
213
|
+
# or
|
214
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
|
213
215
|
# If `Environment ID` is not specified, we assume default 'draft'
|
214
216
|
# environment.
|
215
217
|
# It's up to the API caller to choose an appropriate `Session ID`. It can be
|
@@ -522,8 +524,8 @@ module Google
|
|
522
524
|
# @return [::String]
|
523
525
|
# The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::Page page} to
|
524
526
|
# override the [current page][QueryResult.current_page] in the session.
|
525
|
-
# Format:
|
526
|
-
#
|
527
|
+
# Format:
|
528
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
|
527
529
|
#
|
528
530
|
# If `current_page` is specified, the previous state of the session will be
|
529
531
|
# ignored by Dialogflow, including the [previous
|
@@ -553,8 +555,8 @@ module Google
|
|
553
555
|
# @!attribute [rw] flow_versions
|
554
556
|
# @return [::Array<::String>]
|
555
557
|
# A list of flow versions to override for the request.
|
556
|
-
# Format:
|
557
|
-
#
|
558
|
+
# Format:
|
559
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
|
558
560
|
#
|
559
561
|
# If version 1 of flow X is included in this list, the traffic of
|
560
562
|
# flow X will go through version 1 regardless of the version configuration in
|
@@ -679,9 +681,93 @@ module Google
|
|
679
681
|
#
|
680
682
|
# Setting to 0.0 means no boost applied. The boosting condition is
|
681
683
|
# ignored.
|
684
|
+
# @!attribute [rw] boost_control_spec
|
685
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec]
|
686
|
+
# Optional. Complex specification for custom ranking based on customer
|
687
|
+
# defined attribute value.
|
682
688
|
class ConditionBoostSpec
|
683
689
|
include ::Google::Protobuf::MessageExts
|
684
690
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
691
|
+
|
692
|
+
# Specification for custom ranking based on customer specified attribute
|
693
|
+
# value. It provides more controls for customized ranking than the simple
|
694
|
+
# (condition, boost) combination above.
|
695
|
+
# @!attribute [rw] field_name
|
696
|
+
# @return [::String]
|
697
|
+
# Optional. The name of the field whose value will be used to determine
|
698
|
+
# the boost amount.
|
699
|
+
# @!attribute [rw] attribute_type
|
700
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
|
701
|
+
# Optional. The attribute type to be used to determine the boost amount.
|
702
|
+
# The attribute value can be derived from the field value of the
|
703
|
+
# specified field_name. In the case of numerical it is straightforward
|
704
|
+
# i.e. attribute_value = numerical_field_value. In the case of freshness
|
705
|
+
# however, attribute_value = (time.now() - datetime_field_value).
|
706
|
+
# @!attribute [rw] interpolation_type
|
707
|
+
# @return [::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
|
708
|
+
# Optional. The interpolation type to be applied to connect the control
|
709
|
+
# points listed below.
|
710
|
+
# @!attribute [rw] control_points
|
711
|
+
# @return [::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
|
712
|
+
# Optional. The control points used to define the curve. The monotonic
|
713
|
+
# function (defined through the interpolation_type above) passes through
|
714
|
+
# the control points listed here.
|
715
|
+
class BoostControlSpec
|
716
|
+
include ::Google::Protobuf::MessageExts
|
717
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
718
|
+
|
719
|
+
# The control points used to define the curve. The curve defined
|
720
|
+
# through these control points can only be monotonically increasing
|
721
|
+
# or decreasing(constant values are acceptable).
|
722
|
+
# @!attribute [rw] attribute_value
|
723
|
+
# @return [::String]
|
724
|
+
# Optional. Can be one of:
|
725
|
+
# 1. The numerical field value.
|
726
|
+
# 2. The duration spec for freshness:
|
727
|
+
# The value must be formatted as an XSD `dayTimeDuration` value (a
|
728
|
+
# restricted subset of an ISO 8601 duration value). The pattern for
|
729
|
+
# this is: `[nD][T[nH][nM][nS]]`.
|
730
|
+
# @!attribute [rw] boost_amount
|
731
|
+
# @return [::Float]
|
732
|
+
# Optional. The value between -1 to 1 by which to boost the score if
|
733
|
+
# the attribute_value evaluates to the value specified above.
|
734
|
+
class ControlPoint
|
735
|
+
include ::Google::Protobuf::MessageExts
|
736
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
737
|
+
end
|
738
|
+
|
739
|
+
# The attribute(or function) for which the custom ranking is to be
|
740
|
+
# applied.
|
741
|
+
module AttributeType
|
742
|
+
# Unspecified AttributeType.
|
743
|
+
ATTRIBUTE_TYPE_UNSPECIFIED = 0
|
744
|
+
|
745
|
+
# The value of the numerical field will be used to dynamically update
|
746
|
+
# the boost amount. In this case, the attribute_value (the x value)
|
747
|
+
# of the control point will be the actual value of the numerical
|
748
|
+
# field for which the boost_amount is specified.
|
749
|
+
NUMERICAL = 1
|
750
|
+
|
751
|
+
# For the freshness use case the attribute value will be the duration
|
752
|
+
# between the current time and the date in the datetime field
|
753
|
+
# specified. The value must be formatted as an XSD `dayTimeDuration`
|
754
|
+
# value (a restricted subset of an ISO 8601 duration value). The
|
755
|
+
# pattern for this is: `[nD][T[nH][nM][nS]]`.
|
756
|
+
# E.g. `5D`, `3DT12H30M`, `T24H`.
|
757
|
+
FRESHNESS = 2
|
758
|
+
end
|
759
|
+
|
760
|
+
# The interpolation type to be applied. Default will be linear
|
761
|
+
# (Piecewise Linear).
|
762
|
+
module InterpolationType
|
763
|
+
# Interpolation type is unspecified. In this case, it defaults to
|
764
|
+
# Linear.
|
765
|
+
INTERPOLATION_TYPE_UNSPECIFIED = 0
|
766
|
+
|
767
|
+
# Piecewise linear interpolation will be applied.
|
768
|
+
LINEAR = 1
|
769
|
+
end
|
770
|
+
end
|
685
771
|
end
|
686
772
|
end
|
687
773
|
|
@@ -765,8 +851,7 @@ module Google
|
|
765
851
|
# @return [::String]
|
766
852
|
# If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
|
767
853
|
# input, this field will contain a copy of the intent identifier. Format:
|
768
|
-
# `projects/<
|
769
|
-
# ID>/intents/<Intent ID>`.
|
854
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
|
770
855
|
# @!attribute [rw] transcript
|
771
856
|
# @return [::String]
|
772
857
|
# If [natural language speech
|
@@ -904,8 +989,8 @@ module Google
|
|
904
989
|
# @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals]
|
905
990
|
# Optional. Data store connection feature output signals.
|
906
991
|
# Filled only when data stores are involved in serving the query and
|
907
|
-
# DetectIntentRequest.
|
908
|
-
#
|
992
|
+
# DetectIntentRequest.populate_data_store_connection_signals is set to true
|
993
|
+
# in the request.
|
909
994
|
class QueryResult
|
910
995
|
include ::Google::Protobuf::MessageExts
|
911
996
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -925,8 +1010,8 @@ module Google
|
|
925
1010
|
# @!attribute [rw] intent
|
926
1011
|
# @return [::String]
|
927
1012
|
# Required. The unique identifier of the intent.
|
928
|
-
# Format:
|
929
|
-
#
|
1013
|
+
# Format:
|
1014
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
|
930
1015
|
class IntentInput
|
931
1016
|
include ::Google::Protobuf::MessageExts
|
932
1017
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1058,9 +1143,10 @@ module Google
|
|
1058
1143
|
# @!attribute [rw] session
|
1059
1144
|
# @return [::String]
|
1060
1145
|
# Required. The name of the session this query is sent to.
|
1061
|
-
# Format:
|
1062
|
-
#
|
1063
|
-
#
|
1146
|
+
# Format:
|
1147
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
|
1148
|
+
# or
|
1149
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
|
1064
1150
|
# If `Environment ID` is not specified, we assume default 'draft'
|
1065
1151
|
# environment.
|
1066
1152
|
# It's up to the API caller to choose an appropriate `Session ID`. It can be
|
@@ -1092,8 +1178,7 @@ module Google
|
|
1092
1178
|
# @return [::String]
|
1093
1179
|
# If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
|
1094
1180
|
# input, this field will contain a copy of the intent identifier. Format:
|
1095
|
-
# `projects/<
|
1096
|
-
# ID>/intents/<Intent ID>`.
|
1181
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
|
1097
1182
|
# @!attribute [rw] transcript
|
1098
1183
|
# @return [::String]
|
1099
1184
|
# If [natural language speech
|
@@ -1168,7 +1253,7 @@ module Google
|
|
1168
1253
|
# @!attribute [rw] score
|
1169
1254
|
# @return [::Float]
|
1170
1255
|
# Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
|
1171
|
-
#
|
1256
|
+
# sentiment).
|
1172
1257
|
# @!attribute [rw] magnitude
|
1173
1258
|
# @return [::Float]
|
1174
1259
|
# A non-negative number in the [0, +inf) range, which represents the absolute
|
@@ -38,11 +38,11 @@ module Google
|
|
38
38
|
# @!attribute [rw] name
|
39
39
|
# @return [::String]
|
40
40
|
# Required. The unique identifier of the session entity type.
|
41
|
-
# Format:
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
41
|
+
# Format:
|
42
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
|
43
|
+
# or
|
44
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
|
45
|
+
# If `Environment ID` is not specified, we assume default 'draft'
|
46
46
|
# environment.
|
47
47
|
# @!attribute [rw] entity_override_mode
|
48
48
|
# @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType::EntityOverrideMode]
|
@@ -84,9 +84,10 @@ module Google
|
|
84
84
|
# @!attribute [rw] parent
|
85
85
|
# @return [::String]
|
86
86
|
# Required. The session to list all session entity types from.
|
87
|
-
# Format:
|
88
|
-
#
|
89
|
-
#
|
87
|
+
# Format:
|
88
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
|
89
|
+
# or
|
90
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
|
90
91
|
# If `Environment ID` is not specified, we assume default 'draft'
|
91
92
|
# environment.
|
92
93
|
# @!attribute [rw] page_size
|
@@ -121,11 +122,11 @@ module Google
|
|
121
122
|
# @!attribute [rw] name
|
122
123
|
# @return [::String]
|
123
124
|
# Required. The name of the session entity type.
|
124
|
-
# Format:
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
125
|
+
# Format:
|
126
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
|
127
|
+
# or
|
128
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
|
129
|
+
# If `Environment ID` is not specified, we assume default 'draft'
|
129
130
|
# environment.
|
130
131
|
class GetSessionEntityTypeRequest
|
131
132
|
include ::Google::Protobuf::MessageExts
|
@@ -137,9 +138,10 @@ module Google
|
|
137
138
|
# @!attribute [rw] parent
|
138
139
|
# @return [::String]
|
139
140
|
# Required. The session to create a session entity type for.
|
140
|
-
# Format:
|
141
|
-
#
|
142
|
-
#
|
141
|
+
# Format:
|
142
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
|
143
|
+
# or
|
144
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
|
143
145
|
# If `Environment ID` is not specified, we assume default 'draft'
|
144
146
|
# environment.
|
145
147
|
# @!attribute [rw] session_entity_type
|
@@ -155,12 +157,12 @@ module Google
|
|
155
157
|
# @!attribute [rw] session_entity_type
|
156
158
|
# @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType]
|
157
159
|
# Required. The session entity type to update.
|
158
|
-
# Format:
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
# environment.
|
160
|
+
# Format:
|
161
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
|
162
|
+
# or
|
163
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
|
164
|
+
# If `Environment ID` is not specified,
|
165
|
+
# we assume default 'draft' environment.
|
164
166
|
# @!attribute [rw] update_mask
|
165
167
|
# @return [::Google::Protobuf::FieldMask]
|
166
168
|
# The mask to control which fields get updated.
|
@@ -174,12 +176,12 @@ module Google
|
|
174
176
|
# @!attribute [rw] name
|
175
177
|
# @return [::String]
|
176
178
|
# Required. The name of the session entity type to delete.
|
177
|
-
# Format:
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
# environment.
|
179
|
+
# Format:
|
180
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
|
181
|
+
# or
|
182
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
|
183
|
+
# If `Environment ID` is not specified,
|
184
|
+
# we assume default 'draft' environment.
|
183
185
|
class DeleteSessionEntityTypeRequest
|
184
186
|
include ::Google::Protobuf::MessageExts
|
185
187
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -28,8 +28,7 @@ module Google
|
|
28
28
|
# The unique identifier of the test case.
|
29
29
|
# {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#create_test_case TestCases.CreateTestCase}
|
30
30
|
# will populate the name automatically. Otherwise use format:
|
31
|
-
# `projects/<
|
32
|
-
# <AgentID>/testCases/<TestCase ID>`.
|
31
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
33
32
|
# @!attribute [rw] tags
|
34
33
|
# @return [::Array<::String>]
|
35
34
|
# Tags are short descriptions that users may apply to test cases for
|
@@ -65,8 +64,7 @@ module Google
|
|
65
64
|
# @!attribute [rw] name
|
66
65
|
# @return [::String]
|
67
66
|
# The resource name for the test case result. Format:
|
68
|
-
# `projects/<
|
69
|
-
# <TestCase ID>/results/<TestCaseResult ID>`.
|
67
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
|
70
68
|
# @!attribute [rw] environment
|
71
69
|
# @return [::String]
|
72
70
|
# Environment where the test was run. If not set, it indicates the draft
|
@@ -93,21 +91,21 @@ module Google
|
|
93
91
|
# @!attribute [rw] flow
|
94
92
|
# @return [::String]
|
95
93
|
# Flow name to start the test case with.
|
96
|
-
# Format:
|
97
|
-
#
|
94
|
+
# Format:
|
95
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
|
98
96
|
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
97
|
+
# Only one of `flow` and `page` should be set to indicate the starting point
|
98
|
+
# of the test case. If neither is set, the test case will start with start
|
99
|
+
# page on the default start flow.
|
102
100
|
# @!attribute [rw] page
|
103
101
|
# @return [::String]
|
104
102
|
# The {::Google::Cloud::Dialogflow::CX::V3::Page page} to start the test case with.
|
105
|
-
# Format:
|
106
|
-
#
|
103
|
+
# Format:
|
104
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
|
107
105
|
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
106
|
+
# Only one of `flow` and `page` should be set to indicate the starting point
|
107
|
+
# of the test case. If neither is set, the test case will start with start
|
108
|
+
# page on the default start flow.
|
111
109
|
class TestConfig
|
112
110
|
include ::Google::Protobuf::MessageExts
|
113
111
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -346,7 +344,7 @@ module Google
|
|
346
344
|
# @!attribute [rw] agent
|
347
345
|
# @return [::String]
|
348
346
|
# Required. The agent to calculate coverage for.
|
349
|
-
# Format: `projects/<
|
347
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
350
348
|
# @!attribute [rw] type
|
351
349
|
# @return [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest::CoverageType]
|
352
350
|
# Required. The type of coverage requested.
|
@@ -375,7 +373,7 @@ module Google
|
|
375
373
|
# @!attribute [rw] agent
|
376
374
|
# @return [::String]
|
377
375
|
# The agent to calculate coverage for.
|
378
|
-
# Format: `projects/<
|
376
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
379
377
|
# @!attribute [rw] intent_coverage
|
380
378
|
# @return [::Google::Cloud::Dialogflow::CX::V3::IntentCoverage]
|
381
379
|
# Intent coverage.
|
@@ -395,7 +393,7 @@ module Google
|
|
395
393
|
# @!attribute [rw] parent
|
396
394
|
# @return [::String]
|
397
395
|
# Required. The agent to list all pages for.
|
398
|
-
# Format: `projects/<
|
396
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
399
397
|
# @!attribute [rw] page_size
|
400
398
|
# @return [::Integer]
|
401
399
|
# The maximum number of items to return in a single page. By default 20.
|
@@ -446,11 +444,11 @@ module Google
|
|
446
444
|
# @!attribute [rw] parent
|
447
445
|
# @return [::String]
|
448
446
|
# Required. The agent to delete test cases from.
|
449
|
-
# Format: `projects/<
|
447
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
450
448
|
# @!attribute [rw] names
|
451
449
|
# @return [::Array<::String>]
|
452
|
-
# Required. Format of test case names:
|
453
|
-
#
|
450
|
+
# Required. Format of test case names:
|
451
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
454
452
|
class BatchDeleteTestCasesRequest
|
455
453
|
include ::Google::Protobuf::MessageExts
|
456
454
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -461,7 +459,7 @@ module Google
|
|
461
459
|
# @!attribute [rw] parent
|
462
460
|
# @return [::String]
|
463
461
|
# Required. The agent to create the test case for.
|
464
|
-
# Format: `projects/<
|
462
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
465
463
|
# @!attribute [rw] test_case
|
466
464
|
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
|
467
465
|
# Required. The test case to create.
|
@@ -491,8 +489,8 @@ module Google
|
|
491
489
|
# @!attribute [rw] name
|
492
490
|
# @return [::String]
|
493
491
|
# Required. The name of the testcase.
|
494
|
-
# Format:
|
495
|
-
#
|
492
|
+
# Format:
|
493
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
496
494
|
class GetTestCaseRequest
|
497
495
|
include ::Google::Protobuf::MessageExts
|
498
496
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -502,13 +500,13 @@ module Google
|
|
502
500
|
# {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#run_test_case TestCases.RunTestCase}.
|
503
501
|
# @!attribute [rw] name
|
504
502
|
# @return [::String]
|
505
|
-
# Required. Format of test case name to run:
|
506
|
-
#
|
503
|
+
# Required. Format of test case name to run:
|
504
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
507
505
|
# @!attribute [rw] environment
|
508
506
|
# @return [::String]
|
509
507
|
# Optional. Environment name. If not set, draft environment is assumed.
|
510
|
-
# Format:
|
511
|
-
#
|
508
|
+
# Format:
|
509
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
|
512
510
|
class RunTestCaseRequest
|
513
511
|
include ::Google::Protobuf::MessageExts
|
514
512
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -536,17 +534,16 @@ module Google
|
|
536
534
|
# {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#batch_run_test_cases TestCases.BatchRunTestCases}.
|
537
535
|
# @!attribute [rw] parent
|
538
536
|
# @return [::String]
|
539
|
-
# Required. Agent name. Format:
|
540
|
-
#
|
537
|
+
# Required. Agent name. Format:
|
538
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
541
539
|
# @!attribute [rw] environment
|
542
540
|
# @return [::String]
|
543
541
|
# Optional. If not set, draft environment is assumed. Format:
|
544
|
-
# `projects/<
|
545
|
-
# ID>/environments/<Environment ID>`.
|
542
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
|
546
543
|
# @!attribute [rw] test_cases
|
547
544
|
# @return [::Array<::String>]
|
548
|
-
# Required. Format:
|
549
|
-
#
|
545
|
+
# Required. Format:
|
546
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
550
547
|
class BatchRunTestCasesRequest
|
551
548
|
include ::Google::Protobuf::MessageExts
|
552
549
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -596,7 +593,7 @@ module Google
|
|
596
593
|
# @!attribute [rw] parent
|
597
594
|
# @return [::String]
|
598
595
|
# Required. The agent to import test cases to.
|
599
|
-
# Format: `projects/<
|
596
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
600
597
|
# @!attribute [rw] gcs_uri
|
601
598
|
# @return [::String]
|
602
599
|
# The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
|
@@ -621,8 +618,8 @@ module Google
|
|
621
618
|
# @!attribute [rw] names
|
622
619
|
# @return [::Array<::String>]
|
623
620
|
# The unique identifiers of the new test cases.
|
624
|
-
# Format:
|
625
|
-
#
|
621
|
+
# Format:
|
622
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
626
623
|
class ImportTestCasesResponse
|
627
624
|
include ::Google::Protobuf::MessageExts
|
628
625
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -656,7 +653,7 @@ module Google
|
|
656
653
|
# @!attribute [rw] parent
|
657
654
|
# @return [::String]
|
658
655
|
# Required. The agent where to export test cases from.
|
659
|
-
# Format: `projects/<
|
656
|
+
# Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
|
660
657
|
# @!attribute [rw] gcs_uri
|
661
658
|
# @return [::String]
|
662
659
|
# The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
|
@@ -707,7 +704,7 @@ module Google
|
|
707
704
|
# @!attribute [rw] gcs_uri
|
708
705
|
# @return [::String]
|
709
706
|
# The URI to a file containing the exported test cases. This field is
|
710
|
-
#
|
707
|
+
# populated only if `gcs_uri` is specified in
|
711
708
|
# {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest ExportTestCasesRequest}.
|
712
709
|
# @!attribute [rw] content
|
713
710
|
# @return [::String]
|
@@ -730,9 +727,10 @@ module Google
|
|
730
727
|
# @!attribute [rw] parent
|
731
728
|
# @return [::String]
|
732
729
|
# Required. The test case to list results for.
|
733
|
-
# Format:
|
734
|
-
# testCases/<
|
735
|
-
#
|
730
|
+
# Format:
|
731
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
|
732
|
+
# Specify a `-` as a wildcard for TestCase ID to
|
733
|
+
# list results across multiple test cases.
|
736
734
|
# @!attribute [rw] page_size
|
737
735
|
# @return [::Integer]
|
738
736
|
# The maximum number of items to return in a single page. By default 100 and
|
@@ -790,8 +788,8 @@ module Google
|
|
790
788
|
# @!attribute [rw] name
|
791
789
|
# @return [::String]
|
792
790
|
# Required. The name of the testcase.
|
793
|
-
# Format:
|
794
|
-
#
|
791
|
+
# Format:
|
792
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
|
795
793
|
class GetTestCaseResultRequest
|
796
794
|
include ::Google::Protobuf::MessageExts
|
797
795
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -29,9 +29,8 @@ module Google
|
|
29
29
|
# @return [::String]
|
30
30
|
# The unique identifier of the transition route group.
|
31
31
|
# {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#create_transition_route_group TransitionRouteGroups.CreateTransitionRouteGroup}
|
32
|
-
# populates the name automatically. Format:
|
33
|
-
#
|
34
|
-
# ID>/transitionRouteGroups/<Transition Route Group ID>`
|
32
|
+
# populates the name automatically. Format:
|
33
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
|
35
34
|
# .
|
36
35
|
# @!attribute [rw] display_name
|
37
36
|
# @return [::String]
|
@@ -51,9 +50,9 @@ module Google
|
|
51
50
|
# @!attribute [rw] parent
|
52
51
|
# @return [::String]
|
53
52
|
# Required. The flow to list all transition route groups for.
|
54
|
-
# Format:
|
55
|
-
#
|
56
|
-
#
|
53
|
+
# Format:
|
54
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
|
55
|
+
# or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.
|
57
56
|
# @!attribute [rw] page_size
|
58
57
|
# @return [::Integer]
|
59
58
|
# The maximum number of items to return in a single page. By default 100 and
|
@@ -70,7 +69,6 @@ module Google
|
|
70
69
|
# *
|
71
70
|
# `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
|
72
71
|
#
|
73
|
-
#
|
74
72
|
# If not specified, the agent's default language is used.
|
75
73
|
# [Many
|
76
74
|
# languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
@@ -104,10 +102,10 @@ module Google
|
|
104
102
|
# @return [::String]
|
105
103
|
# Required. The name of the
|
106
104
|
# {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
|
107
|
-
# Format:
|
108
|
-
#
|
109
|
-
# or
|
110
|
-
#
|
105
|
+
# Format:
|
106
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
|
107
|
+
# or
|
108
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
|
111
109
|
# @!attribute [rw] language_code
|
112
110
|
# @return [::String]
|
113
111
|
# The language to retrieve the transition route group for. The following
|
@@ -133,9 +131,9 @@ module Google
|
|
133
131
|
# @return [::String]
|
134
132
|
# Required. The flow to create an
|
135
133
|
# {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}
|
136
|
-
# for. Format:
|
137
|
-
#
|
138
|
-
# or `projects/<
|
134
|
+
# for. Format:
|
135
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`
|
136
|
+
# or `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`
|
139
137
|
# for agent-level groups.
|
140
138
|
# @!attribute [rw] transition_route_group
|
141
139
|
# @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup]
|
@@ -190,10 +188,10 @@ module Google
|
|
190
188
|
# @return [::String]
|
191
189
|
# Required. The name of the
|
192
190
|
# {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}
|
193
|
-
# to delete. Format:
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
191
|
+
# to delete. Format:
|
192
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
|
193
|
+
# or
|
194
|
+
# `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`.
|
197
195
|
# @!attribute [rw] force
|
198
196
|
# @return [::Boolean]
|
199
197
|
# This field has no effect for transition route group that no page is using.
|