google-cloud-dialogflow-cx-v3 0.10.2 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +1 -0
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
  6. data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
  7. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
  8. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
  9. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
  10. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
  11. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
  12. data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
  13. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
  14. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
  15. data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
  16. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
  17. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
  18. data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
  19. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
  20. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
  21. data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
  22. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
  24. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
  25. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
  26. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
  28. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
  31. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
  32. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
  33. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
  34. data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
  35. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
  36. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
  37. data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
  38. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
  39. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
  40. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
  41. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  42. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
  43. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
  44. data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
  45. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
  46. data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
  47. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
  48. data/proto_docs/google/api/client.rb +318 -0
  49. data/proto_docs/google/api/launch_stage.rb +71 -0
  50. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +58 -31
  51. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
  52. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
  53. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
  54. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
  55. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
  56. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
  57. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
  58. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
  59. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
  60. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
  61. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -25
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
  68. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
  69. data/proto_docs/google/rpc/status.rb +4 -2
  70. metadata +9 -7
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiments}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/cx/v3/experiments"
40
40
  # client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
@@ -83,7 +83,8 @@ module Google
83
83
  #
84
84
  # - `metadata`: An empty [Struct
85
85
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
86
- # - `response`: [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
86
+ # - `response`:
87
+ # [ImportFlowResponse][google.cloud.dialogflow.cx.v3.ImportFlowResponse]
87
88
  #
88
89
  # Note: You should always train a flow prior to sending it queries. See the
89
90
  # [training
@@ -97,7 +98,8 @@ module Google
97
98
  #
98
99
  # - `metadata`: An empty [Struct
99
100
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
100
- # - `response`: [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
101
+ # - `response`:
102
+ # [ExportFlowResponse][google.cloud.dialogflow.cx.v3.ExportFlowResponse]
101
103
  #
102
104
  # Note that resources (e.g. intents, entities, webhooks) that the flow
103
105
  # references will also be exported.
@@ -997,7 +997,8 @@ module Google
997
997
  #
998
998
  # - `metadata`: An empty [Struct
999
999
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1000
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::ImportFlowResponse ImportFlowResponse}
1000
+ # - `response`:
1001
+ # {::Google::Cloud::Dialogflow::CX::V3::ImportFlowResponse ImportFlowResponse}
1001
1002
  #
1002
1003
  # Note: You should always train a flow prior to sending it queries. See the
1003
1004
  # [training
@@ -1117,7 +1118,8 @@ module Google
1117
1118
  #
1118
1119
  # - `metadata`: An empty [Struct
1119
1120
  # message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1120
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::ExportFlowResponse ExportFlowResponse}
1121
+ # - `response`:
1122
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportFlowResponse ExportFlowResponse}
1121
1123
  #
1122
1124
  # Note that resources (e.g. intents, entities, webhooks) that the flow
1123
1125
  # references will also be exported.
@@ -1142,10 +1144,10 @@ module Google
1142
1144
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
1143
1145
  # ID>/flows/<Flow ID>`.
1144
1146
  # @param flow_uri [::String]
1145
- # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
1146
- # export the flow to. The format of this URI must be
1147
- # `gs://<bucket-name>/<object-name>`.
1148
- # If left unspecified, the serialized flow is returned inline.
1147
+ # Optional. The [Google Cloud
1148
+ # Storage](https://cloud.google.com/storage/docs/) URI to export the flow to.
1149
+ # The format of this URI must be `gs://<bucket-name>/<object-name>`. If left
1150
+ # unspecified, the serialized flow is returned inline.
1149
1151
  #
1150
1152
  # Dialogflow performs a write operation for the Cloud Storage object
1151
1153
  # on the caller's behalf, so your request authentication must
@@ -35,7 +35,7 @@ module Google
35
35
  ##
36
36
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Flow Flows}.
37
37
  #
38
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
39
39
  #
40
40
  # require "google/cloud/dialogflow/cx/v3/flows"
41
41
  # client = ::Google::Cloud::Dialogflow::CX::V3::Flows::Client.new
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Intent Intents}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/cx/v3/intents"
40
40
  # client = ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.new
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Page Pages}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/cx/v3/pages"
40
40
  # client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Client.new
@@ -9,6 +9,7 @@ require 'google/protobuf/struct_pb'
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/cloud/dialogflow/cx/v3/response_message.proto", :syntax => :proto3) do
11
11
  add_message "google.cloud.dialogflow.cx.v3.ResponseMessage" do
12
+ optional :channel, :string, 19
12
13
  oneof :message do
13
14
  optional :text, :message, 1, "google.cloud.dialogflow.cx.v3.ResponseMessage.Text"
14
15
  optional :payload, :message, 2, "google.protobuf.Struct"
@@ -183,7 +183,8 @@ module Google
183
183
  # the default parameter values, pass an empty Hash as a request object (see above).
184
184
  #
185
185
  # @param parent [::String]
186
- # Required. The location to create an {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
186
+ # Required. The location to create an
187
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
187
188
  # Format: `projects/<Project ID>/locations/<Location ID>`.
188
189
  # @param security_settings [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings, ::Hash]
189
190
  # Required. The security settings to create.
@@ -253,8 +254,9 @@ module Google
253
254
  end
254
255
 
255
256
  ##
256
- # Retrieves the specified {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}.
257
- # The returned settings may be stale by up to 1 minute.
257
+ # Retrieves the specified
258
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}. The
259
+ # returned settings may be stale by up to 1 minute.
258
260
  #
259
261
  # @overload get_security_settings(request, options = nil)
260
262
  # Pass arguments to `get_security_settings` via a request object, either of type
@@ -341,7 +343,8 @@ module Google
341
343
  end
342
344
 
343
345
  ##
344
- # Updates the specified {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}.
346
+ # Updates the specified
347
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}.
345
348
  #
346
349
  # @overload update_security_settings(request, options = nil)
347
350
  # Pass arguments to `update_security_settings` via a request object, either of type
@@ -362,8 +365,8 @@ module Google
362
365
  # Required. [SecuritySettings] object that contains values for each of the
363
366
  # fields to update.
364
367
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
365
- # Required. The mask to control which fields get updated. If the mask is not present,
366
- # all fields will be updated.
368
+ # Required. The mask to control which fields get updated. If the mask is not
369
+ # present, all fields will be updated.
367
370
  #
368
371
  # @yield [response, operation] Access the result along with the RPC operation
369
372
  # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
@@ -528,7 +531,8 @@ module Google
528
531
  end
529
532
 
530
533
  ##
531
- # Deletes the specified {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}.
534
+ # Deletes the specified
535
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings}.
532
536
  #
533
537
  # @overload delete_security_settings(request, options = nil)
534
538
  # Pass arguments to `delete_security_settings` via a request object, either of type
@@ -546,8 +550,9 @@ module Google
546
550
  # the default parameter values, pass an empty Hash as a request object (see above).
547
551
  #
548
552
  # @param name [::String]
549
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to delete.
550
- # Format: `projects/<Project ID>/locations/<Location
553
+ # Required. The name of the
554
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to
555
+ # delete. Format: `projects/<Project ID>/locations/<Location
551
556
  # ID>/securitySettings/<Security Settings ID>`.
552
557
  #
553
558
  # @yield [response, operation] Access the result along with the RPC operation
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing security settings for Dialogflow.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/cx/v3/security_settings_service"
40
40
  # client = ::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.new
@@ -36,14 +36,17 @@ module Google
36
36
 
37
37
  # Create security settings in the specified location.
38
38
  rpc :CreateSecuritySettings, ::Google::Cloud::Dialogflow::CX::V3::CreateSecuritySettingsRequest, ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
39
- # Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
40
- # The returned settings may be stale by up to 1 minute.
39
+ # Retrieves the specified
40
+ # [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
41
+ # returned settings may be stale by up to 1 minute.
41
42
  rpc :GetSecuritySettings, ::Google::Cloud::Dialogflow::CX::V3::GetSecuritySettingsRequest, ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
42
- # Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
43
+ # Updates the specified
44
+ # [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
43
45
  rpc :UpdateSecuritySettings, ::Google::Cloud::Dialogflow::CX::V3::UpdateSecuritySettingsRequest, ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings
44
46
  # Returns the list of all security settings in the specified location.
45
47
  rpc :ListSecuritySettings, ::Google::Cloud::Dialogflow::CX::V3::ListSecuritySettingsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListSecuritySettingsResponse
46
- # Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
48
+ # Deletes the specified
49
+ # [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
47
50
  rpc :DeleteSecuritySettings, ::Google::Cloud::Dialogflow::CX::V3::DeleteSecuritySettingsRequest, ::Google::Protobuf::Empty
48
51
  end
49
52
 
@@ -25,7 +25,8 @@ module Google
25
25
  module CX
26
26
  module V3
27
27
  module SessionEntityTypes
28
- # Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
28
+ # Service for managing
29
+ # [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
29
30
  class Service
30
31
 
31
32
  include ::GRPC::GenericService
@@ -29,7 +29,8 @@ module Google
29
29
  ##
30
30
  # Client for the SessionEntityTypes service.
31
31
  #
32
- # Service for managing {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityTypes}.
32
+ # Service for managing
33
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityTypes}.
33
34
  #
34
35
  class Client
35
36
  include Paths
@@ -32,9 +32,10 @@ module Google
32
32
  module CX
33
33
  module V3
34
34
  ##
35
- # Service for managing {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityTypes}.
35
+ # Service for managing
36
+ # {::Google::Cloud::Dialogflow::CX::V3::SessionEntityType SessionEntityTypes}.
36
37
  #
37
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
38
39
  #
39
40
  # require "google/cloud/dialogflow/cx/v3/session_entity_types"
40
41
  # client = ::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client.new
@@ -77,6 +77,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
77
77
  optional :analyze_query_text_sentiment, :bool, 8
78
78
  map :webhook_headers, :string, :string, 10
79
79
  repeated :flow_versions, :string, 14
80
+ optional :channel, :string, 15
80
81
  end
81
82
  add_message "google.cloud.dialogflow.cx.v3.QueryInput" do
82
83
  optional :language_code, :string, 4
@@ -26,8 +26,9 @@ module Google
26
26
  module V3
27
27
  module Sessions
28
28
  # A session represents an interaction with a user. You retrieve user input
29
- # and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to determine
30
- # user intent and respond.
29
+ # and pass it to the
30
+ # [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to
31
+ # determine user intent and respond.
31
32
  class Service
32
33
 
33
34
  include ::GRPC::GenericService
@@ -56,9 +57,13 @@ module Google
56
57
  # Returns preliminary intent match results, doesn't change the session
57
58
  # status.
58
59
  rpc :MatchIntent, ::Google::Cloud::Dialogflow::CX::V3::MatchIntentRequest, ::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse
59
- # Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent].
60
- # Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from
61
- # [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.
60
+ # Fulfills a matched intent returned by
61
+ # [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. Must be
62
+ # called after
63
+ # [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with
64
+ # input from
65
+ # [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse].
66
+ # Otherwise, the behavior is undefined.
62
67
  rpc :FulfillIntent, ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentRequest, ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse
63
68
  end
64
69
 
@@ -30,8 +30,9 @@ module Google
30
30
  # Client for the Sessions service.
31
31
  #
32
32
  # A session represents an interaction with a user. You retrieve user input
33
- # and pass it to the {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent DetectIntent} method to determine
34
- # user intent and respond.
33
+ # and pass it to the
34
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent DetectIntent} method to
35
+ # determine user intent and respond.
35
36
  #
36
37
  class Client
37
38
  include Paths
@@ -472,9 +473,13 @@ module Google
472
473
  end
473
474
 
474
475
  ##
475
- # Fulfills a matched intent returned by {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#match_intent MatchIntent}.
476
- # Must be called after {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#match_intent MatchIntent}, with input from
477
- # {::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse MatchIntentResponse}. Otherwise, the behavior is undefined.
476
+ # Fulfills a matched intent returned by
477
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#match_intent MatchIntent}. Must be
478
+ # called after
479
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#match_intent MatchIntent}, with
480
+ # input from
481
+ # {::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse MatchIntentResponse}.
482
+ # Otherwise, the behavior is undefined.
478
483
  #
479
484
  # @overload fulfill_intent(request, options = nil)
480
485
  # Pass arguments to `fulfill_intent` via a request object, either of type
@@ -33,10 +33,11 @@ module Google
33
33
  module V3
34
34
  ##
35
35
  # A session represents an interaction with a user. You retrieve user input
36
- # and pass it to the {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent DetectIntent} method to determine
37
- # user intent and respond.
36
+ # and pass it to the
37
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#detect_intent DetectIntent} method to
38
+ # determine user intent and respond.
38
39
  #
39
- # To load this service and instantiate a client:
40
+ # @example Load this service and instantiate a gRPC client
40
41
  #
41
42
  # require "google/cloud/dialogflow/cx/v3/sessions"
42
43
  # client = ::Google::Cloud::Dialogflow::CX::V3::Sessions::Client.new
@@ -51,8 +51,10 @@ module Google
51
51
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
52
52
  # The returned `Operation` type has the following method-specific fields:
53
53
  #
54
- # - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
55
- # - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
54
+ # - `metadata`:
55
+ # [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
56
+ # - `response`:
57
+ # [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
56
58
  rpc :RunTestCase, ::Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest, ::Google::Longrunning::Operation
57
59
  # Kicks off a batch run of test cases.
58
60
  #
@@ -60,8 +62,10 @@ module Google
60
62
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
61
63
  # The returned `Operation` type has the following method-specific fields:
62
64
  #
63
- # - `metadata`: [BatchRunTestCasesMetadata][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
64
- # - `response`: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
65
+ # - `metadata`:
66
+ # [BatchRunTestCasesMetadata][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
67
+ # - `response`:
68
+ # [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
65
69
  rpc :BatchRunTestCases, ::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest, ::Google::Longrunning::Operation
66
70
  # Calculates the test coverage for an agent.
67
71
  rpc :CalculateCoverage, ::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest, ::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageResponse
@@ -73,8 +77,10 @@ module Google
73
77
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
74
78
  # The returned `Operation` type has the following method-specific fields:
75
79
  #
76
- # - `metadata`: [ImportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
77
- # - `response`: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
80
+ # - `metadata`:
81
+ # [ImportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
82
+ # - `response`:
83
+ # [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
78
84
  rpc :ImportTestCases, ::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest, ::Google::Longrunning::Operation
79
85
  # Exports the test cases under the agent to a Cloud Storage bucket or a local
80
86
  # file. Filter can be applied to export a subset of test cases.
@@ -83,8 +89,10 @@ module Google
83
89
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
84
90
  # The returned `Operation` type has the following method-specific fields:
85
91
  #
86
- # - `metadata`: [ExportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
87
- # - `response`: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
92
+ # - `metadata`:
93
+ # [ExportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
94
+ # - `response`:
95
+ # [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
88
96
  rpc :ExportTestCases, ::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest, ::Google::Longrunning::Operation
89
97
  # Fetches a list of results for a given test case.
90
98
  rpc :ListTestCaseResults, ::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsResponse
@@ -566,7 +566,8 @@ module Google
566
566
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
567
567
  # Required. The mask to specify which fields should be updated. The
568
568
  # {::Google::Cloud::Dialogflow::CX::V3::TestCase#creation_time `creationTime`} and
569
- # {::Google::Cloud::Dialogflow::CX::V3::TestCase#last_test_result `lastTestResult`} cannot be updated.
569
+ # {::Google::Cloud::Dialogflow::CX::V3::TestCase#last_test_result `lastTestResult`}
570
+ # cannot be updated.
570
571
  #
571
572
  # @yield [response, operation] Access the result along with the RPC operation
572
573
  # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::TestCase]
@@ -639,8 +640,10 @@ module Google
639
640
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
640
641
  # The returned `Operation` type has the following method-specific fields:
641
642
  #
642
- # - `metadata`: {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseMetadata RunTestCaseMetadata}
643
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseResponse RunTestCaseResponse}
643
+ # - `metadata`:
644
+ # {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseMetadata RunTestCaseMetadata}
645
+ # - `response`:
646
+ # {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseResponse RunTestCaseResponse}
644
647
  #
645
648
  # @overload run_test_case(request, options = nil)
646
649
  # Pass arguments to `run_test_case` via a request object, either of type
@@ -658,8 +661,8 @@ module Google
658
661
  # the default parameter values, pass an empty Hash as a request object (see above).
659
662
  #
660
663
  # @param name [::String]
661
- # Required. Format of test case name to run: `projects/<Project ID>/locations/
662
- # <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
664
+ # Required. Format of test case name to run: `projects/<Project
665
+ # ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
663
666
  # @param environment [::String]
664
667
  # Optional. Environment name. If not set, draft environment is assumed.
665
668
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
@@ -744,8 +747,10 @@ module Google
744
747
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
745
748
  # The returned `Operation` type has the following method-specific fields:
746
749
  #
747
- # - `metadata`: {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesMetadata BatchRunTestCasesMetadata}
748
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesResponse BatchRunTestCasesResponse}
750
+ # - `metadata`:
751
+ # {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesMetadata BatchRunTestCasesMetadata}
752
+ # - `response`:
753
+ # {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesResponse BatchRunTestCasesResponse}
749
754
  #
750
755
  # @overload batch_run_test_cases(request, options = nil)
751
756
  # Pass arguments to `batch_run_test_cases` via a request object, either of type
@@ -763,15 +768,15 @@ module Google
763
768
  # the default parameter values, pass an empty Hash as a request object (see above).
764
769
  #
765
770
  # @param parent [::String]
766
- # Required. Agent name. Format: `projects/<Project ID>/locations/<Location ID>/agents/
767
- # <AgentID>`.
771
+ # Required. Agent name. Format: `projects/<Project ID>/locations/<Location
772
+ # ID>/agents/ <AgentID>`.
768
773
  # @param environment [::String]
769
- # Optional. If not set, draft environment is assumed. Format: `projects/<Project
770
- # ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
771
- # ID>`.
774
+ # Optional. If not set, draft environment is assumed. Format:
775
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
776
+ # ID>/environments/<Environment ID>`.
772
777
  # @param test_cases [::Array<::String>]
773
- # Required. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
774
- # ID>/testCases/<TestCase ID>`.
778
+ # Required. Format: `projects/<Project ID>/locations/<Location
779
+ # ID>/agents/<Agent ID>/testCases/<TestCase ID>`.
775
780
  #
776
781
  # @yield [response, operation] Access the result along with the RPC operation
777
782
  # @yieldparam response [::Gapic::Operation]
@@ -942,8 +947,10 @@ module Google
942
947
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
943
948
  # The returned `Operation` type has the following method-specific fields:
944
949
  #
945
- # - `metadata`: {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesMetadata ImportTestCasesMetadata}
946
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesResponse ImportTestCasesResponse}
950
+ # - `metadata`:
951
+ # {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesMetadata ImportTestCasesMetadata}
952
+ # - `response`:
953
+ # {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesResponse ImportTestCasesResponse}
947
954
  #
948
955
  # @overload import_test_cases(request, options = nil)
949
956
  # Pass arguments to `import_test_cases` via a request object, either of type
@@ -1056,8 +1063,10 @@ module Google
1056
1063
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1057
1064
  # The returned `Operation` type has the following method-specific fields:
1058
1065
  #
1059
- # - `metadata`: {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesMetadata ExportTestCasesMetadata}
1060
- # - `response`: {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesResponse ExportTestCasesResponse}
1066
+ # - `metadata`:
1067
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesMetadata ExportTestCasesMetadata}
1068
+ # - `response`:
1069
+ # {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesResponse ExportTestCasesResponse}
1061
1070
  #
1062
1071
  # @overload export_test_cases(request, options = nil)
1063
1072
  # Pass arguments to `export_test_cases` via a request object, either of type
@@ -36,7 +36,7 @@ module Google
36
36
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::TestCase Test Cases} and
37
37
  # {::Google::Cloud::Dialogflow::CX::V3::TestCaseResult Test Case Results}.
38
38
  #
39
- # To load this service and instantiate a client:
39
+ # @example Load this service and instantiate a gRPC client
40
40
  #
41
41
  # require "google/cloud/dialogflow/cx/v3/test_cases"
42
42
  # client = ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
@@ -25,7 +25,8 @@ module Google
25
25
  module CX
26
26
  module V3
27
27
  module TransitionRouteGroups
28
- # Service for managing [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
28
+ # Service for managing
29
+ # [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
29
30
  class Service
30
31
 
31
32
  include ::GRPC::GenericService
@@ -36,21 +37,26 @@ module Google
36
37
 
37
38
  # Returns the list of all transition route groups in the specified flow.
38
39
  rpc :ListTransitionRouteGroups, ::Google::Cloud::Dialogflow::CX::V3::ListTransitionRouteGroupsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListTransitionRouteGroupsResponse
39
- # Retrieves the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
40
+ # Retrieves the specified
41
+ # [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
40
42
  rpc :GetTransitionRouteGroup, ::Google::Cloud::Dialogflow::CX::V3::GetTransitionRouteGroupRequest, ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup
41
- # Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] in the specified flow.
43
+ # Creates an
44
+ # [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]
45
+ # in the specified flow.
42
46
  #
43
47
  # Note: You should always train a flow prior to sending it queries. See the
44
48
  # [training
45
49
  # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
46
50
  rpc :CreateTransitionRouteGroup, ::Google::Cloud::Dialogflow::CX::V3::CreateTransitionRouteGroupRequest, ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup
47
- # Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
51
+ # Updates the specified
52
+ # [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
48
53
  #
49
54
  # Note: You should always train a flow prior to sending it queries. See the
50
55
  # [training
51
56
  # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
52
57
  rpc :UpdateTransitionRouteGroup, ::Google::Cloud::Dialogflow::CX::V3::UpdateTransitionRouteGroupRequest, ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup
53
- # Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
58
+ # Deletes the specified
59
+ # [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
54
60
  #
55
61
  # Note: You should always train a flow prior to sending it queries. See the
56
62
  # [training
@@ -29,7 +29,8 @@ module Google
29
29
  ##
30
30
  # Client for the TransitionRouteGroups service.
31
31
  #
32
- # Service for managing {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroups}.
32
+ # Service for managing
33
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroups}.
33
34
  #
34
35
  class Client
35
36
  include Paths
@@ -278,7 +279,8 @@ module Google
278
279
  end
279
280
 
280
281
  ##
281
- # Retrieves the specified {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
282
+ # Retrieves the specified
283
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
282
284
  #
283
285
  # @overload get_transition_route_group(request, options = nil)
284
286
  # Pass arguments to `get_transition_route_group` via a request object, either of type
@@ -296,7 +298,8 @@ module Google
296
298
  # the default parameter values, pass an empty Hash as a request object (see above).
297
299
  #
298
300
  # @param name [::String]
299
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
301
+ # Required. The name of the
302
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
300
303
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
301
304
  # ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
302
305
  # @param language_code [::String]
@@ -378,7 +381,9 @@ module Google
378
381
  end
379
382
 
380
383
  ##
381
- # Creates an {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup} in the specified flow.
384
+ # Creates an
385
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}
386
+ # in the specified flow.
382
387
  #
383
388
  # Note: You should always train a flow prior to sending it queries. See the
384
389
  # [training
@@ -400,8 +405,9 @@ module Google
400
405
  # the default parameter values, pass an empty Hash as a request object (see above).
401
406
  #
402
407
  # @param parent [::String]
403
- # Required. The flow to create an {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup} for.
404
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
408
+ # Required. The flow to create an
409
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}
410
+ # for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
405
411
  # ID>/flows/<Flow ID>`.
406
412
  # @param transition_route_group [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup, ::Hash]
407
413
  # Required. The transition route group to create.
@@ -483,7 +489,8 @@ module Google
483
489
  end
484
490
 
485
491
  ##
486
- # Updates the specified {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
492
+ # Updates the specified
493
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
487
494
  #
488
495
  # Note: You should always train a flow prior to sending it queries. See the
489
496
  # [training
@@ -586,7 +593,8 @@ module Google
586
593
  end
587
594
 
588
595
  ##
589
- # Deletes the specified {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
596
+ # Deletes the specified
597
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
590
598
  #
591
599
  # Note: You should always train a flow prior to sending it queries. See the
592
600
  # [training
@@ -608,9 +616,11 @@ module Google
608
616
  # the default parameter values, pass an empty Hash as a request object (see above).
609
617
  #
610
618
  # @param name [::String]
611
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup} to delete.
612
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
613
- # ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
619
+ # Required. The name of the
620
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}
621
+ # to delete. Format: `projects/<Project ID>/locations/<Location
622
+ # ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition
623
+ # Route Group ID>`.
614
624
  # @param force [::Boolean]
615
625
  # This field has no effect for transition route group that no page is using.
616
626
  # If the transition route group is referenced by any page:
@@ -32,9 +32,10 @@ module Google
32
32
  module CX
33
33
  module V3
34
34
  ##
35
- # Service for managing {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroups}.
35
+ # Service for managing
36
+ # {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroups}.
36
37
  #
37
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
38
39
  #
39
40
  # require "google/cloud/dialogflow/cx/v3/transition_route_groups"
40
41
  # client = ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client.new