google-cloud-dialogflow-cx-v3 1.1.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/cx/v3/advanced_settings_pb.rb +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_pb.rb +2 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +13 -13
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/paths.rb +19 -0
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +13 -13
  7. data/lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb +1 -1
  8. data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +1 -1
  9. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +3 -3
  10. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +3 -3
  11. data/lib/google/cloud/dialogflow/cx/v3/data_store_connection_pb.rb +1 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +3 -5
  13. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +3 -5
  14. data/lib/google/cloud/dialogflow/cx/v3/entity_type_pb.rb +1 -1
  15. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +12 -13
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +12 -13
  17. data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -1
  18. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +15 -17
  19. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +15 -17
  20. data/lib/google/cloud/dialogflow/cx/v3/experiment_pb.rb +1 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +9 -13
  22. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +9 -13
  23. data/lib/google/cloud/dialogflow/cx/v3/flow_pb.rb +1 -1
  24. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +15 -15
  25. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +15 -15
  26. data/lib/google/cloud/dialogflow/cx/v3/fulfillment_pb.rb +1 -1
  27. data/lib/google/cloud/dialogflow/cx/v3/gcs_pb.rb +1 -1
  28. data/lib/google/cloud/dialogflow/cx/v3/generative_settings_pb.rb +1 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/generator_pb.rb +2 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +6 -6
  31. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +6 -6
  32. data/lib/google/cloud/dialogflow/cx/v3/import_strategy_pb.rb +1 -1
  33. data/lib/google/cloud/dialogflow/cx/v3/intent_pb.rb +1 -1
  34. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +10 -11
  35. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +10 -11
  36. data/lib/google/cloud/dialogflow/cx/v3/page_pb.rb +1 -1
  37. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +8 -8
  38. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +8 -8
  39. data/lib/google/cloud/dialogflow/cx/v3/safety_settings_pb.rb +1 -1
  40. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +6 -6
  41. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +6 -6
  42. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +25 -23
  43. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +25 -23
  44. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +5 -1
  45. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +12 -9
  46. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +12 -9
  47. data/lib/google/cloud/dialogflow/cx/v3/test_case_pb.rb +1 -1
  48. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +25 -25
  49. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +25 -25
  50. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_pb.rb +1 -1
  51. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +14 -15
  52. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +14 -15
  53. data/lib/google/cloud/dialogflow/cx/v3/validation_message_pb.rb +1 -1
  54. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  55. data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +1 -1
  56. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +13 -14
  57. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +13 -14
  58. data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +1 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +6 -6
  60. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +6 -6
  61. data/proto_docs/google/api/client.rb +20 -0
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb +1 -1
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +44 -20
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +6 -0
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +5 -5
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +11 -13
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +16 -17
  68. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +26 -28
  69. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +15 -19
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +28 -27
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +2 -2
  72. data/proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb +2 -2
  73. data/proto_docs/google/cloud/dialogflow/cx/v3/generator.rb +41 -8
  74. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +19 -19
  75. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +33 -33
  76. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +2 -1
  77. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +14 -14
  78. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +107 -22
  79. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +30 -28
  80. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +41 -43
  81. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +16 -18
  82. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +19 -19
  83. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +24 -25
  84. metadata +3 -3
data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb CHANGED
@@ -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: `projects/<Project ID>/locations/<Location
42
- # ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
43
- # ID>` or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
44
- # ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
45
- # Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
88
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
89
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
125
- # ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
126
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
127
- # ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
128
- # Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
141
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
142
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
159
- # ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
160
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
161
- # ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
162
- # Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
178
- # ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
179
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
180
- # ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
181
- # Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
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
data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb CHANGED
@@ -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/<Project ID>/locations/<LocationID>/agents/
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
97
- # ID>/flows/<Flow ID>`.
94
+ # Format:
95
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
98
96
  #
99
- # Only one of `flow` and `page` should be set to indicate the starting point
100
- # of the test case. If neither is set, the test case will start with start
101
- # page on the default start flow.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
106
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
103
+ # Format:
104
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
107
105
  #
108
- # Only one of `flow` and `page` should be set to indicate the starting point
109
- # of the test case. If neither is set, the test case will start with start
110
- # page on the default start flow.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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: `projects/<Project ID>/locations/
453
- # <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
495
- # ID>/testCases/<TestCase ID>`.
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: `projects/<Project
506
- # ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
511
- # ID>/environments/<Environment ID>`.
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: `projects/<Project ID>/locations/<Location
540
- # ID>/agents/ <AgentID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent
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: `projects/<Project ID>/locations/<Location
549
- # ID>/agents/<Agent ID>/testCases/<TestCase ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
625
- # ID>/testCases/<TestCase ID>`.
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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
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
- # populated only if `gcs_uri` is specified in
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
734
- # testCases/<TestCase ID>`. Specify a `-` as a wildcard for TestCase ID to
735
- # list results across multiple test cases.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
794
- # ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>`.
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
data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb CHANGED
@@ -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: `projects/<Project
33
- # ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
55
- # ID>/flows/<Flow ID>`
56
- # or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
108
- # ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`
109
- # or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
110
- # ID>/transitionRouteGroups/<Transition Route Group ID>`.
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: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
137
- # ID>/flows/<Flow ID>`
138
- # or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`
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: `projects/<Project ID>/locations/<Location
194
- # ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition
195
- # Route Group ID>` or `projects/<Project ID>/locations/<Location
196
- # ID>/agents/<Agent ID>/transitionRouteGroups/<Transition Route Group ID>`.
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.
data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb CHANGED
@@ -27,8 +27,8 @@ module Google
27
27
  # @!attribute [rw] version
28
28
  # @return [::String]
29
29
  # Name of the created version.
30
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
31
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
30
+ # Format:
31
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
32
32
  class CreateVersionOperationMetadata
33
33
  include ::Google::Protobuf::MessageExts
34
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -37,9 +37,10 @@ module Google
37
37
  # Represents a version of a flow.
38
38
  # @!attribute [rw] name
39
39
  # @return [::String]
40
- # Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
41
- # ID>/flows/<Flow ID>/versions/<Version ID>. Version ID is a self-increasing
42
- # number generated by Dialogflow upon version creation.
40
+ # Format:
41
+ # projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
42
+ # Version ID is a self-increasing number generated by Dialogflow upon version
43
+ # creation.
43
44
  # @!attribute [rw] display_name
44
45
  # @return [::String]
45
46
  # Required. The human-readable name of the version. Limit of 64 characters.
@@ -82,8 +83,8 @@ module Google
82
83
  # @!attribute [rw] parent
83
84
  # @return [::String]
84
85
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to list all
85
- # versions for. Format: `projects/<Project ID>/locations/<Location
86
- # ID>/agents/<Agent ID>/flows/<Flow ID>`.
86
+ # versions for. Format:
87
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
87
88
  # @!attribute [rw] page_size
88
89
  # @return [::Integer]
89
90
  # The maximum number of items to return in a single page. By default 20 and
@@ -117,8 +118,8 @@ module Google
117
118
  # @!attribute [rw] name
118
119
  # @return [::String]
119
120
  # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
120
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
121
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
121
+ # Format:
122
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
122
123
  class GetVersionRequest
123
124
  include ::Google::Protobuf::MessageExts
124
125
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -130,8 +131,7 @@ module Google
130
131
  # @return [::String]
131
132
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to create an
132
133
  # {::Google::Cloud::Dialogflow::CX::V3::Version Version} for. Format:
133
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
134
- # ID>/flows/<Flow ID>`.
134
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
135
135
  # @!attribute [rw] version
136
136
  # @return [::Google::Cloud::Dialogflow::CX::V3::Version]
137
137
  # Required. The version to create.
@@ -159,8 +159,8 @@ module Google
159
159
  # @!attribute [rw] name
160
160
  # @return [::String]
161
161
  # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version}
162
- # to delete. Format: `projects/<Project ID>/locations/<Location
163
- # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
162
+ # to delete. Format:
163
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
164
164
  class DeleteVersionRequest
165
165
  include ::Google::Protobuf::MessageExts
166
166
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -171,8 +171,8 @@ module Google
171
171
  # @!attribute [rw] name
172
172
  # @return [::String]
173
173
  # Required. The {::Google::Cloud::Dialogflow::CX::V3::Version Version} to be loaded
174
- # to draft flow. Format: `projects/<Project ID>/locations/<Location
175
- # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
174
+ # to draft flow. Format:
175
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
176
176
  # @!attribute [rw] allow_override_agent_resources
177
177
  # @return [::Boolean]
178
178
  # This field is used to prevent accidental overwrite of other agent
@@ -191,14 +191,14 @@ module Google
191
191
  # Required. Name of the base flow version to compare with the target version.
192
192
  # Use version ID `0` to indicate the draft version of the specified flow.
193
193
  #
194
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/
195
- # <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
194
+ # Format:
195
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
196
196
  # @!attribute [rw] target_version
197
197
  # @return [::String]
198
198
  # Required. Name of the target flow version to compare with the
199
199
  # base version. Use version ID `0` to indicate the draft version of the
200
- # specified flow. Format: `projects/<Project ID>/locations/<Location
201
- # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
200
+ # specified flow. Format:
201
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.
202
202
  # @!attribute [rw] language_code
203
203
  # @return [::String]
204
204
  # The language to compare the flow versions for.
data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb CHANGED
@@ -33,8 +33,8 @@ module Google
33
33
  # {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#update_webhook Webhooks.UpdateWebhook}
34
34
  # method.
35
35
  # {::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client#create_webhook Webhooks.CreateWebhook}
36
- # populates the name automatically. Format: `projects/<Project
37
- # ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>`.
36
+ # populates the name automatically. Format:
37
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
38
38
  # @!attribute [rw] display_name
39
39
  # @return [::String]
40
40
  # Required. The human-readable name of the webhook, unique within the agent.
@@ -228,8 +228,8 @@ module Google
228
228
  # @return [::String]
229
229
  # Required. The name of [Service
230
230
  # Directory](https://cloud.google.com/service-directory) service.
231
- # Format: `projects/<Project ID>/locations/<Location
232
- # ID>/namespaces/<Namespace ID>/services/<Service ID>`.
231
+ # Format:
232
+ # `projects/<ProjectID>/locations/<LocationID>/namespaces/<NamespaceID>/services/<ServiceID>`.
233
233
  # `Location ID` of the service directory must be the same as the location
234
234
  # of the agent.
235
235
  # @!attribute [rw] generic_web_service
@@ -246,7 +246,7 @@ module Google
246
246
  # @!attribute [rw] parent
247
247
  # @return [::String]
248
248
  # Required. The agent to list all webhooks for.
249
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
249
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
250
250
  # @!attribute [rw] page_size
251
251
  # @return [::Integer]
252
252
  # The maximum number of items to return in a single page. By default 100 and
@@ -279,8 +279,8 @@ module Google
279
279
  # @!attribute [rw] name
280
280
  # @return [::String]
281
281
  # Required. The name of the webhook.
282
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
283
- # ID>/webhooks/<Webhook ID>`.
282
+ # Format:
283
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
284
284
  class GetWebhookRequest
285
285
  include ::Google::Protobuf::MessageExts
286
286
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -291,7 +291,7 @@ module Google
291
291
  # @!attribute [rw] parent
292
292
  # @return [::String]
293
293
  # Required. The agent to create a webhook for.
294
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
294
+ # Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
295
295
  # @!attribute [rw] webhook
296
296
  # @return [::Google::Cloud::Dialogflow::CX::V3::Webhook]
297
297
  # Required. The webhook to create.
@@ -319,8 +319,8 @@ module Google
319
319
  # @!attribute [rw] name
320
320
  # @return [::String]
321
321
  # Required. The name of the webhook to delete.
322
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
323
- # ID>/webhooks/<Webhook ID>`.
322
+ # Format:
323
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
324
324
  # @!attribute [rw] force
325
325
  # @return [::Boolean]
326
326
  # This field has no effect for webhook not being used.
@@ -356,8 +356,7 @@ module Google
356
356
  # @return [::String]
357
357
  # If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as
358
358
  # input, this field will contain a copy of the intent identifier. Format:
359
- # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
360
- # ID>/intents/<Intent ID>`.
359
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
361
360
  # @!attribute [rw] transcript
362
361
  # @return [::String]
363
362
  # If [natural language speech
@@ -428,8 +427,8 @@ module Google
428
427
  # @return [::String]
429
428
  # Always present. The unique identifier of the last matched
430
429
  # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}.
431
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
432
- # ID>/intents/<Intent ID>`.
430
+ # Format:
431
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
433
432
  # @!attribute [rw] display_name
434
433
  # @return [::String]
435
434
  # Always present. The display name of the last matched
@@ -475,7 +474,7 @@ module Google
475
474
  # @!attribute [rw] score
476
475
  # @return [::Float]
477
476
  # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
478
- # sentiment).
477
+ # sentiment).
479
478
  # @!attribute [rw] magnitude
480
479
  # @return [::Float]
481
480
  # A non-negative number in the [0, +inf) range, which represents the
@@ -507,13 +506,13 @@ module Google
507
506
  # @!attribute [rw] target_page
508
507
  # @return [::String]
509
508
  # The target page to transition to.
510
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
511
- # ID>/flows/<Flow ID>/pages/<Page ID>`.
509
+ # Format:
510
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
512
511
  # @!attribute [rw] target_flow
513
512
  # @return [::String]
514
513
  # The target flow to transition to.
515
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
516
- # ID>/flows/<Flow ID>`.
514
+ # Format:
515
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
517
516
  class WebhookResponse
518
517
  include ::Google::Protobuf::MessageExts
519
518
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -551,9 +550,8 @@ module Google
551
550
  # Always present for
552
551
  # {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored for
553
552
  # {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
554
- # unique identifier of the current page. Format: `projects/<Project
555
- # ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page
556
- # ID>`.
553
+ # unique identifier of the current page. Format:
554
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
557
555
  # @!attribute [rw] display_name
558
556
  # @return [::String]
559
557
  # Always present for
@@ -656,9 +654,10 @@ module Google
656
654
  # unique identifier of the
657
655
  # {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#session session}. This
658
656
  # field can be used by the webhook to identify a session.
659
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
660
- # ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
661
- # ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
657
+ # Format:
658
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
659
+ # or
660
+ # `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`
662
661
  # if environment is specified.
663
662
  # @!attribute [rw] parameters
664
663
  # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]