google-cloud-dialogflow-cx-v3 0.1.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +2 -2
  4. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -2
  5. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +17 -1
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +216 -27
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +115 -12
  8. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +3 -2
  9. data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +52 -0
  10. data/lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb +49 -0
  11. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +522 -0
  12. data/lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb +54 -0
  13. data/lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb +75 -0
  14. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +51 -0
  15. data/lib/google/cloud/dialogflow/cx/v3/deployment_pb.rb +63 -0
  16. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +49 -0
  17. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +502 -0
  18. data/lib/google/cloud/dialogflow/cx/v3/deployments/credentials.rb +54 -0
  19. data/lib/google/cloud/dialogflow/cx/v3/deployments/paths.rb +79 -0
  20. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +51 -0
  21. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +2 -2
  22. data/lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +106 -15
  24. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +23 -2
  25. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +33 -1
  26. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +335 -24
  27. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +115 -12
  28. data/lib/google/cloud/dialogflow/cx/v3/environments/paths.rb +21 -0
  29. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +2 -2
  30. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +1 -1
  31. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +146 -21
  32. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +2 -2
  33. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +26 -1
  34. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +254 -32
  35. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +115 -12
  36. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +2 -2
  37. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +2 -2
  38. data/lib/google/cloud/dialogflow/cx/v3/intent_services_pb.rb +1 -1
  39. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +106 -15
  40. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +2 -2
  41. data/lib/google/cloud/dialogflow/cx/v3/page_services_pb.rb +1 -1
  42. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +106 -15
  43. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +2 -2
  44. data/lib/google/cloud/dialogflow/cx/v3/security_settings_pb.rb +2 -2
  45. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +106 -15
  46. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +1 -1
  47. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_pb.rb +2 -2
  48. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +1 -1
  49. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +106 -15
  50. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +3 -2
  51. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +1 -1
  52. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +84 -9
  53. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +2 -2
  54. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +29 -1
  55. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +308 -36
  56. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +115 -12
  57. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +2 -2
  58. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +1 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +106 -15
  60. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +2 -2
  61. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  62. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +2 -2
  63. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +17 -1
  64. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +156 -18
  65. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +115 -12
  66. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +2 -2
  67. data/lib/google/cloud/dialogflow/cx/v3/webhook_services_pb.rb +1 -1
  68. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +106 -15
  69. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -0
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +122 -0
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +135 -0
  72. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +62 -0
  73. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +2 -2
  74. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +4 -1
  75. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +58 -42
  76. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +3 -1
  77. metadata +21 -5
@@ -20,6 +20,8 @@ require "google/cloud/dialogflow/cx/v3/pages"
20
20
  require "google/cloud/dialogflow/cx/v3/flows"
21
21
  require "google/cloud/dialogflow/cx/v3/security_settings_service"
22
22
  require "google/cloud/dialogflow/cx/v3/agents"
23
+ require "google/cloud/dialogflow/cx/v3/changelogs"
24
+ require "google/cloud/dialogflow/cx/v3/deployments"
23
25
  require "google/cloud/dialogflow/cx/v3/entity_types"
24
26
  require "google/cloud/dialogflow/cx/v3/intents"
25
27
  require "google/cloud/dialogflow/cx/v3/session_entity_types"
@@ -0,0 +1,122 @@
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
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#list_changelogs Changelogs.ListChangelogs}.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The agent containing the changelogs.
29
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
30
+ # @!attribute [rw] filter
31
+ # @return [::String]
32
+ # The filter string. Supports filter by user_email, resource, type and
33
+ # create_time. Some examples:
34
+ # 1. By user email:
35
+ # user_email = "someone@google.com"
36
+ # 2. By resource name:
37
+ # resource = "projects/123/locations/global/agents/456/flows/789"
38
+ # 3. By resource display name:
39
+ # display_name = "my agent"
40
+ # 4. By action:
41
+ # action = "Create"
42
+ # 5. By type:
43
+ # type = "flows"
44
+ # 6. By create time. Currently predicates on `create_time` and
45
+ # `create_time_epoch_seconds` are supported:
46
+ # create_time_epoch_seconds > 1551790877 AND create_time <=
47
+ # 2017-01-15T01:30:15.01Z
48
+ # 7. Combination of above filters:
49
+ # resource = "projects/123/locations/global/agents/456/flows/789"
50
+ # AND user_email = "someone@google.com"
51
+ # AND create_time <= 2017-01-15T01:30:15.01Z
52
+ # @!attribute [rw] page_size
53
+ # @return [::Integer]
54
+ # The maximum number of items to return in a single page. By default 100 and
55
+ # at most 1000.
56
+ # @!attribute [rw] page_token
57
+ # @return [::String]
58
+ # The next_page_token value returned from a previous list request.
59
+ class ListChangelogsRequest
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # The response message for {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#list_changelogs Changelogs.ListChangelogs}.
65
+ # @!attribute [rw] changelogs
66
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Changelog>]
67
+ # The list of changelogs. There will be a maximum number of items returned
68
+ # based on the page_size field in the request. The changelogs will be ordered
69
+ # by timestamp.
70
+ # @!attribute [rw] next_page_token
71
+ # @return [::String]
72
+ # Token to retrieve the next page of results, or empty if there are no more
73
+ # results in the list.
74
+ class ListChangelogsResponse
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+
79
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client#get_changelog Changelogs.GetChangelog}.
80
+ # @!attribute [rw] name
81
+ # @return [::String]
82
+ # Required. The name of the changelog to get.
83
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
84
+ # ID>/changelogs/<Changelog ID>`.
85
+ class GetChangelogRequest
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
89
+
90
+ # Changelogs represents a change made to a given agent.
91
+ # @!attribute [rw] name
92
+ # @return [::String]
93
+ # The unique identifier of the changelog.
94
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
95
+ # ID>/changelogs/<Changelog ID>`.
96
+ # @!attribute [rw] user_email
97
+ # @return [::String]
98
+ # Email address of the authenticated user.
99
+ # @!attribute [rw] display_name
100
+ # @return [::String]
101
+ # The affected resource display name of the change.
102
+ # @!attribute [rw] action
103
+ # @return [::String]
104
+ # The action of the change.
105
+ # @!attribute [rw] type
106
+ # @return [::String]
107
+ # The affected resource type.
108
+ # @!attribute [rw] resource
109
+ # @return [::String]
110
+ # The affected resource name of the change.
111
+ # @!attribute [rw] create_time
112
+ # @return [::Google::Protobuf::Timestamp]
113
+ # The timestamp of the change.
114
+ class Changelog
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end
@@ -0,0 +1,135 @@
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 deployment in an environment. A deployment happens when a flow
26
+ # version configured to be active in the environment. You can configure running
27
+ # pre-deployment steps, e.g. running validation test cases, experiment
28
+ # auto-rollout, etc.
29
+ # @!attribute [rw] name
30
+ # @return [::String]
31
+ # The name of the deployment.
32
+ # Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
33
+ # ID>/environments/<Environment ID>/deployments/<Deployment ID>.
34
+ # @!attribute [rw] flow_version
35
+ # @return [::String]
36
+ # The name of the flow version for this deployment.
37
+ # Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
38
+ # ID>/flows/<Flow ID>/versions/<Verion ID>.
39
+ # @!attribute [rw] state
40
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Deployment::State]
41
+ # The current state of the deployment.
42
+ # @!attribute [rw] result
43
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Deployment::Result]
44
+ # Result of the deployment.
45
+ # @!attribute [rw] start_time
46
+ # @return [::Google::Protobuf::Timestamp]
47
+ # Start time of this deployment.
48
+ # @!attribute [rw] end_time
49
+ # @return [::Google::Protobuf::Timestamp]
50
+ # End time of this deployment.
51
+ class Deployment
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+
55
+ # Result of the deployment.
56
+ # @!attribute [rw] deployment_test_results
57
+ # @return [::Array<::String>]
58
+ # Results of test cases running before the deployment.
59
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
60
+ # ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>`.
61
+ # @!attribute [rw] experiment
62
+ # @return [::String]
63
+ # The name of the experiment triggered by this deployment.
64
+ # Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
65
+ # ID>/environments/<Environment ID>/experiments/<Experiment ID>.
66
+ class Result
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # The state of the deployment.
72
+ module State
73
+ # State unspecified.
74
+ STATE_UNSPECIFIED = 0
75
+
76
+ # The deployment is running.
77
+ RUNNING = 1
78
+
79
+ # The deployment succeeded.
80
+ SUCCEEDED = 2
81
+
82
+ # The deployment failed.
83
+ FAILED = 3
84
+ end
85
+ end
86
+
87
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#list_deployments Deployments.ListDeployments}.
88
+ # @!attribute [rw] parent
89
+ # @return [::String]
90
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to list all environments for.
91
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
92
+ # ID>/environments/<Environment ID>`.
93
+ # @!attribute [rw] page_size
94
+ # @return [::Integer]
95
+ # The maximum number of items to return in a single page. By default 20 and
96
+ # at most 100.
97
+ # @!attribute [rw] page_token
98
+ # @return [::String]
99
+ # The next_page_token value returned from a previous list request.
100
+ class ListDeploymentsRequest
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+
105
+ # The response message for {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#list_deployments Deployments.ListDeployments}.
106
+ # @!attribute [rw] deployments
107
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Deployment>]
108
+ # The list of deployments. There will be a maximum number of items
109
+ # returned based on the page_size field in the request. The list may in some
110
+ # cases be empty or contain fewer entries than page_size even if this isn't
111
+ # the last page.
112
+ # @!attribute [rw] next_page_token
113
+ # @return [::String]
114
+ # Token to retrieve the next page of results, or empty if there are no more
115
+ # results in the list.
116
+ class ListDeploymentsResponse
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+ end
120
+
121
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Deployments::Client#get_deployment Deployments.GetDeployment}.
122
+ # @!attribute [rw] name
123
+ # @return [::String]
124
+ # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}.
125
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
126
+ # ID>/environments/<Environment ID>/deployments/<Deployment ID>`.
127
+ class GetDeploymentRequest
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+ end
132
+ end
133
+ end
134
+ end
135
+ end
@@ -52,6 +52,9 @@ module Google
52
52
  # @!attribute [r] update_time
53
53
  # @return [::Google::Protobuf::Timestamp]
54
54
  # Output only. Update time of this environment.
55
+ # @!attribute [rw] test_cases_config
56
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig]
57
+ # The test cases config for continuous tests of this environment.
55
58
  class Environment
56
59
  include ::Google::Protobuf::MessageExts
57
60
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -65,6 +68,25 @@ module Google
65
68
  include ::Google::Protobuf::MessageExts
66
69
  extend ::Google::Protobuf::MessageExts::ClassMethods
67
70
  end
71
+
72
+ # The configuration for continuous tests.
73
+ # @!attribute [rw] test_cases
74
+ # @return [::Array<::String>]
75
+ # A list of test case names to run. They should be under the same agent.
76
+ # Format of each test case name: `projects/<Project ID>/locations/
77
+ # <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`
78
+ # @!attribute [rw] enable_continuous_run
79
+ # @return [::Boolean]
80
+ # Whether to run test cases in {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases} periodically.
81
+ # Default false. If set to ture, run once a day.
82
+ # @!attribute [rw] enable_predeployment_run
83
+ # @return [::Boolean]
84
+ # Whether to run test cases in {::Google::Cloud::Dialogflow::CX::V3::Environment::TestCasesConfig#test_cases TestCasesConfig.test_cases} before
85
+ # deploying a flow version to the environment. Default false.
86
+ class TestCasesConfig
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
68
90
  end
69
91
 
70
92
  # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#list_environments Environments.ListEnvironments}.
@@ -272,6 +294,46 @@ module Google
272
294
  include ::Google::Protobuf::MessageExts
273
295
  extend ::Google::Protobuf::MessageExts::ClassMethods
274
296
  end
297
+
298
+ # The request message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
299
+ # @!attribute [rw] environment
300
+ # @return [::String]
301
+ # Required. The environment to deploy the flow to.
302
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
303
+ # environments/<Environment ID>`.
304
+ # @!attribute [rw] flow_version
305
+ # @return [::String]
306
+ # Required. The flow version to deploy.
307
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
308
+ # flows/<Flow ID>/versions/<Version ID>`.
309
+ class DeployFlowRequest
310
+ include ::Google::Protobuf::MessageExts
311
+ extend ::Google::Protobuf::MessageExts::ClassMethods
312
+ end
313
+
314
+ # The response message for {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow}.
315
+ # @!attribute [rw] environment
316
+ # @return [::Google::Cloud::Dialogflow::CX::V3::Environment]
317
+ # The updated environment where the flow is deployed.
318
+ # @!attribute [rw] deployment
319
+ # @return [::String]
320
+ # The name of the flow version {::Google::Cloud::Dialogflow::CX::V3::Deployment Deployment}.
321
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
322
+ # environments/<Environment ID>/deployments/<Deployment ID>`.
323
+ class DeployFlowResponse
324
+ include ::Google::Protobuf::MessageExts
325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
326
+ end
327
+
328
+ # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::Environments::Client#deploy_flow Environments.DeployFlow} long running
329
+ # operation.
330
+ # @!attribute [rw] test_errors
331
+ # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestError>]
332
+ # Errors of running deployment tests.
333
+ class DeployFlowMetadata
334
+ include ::Google::Protobuf::MessageExts
335
+ extend ::Google::Protobuf::MessageExts::ClassMethods
336
+ end
275
337
  end
276
338
  end
277
339
  end
@@ -274,8 +274,8 @@ module Google
274
274
  # Required. The flow to update.
275
275
  # @!attribute [rw] update_mask
276
276
  # @return [::Google::Protobuf::FieldMask]
277
- # Required. The mask to control which fields get updated. If `update_mask` is not
278
- # specified, an error will be returned.
277
+ # The mask to control which fields get updated. If the mask is not present,
278
+ # all fields will be updated.
279
279
  # @!attribute [rw] language_code
280
280
  # @return [::String]
281
281
  # The language of the following fields in `flow`:
@@ -106,7 +106,10 @@ module Google
106
106
  # propagate to all the related components and take effect.
107
107
  # @!attribute [rw] name
108
108
  # @return [::String]
109
- # Required. Resource name of the settings.
109
+ # Resource name of the settings.
110
+ # Required for the {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings} method.
111
+ # {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#create_security_settings SecuritySettingsService.CreateSecuritySettings} populates the name
112
+ # automatically.
110
113
  # Format: `projects/<Project ID>/locations/<Location
111
114
  # ID>/securitySettings/<Security Settings ID>`.
112
115
  # @!attribute [rw] display_name
@@ -112,7 +112,7 @@ module Google
112
112
  # Multiple request messages should be sent in order:
113
113
  #
114
114
  # 1. The first message must contain
115
- # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
115
+ # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
116
116
  # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} plus optionally
117
117
  # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}. If the client
118
118
  # wants to receive an audio response, it should also contain
@@ -173,21 +173,29 @@ module Google
173
173
  extend ::Google::Protobuf::MessageExts::ClassMethods
174
174
  end
175
175
 
176
- # The top-level message returned from the `StreamingDetectIntent` method.
176
+ # The top-level message returned from the
177
+ # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent StreamingDetectIntent} method.
177
178
  #
178
- # Multiple response messages can be returned in order:
179
+ # Multiple response messages (N) can be returned in order.
179
180
  #
180
- # 1. If the input was set to streaming audio, the first one or more messages
181
- # contain `recognition_result`. Each `recognition_result` represents a more
182
- # complete transcript of what the user said. The last `recognition_result`
183
- # has `is_final` set to `true`.
181
+ # The first (N-1) responses set either the `recognition_result` or
182
+ # `detect_intent_response` field, depending on the request:
184
183
  #
185
- # 2. If `enable_partial_response` is true, the following N messages
186
- # (currently 1 <= N <= 4) contain `detect_intent_response`. The first (N-1)
187
- # `detect_intent_response`s will have `response_type` set to `PARTIAL`.
188
- # The last `detect_intent_response` has `response_type` set to `FINAL`.
189
- # If `response_type` is false, response stream only contains
190
- # the final `detect_intent_response`.
184
+ # * If the `StreamingDetectIntentRequest.query_input.audio` field was
185
+ # set, and the `StreamingDetectIntentRequest.enable_partial_response`
186
+ # field was false, the `recognition_result` field is populated for each
187
+ # of the (N-1) responses.
188
+ # See the {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult} message for details
189
+ # about the result message sequence.
190
+ #
191
+ # * If the `StreamingDetectIntentRequest.enable_partial_response` field was
192
+ # true, the `detect_intent_response` field is populated for each
193
+ # of the (N-1) responses, where 1 <= N <= 4.
194
+ # These responses set the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} field
195
+ # to `PARTIAL`.
196
+ #
197
+ # For the final Nth response message, the `detect_intent_response` is fully
198
+ # populated, and {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} is set to `FINAL`.
191
199
  # @!attribute [rw] recognition_result
192
200
  # @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
193
201
  # The result of speech recognition.
@@ -203,35 +211,39 @@ module Google
203
211
  # that is currently being processed or an indication that this is the end
204
212
  # of the single requested utterance.
205
213
  #
206
- # Example:
207
- #
208
- # 1. transcript: "tube"
209
- #
210
- # 2. transcript: "to be a"
211
- #
212
- # 3. transcript: "to be"
213
- #
214
- # 4. transcript: "to be or not to be"
215
- # is_final: true
216
- #
217
- # 5. transcript: " that's"
218
- #
219
- # 6. transcript: " that is"
220
- #
221
- # 7. message_type: `END_OF_SINGLE_UTTERANCE`
222
- #
223
- # 8. transcript: " that is the question"
224
- # is_final: true
225
- #
226
- # Only two of the responses contain final results (#4 and #8 indicated by
227
- # `is_final: true`). Concatenating these generates the full transcript: "to be
228
- # or not to be that is the question".
229
- #
230
- # In each response we populate:
231
- #
232
- # * for `TRANSCRIPT`: `transcript` and possibly `is_final`.
233
- #
234
- # * for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
214
+ # While end-user audio is being processed, Dialogflow sends a series of
215
+ # results. Each result may contain a `transcript` value. A transcript
216
+ # represents a portion of the utterance. While the recognizer is processing
217
+ # audio, transcript values may be interim values or finalized values.
218
+ # Once a transcript is finalized, the `is_final` value is set to true and
219
+ # processing continues for the next transcript.
220
+ #
221
+ # If `StreamingDetectIntentRequest.query_input.audio.config.single_utterance`
222
+ # was true, and the recognizer has completed processing audio,
223
+ # the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
224
+ # following (last) result contains the last finalized transcript.
225
+ #
226
+ # The complete end-user utterance is determined by concatenating the
227
+ # finalized transcript values received for the series of results.
228
+ #
229
+ # In the following example, single utterance is enabled. In the case where
230
+ # single utterance is not enabled, result 7 would not occur.
231
+ #
232
+ # ```
233
+ # Num | transcript | message_type | is_final
234
+ # --- | ----------------------- | ----------------------- | --------
235
+ # 1 | "tube" | TRANSCRIPT | false
236
+ # 2 | "to be a" | TRANSCRIPT | false
237
+ # 3 | "to be" | TRANSCRIPT | false
238
+ # 4 | "to be or not to be" | TRANSCRIPT | true
239
+ # 5 | "that's" | TRANSCRIPT | false
240
+ # 6 | "that is | TRANSCRIPT | false
241
+ # 7 | unset | END_OF_SINGLE_UTTERANCE | unset
242
+ # 8 | " that is the question" | TRANSCRIPT | true
243
+ # ```
244
+ #
245
+ # Concatenating the finalized transcripts with `is_final` set to true,
246
+ # the complete utterance becomes "to be or not to be that is the question".
235
247
  # @!attribute [rw] message_type
236
248
  # @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult::MessageType]
237
249
  # Type of the result message.
@@ -463,6 +475,10 @@ module Google
463
475
  # @return [::String]
464
476
  # If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will contain
465
477
  # the name of the event.
478
+ # @!attribute [rw] dtmf
479
+ # @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
480
+ # If a [DTMF][DTMFInput] was provided as input, this field will contain
481
+ # a copy of the [DTMFInput][].
466
482
  # @!attribute [rw] language_code
467
483
  # @return [::String]
468
484
  # The language that was triggered during intent detection.
@@ -146,7 +146,7 @@ module Google
146
146
  # @return [::Google::Protobuf::Struct]
147
147
  # Required. Input only. The diagnostic
148
148
  # [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
149
- # output for the turn.
149
+ # output for the turn. Required to calculate the testing coverage.
150
150
  # @!attribute [rw] triggered_intent
151
151
  # @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
152
152
  # The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that triggered the response. Only name and displayName
@@ -494,6 +494,7 @@ module Google
494
494
  end
495
495
 
496
496
  # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#run_test_case TestCases.RunTestCase} long running operation.
497
+ # This message currently has no fields.
497
498
  class RunTestCaseMetadata
498
499
  include ::Google::Protobuf::MessageExts
499
500
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -665,6 +666,7 @@ module Google
665
666
 
666
667
  # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#export_test_cases TestCases.ExportTestCases} long running
667
668
  # operation.
669
+ # This message currently has no fields.
668
670
  class ExportTestCasesMetadata
669
671
  include ::Google::Protobuf::MessageExts
670
672
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-cx-v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-23 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -160,9 +160,11 @@ description: Dialogflow is an end-to-end, build-once deploy-everywhere developme
160
160
  suite for creating conversational interfaces for websites, mobile applications,
161
161
  popular messaging platforms, and IoT devices. You can use it to build interfaces
162
162
  (such as chatbots and conversational IVR) that enable natural and rich interactions
163
- between your users and your business. Note that google-cloud-dialogflow-cx-v3 is
164
- a version-specific client library. For most uses, we recommend installing the main
165
- client library google-cloud-dialogflow-cx instead. See the readme for more details.
163
+ between your users and your business. This client is for Dialogflow CX, providing
164
+ an advanced agent type suitable for large or very complex agents. Note that google-cloud-dialogflow-cx-v3
165
+ is a version-specific client library. For most uses, we recommend installing the
166
+ main client library google-cloud-dialogflow-cx instead. See the readme for more
167
+ details.
166
168
  email: googleapis-packages@google.com
167
169
  executables: []
168
170
  extensions: []
@@ -183,6 +185,18 @@ files:
183
185
  - lib/google/cloud/dialogflow/cx/v3/agents/operations.rb
184
186
  - lib/google/cloud/dialogflow/cx/v3/agents/paths.rb
185
187
  - lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb
188
+ - lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb
189
+ - lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb
190
+ - lib/google/cloud/dialogflow/cx/v3/changelogs.rb
191
+ - lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb
192
+ - lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb
193
+ - lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb
194
+ - lib/google/cloud/dialogflow/cx/v3/deployment_pb.rb
195
+ - lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb
196
+ - lib/google/cloud/dialogflow/cx/v3/deployments.rb
197
+ - lib/google/cloud/dialogflow/cx/v3/deployments/client.rb
198
+ - lib/google/cloud/dialogflow/cx/v3/deployments/credentials.rb
199
+ - lib/google/cloud/dialogflow/cx/v3/deployments/paths.rb
186
200
  - lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb
187
201
  - lib/google/cloud/dialogflow/cx/v3/entity_type_services_pb.rb
188
202
  - lib/google/cloud/dialogflow/cx/v3/entity_types.rb
@@ -275,6 +289,8 @@ files:
275
289
  - proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb
276
290
  - proto_docs/google/cloud/dialogflow/cx/v3/agent.rb
277
291
  - proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb
292
+ - proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb
293
+ - proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb
278
294
  - proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb
279
295
  - proto_docs/google/cloud/dialogflow/cx/v3/environment.rb
280
296
  - proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb