google-cloud-ces-v1beta 0.a → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/cloud/ces/v1beta/agent_card_pb.rb +26 -0
  6. data/lib/google/cloud/ces/v1beta/agent_pb.rb +30 -0
  7. data/lib/google/cloud/ces/v1beta/agent_service/client.rb +5641 -0
  8. data/lib/google/cloud/ces/v1beta/agent_service/credentials.rb +48 -0
  9. data/lib/google/cloud/ces/v1beta/agent_service/operations.rb +843 -0
  10. data/lib/google/cloud/ces/v1beta/agent_service/paths.rb +481 -0
  11. data/lib/google/cloud/ces/v1beta/agent_service/rest/client.rb +5249 -0
  12. data/lib/google/cloud/ces/v1beta/agent_service/rest/operations.rb +927 -0
  13. data/lib/google/cloud/ces/v1beta/agent_service/rest/service_stub.rb +3213 -0
  14. data/lib/google/cloud/ces/v1beta/agent_service/rest.rb +55 -0
  15. data/lib/google/cloud/ces/v1beta/agent_service.rb +57 -0
  16. data/lib/google/cloud/ces/v1beta/agent_service_pb.rb +132 -0
  17. data/lib/google/cloud/ces/v1beta/agent_service_services_pb.rb +148 -0
  18. data/lib/google/cloud/ces/v1beta/agent_tool_pb.rb +24 -0
  19. data/lib/google/cloud/ces/v1beta/agent_transfers_pb.rb +29 -0
  20. data/lib/google/cloud/ces/v1beta/app_pb.rb +70 -0
  21. data/lib/google/cloud/ces/v1beta/app_version_pb.rb +32 -0
  22. data/lib/google/cloud/ces/v1beta/auth_pb.rb +34 -0
  23. data/lib/google/cloud/ces/v1beta/bigquery_export_pb.rb +23 -0
  24. data/lib/google/cloud/ces/v1beta/bindings_override.rb +75 -0
  25. data/lib/google/cloud/ces/v1beta/changelog_pb.rb +26 -0
  26. data/lib/google/cloud/ces/v1beta/client_function_pb.rb +24 -0
  27. data/lib/google/cloud/ces/v1beta/common_pb.rb +46 -0
  28. data/lib/google/cloud/ces/v1beta/connector_tool_pb.rb +27 -0
  29. data/lib/google/cloud/ces/v1beta/connector_toolset_pb.rb +25 -0
  30. data/lib/google/cloud/ces/v1beta/conversation_pb.rb +31 -0
  31. data/lib/google/cloud/ces/v1beta/data_store_pb.rb +27 -0
  32. data/lib/google/cloud/ces/v1beta/data_store_tool_pb.rb +40 -0
  33. data/lib/google/cloud/ces/v1beta/deployment_pb.rb +30 -0
  34. data/lib/google/cloud/ces/v1beta/evaluation_metrics_config_pb.rb +31 -0
  35. data/lib/google/cloud/ces/v1beta/evaluation_pb.rb +99 -0
  36. data/lib/google/cloud/ces/v1beta/evaluation_service/client.rb +4050 -0
  37. data/lib/google/cloud/ces/v1beta/evaluation_service/credentials.rb +48 -0
  38. data/lib/google/cloud/ces/v1beta/evaluation_service/operations.rb +843 -0
  39. data/lib/google/cloud/ces/v1beta/evaluation_service/paths.rb +306 -0
  40. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb +3770 -0
  41. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/operations.rb +927 -0
  42. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/service_stub.rb +2233 -0
  43. data/lib/google/cloud/ces/v1beta/evaluation_service/rest.rb +54 -0
  44. data/lib/google/cloud/ces/v1beta/evaluation_service.rb +56 -0
  45. data/lib/google/cloud/ces/v1beta/evaluation_service_pb.rb +93 -0
  46. data/lib/google/cloud/ces/v1beta/evaluation_service_services_pb.rb +116 -0
  47. data/lib/google/cloud/ces/v1beta/example_pb.rb +34 -0
  48. data/lib/google/cloud/ces/v1beta/fakes_pb.rb +25 -0
  49. data/lib/google/cloud/ces/v1beta/file_context_pb.rb +24 -0
  50. data/lib/google/cloud/ces/v1beta/file_search_tool_pb.rb +24 -0
  51. data/lib/google/cloud/ces/v1beta/golden_run_pb.rb +21 -0
  52. data/lib/google/cloud/ces/v1beta/google_search_tool_pb.rb +24 -0
  53. data/lib/google/cloud/ces/v1beta/guardrail_pb.rb +37 -0
  54. data/lib/google/cloud/ces/v1beta/mcp_tool_pb.rb +27 -0
  55. data/lib/google/cloud/ces/v1beta/mcp_toolset_pb.rb +28 -0
  56. data/lib/google/cloud/ces/v1beta/mocks_pb.rb +26 -0
  57. data/lib/google/cloud/ces/v1beta/omnichannel_pb.rb +31 -0
  58. data/lib/google/cloud/ces/v1beta/omnichannel_service_pb.rb +27 -0
  59. data/lib/google/cloud/ces/v1beta/open_api_tool_pb.rb +25 -0
  60. data/lib/google/cloud/ces/v1beta/open_api_toolset_pb.rb +25 -0
  61. data/lib/google/cloud/ces/v1beta/python_function_pb.rb +24 -0
  62. data/lib/google/cloud/ces/v1beta/rest.rb +42 -0
  63. data/lib/google/cloud/ces/v1beta/schema_pb.rb +25 -0
  64. data/lib/google/cloud/ces/v1beta/search_suggestions_pb.rb +22 -0
  65. data/lib/google/cloud/ces/v1beta/security_settings_pb.rb +27 -0
  66. data/lib/google/cloud/ces/v1beta/session_service/client.rb +762 -0
  67. data/lib/google/cloud/ces/v1beta/session_service/credentials.rb +48 -0
  68. data/lib/google/cloud/ces/v1beta/session_service/paths.rb +117 -0
  69. data/lib/google/cloud/ces/v1beta/session_service/rest/client.rb +562 -0
  70. data/lib/google/cloud/ces/v1beta/session_service/rest/service_stub.rb +199 -0
  71. data/lib/google/cloud/ces/v1beta/session_service/rest.rb +53 -0
  72. data/lib/google/cloud/ces/v1beta/session_service.rb +55 -0
  73. data/lib/google/cloud/ces/v1beta/session_service_pb.rb +54 -0
  74. data/lib/google/cloud/ces/v1beta/session_service_services_pb.rb +120 -0
  75. data/lib/google/cloud/ces/v1beta/system_tool_pb.rb +23 -0
  76. data/lib/google/cloud/ces/v1beta/tool_pb.rb +40 -0
  77. data/lib/google/cloud/ces/v1beta/tool_service/client.rb +733 -0
  78. data/lib/google/cloud/ces/v1beta/tool_service/credentials.rb +48 -0
  79. data/lib/google/cloud/ces/v1beta/tool_service/paths.rb +94 -0
  80. data/lib/google/cloud/ces/v1beta/tool_service/rest/client.rb +677 -0
  81. data/lib/google/cloud/ces/v1beta/tool_service/rest/service_stub.rb +267 -0
  82. data/lib/google/cloud/ces/v1beta/tool_service/rest.rb +53 -0
  83. data/lib/google/cloud/ces/v1beta/tool_service.rb +55 -0
  84. data/lib/google/cloud/ces/v1beta/tool_service_pb.rb +37 -0
  85. data/lib/google/cloud/ces/v1beta/tool_service_services_pb.rb +50 -0
  86. data/lib/google/cloud/ces/v1beta/toolset_pb.rb +30 -0
  87. data/lib/google/cloud/ces/v1beta/toolset_tool_pb.rb +24 -0
  88. data/lib/google/cloud/ces/v1beta/version.rb +7 -2
  89. data/lib/google/cloud/ces/v1beta/widget_service/client.rb +503 -0
  90. data/lib/google/cloud/ces/v1beta/widget_service/credentials.rb +48 -0
  91. data/lib/google/cloud/ces/v1beta/widget_service/paths.rb +75 -0
  92. data/lib/google/cloud/ces/v1beta/widget_service/rest/client.rb +461 -0
  93. data/lib/google/cloud/ces/v1beta/widget_service/rest/service_stub.rb +143 -0
  94. data/lib/google/cloud/ces/v1beta/widget_service/rest.rb +53 -0
  95. data/lib/google/cloud/ces/v1beta/widget_service.rb +55 -0
  96. data/lib/google/cloud/ces/v1beta/widget_service_pb.rb +28 -0
  97. data/lib/google/cloud/ces/v1beta/widget_service_services_pb.rb +46 -0
  98. data/lib/google/cloud/ces/v1beta/widget_tool_pb.rb +31 -0
  99. data/lib/google/cloud/ces/v1beta.rb +49 -0
  100. data/lib/google-cloud-ces-v1beta.rb +21 -0
  101. data/proto_docs/README.md +4 -0
  102. data/proto_docs/google/api/client.rb +593 -0
  103. data/proto_docs/google/api/field_behavior.rb +85 -0
  104. data/proto_docs/google/api/launch_stage.rb +71 -0
  105. data/proto_docs/google/api/resource.rb +227 -0
  106. data/proto_docs/google/cloud/ces/v1beta/agent.rb +233 -0
  107. data/proto_docs/google/cloud/ces/v1beta/agent_card.rb +122 -0
  108. data/proto_docs/google/cloud/ces/v1beta/agent_service.rb +1682 -0
  109. data/proto_docs/google/cloud/ces/v1beta/agent_tool.rb +48 -0
  110. data/proto_docs/google/cloud/ces/v1beta/agent_transfers.rb +111 -0
  111. data/proto_docs/google/cloud/ces/v1beta/app.rb +883 -0
  112. data/proto_docs/google/cloud/ces/v1beta/app_version.rb +83 -0
  113. data/proto_docs/google/cloud/ces/v1beta/auth.rb +214 -0
  114. data/proto_docs/google/cloud/ces/v1beta/bigquery_export.rb +45 -0
  115. data/proto_docs/google/cloud/ces/v1beta/changelog.rb +73 -0
  116. data/proto_docs/google/cloud/ces/v1beta/client_function.rb +48 -0
  117. data/proto_docs/google/cloud/ces/v1beta/common.rb +375 -0
  118. data/proto_docs/google/cloud/ces/v1beta/connector_tool.rb +122 -0
  119. data/proto_docs/google/cloud/ces/v1beta/connector_toolset.rb +52 -0
  120. data/proto_docs/google/cloud/ces/v1beta/conversation.rb +159 -0
  121. data/proto_docs/google/cloud/ces/v1beta/data_store.rb +102 -0
  122. data/proto_docs/google/cloud/ces/v1beta/data_store_tool.rb +328 -0
  123. data/proto_docs/google/cloud/ces/v1beta/deployment.rb +123 -0
  124. data/proto_docs/google/cloud/ces/v1beta/evaluation.rb +1687 -0
  125. data/proto_docs/google/cloud/ces/v1beta/evaluation_metrics_config.rb +151 -0
  126. data/proto_docs/google/cloud/ces/v1beta/evaluation_service.rb +1087 -0
  127. data/proto_docs/google/cloud/ces/v1beta/example.rb +245 -0
  128. data/proto_docs/google/cloud/ces/v1beta/fakes.rb +67 -0
  129. data/proto_docs/google/cloud/ces/v1beta/file_context.rb +50 -0
  130. data/proto_docs/google/cloud/ces/v1beta/file_search_tool.rb +60 -0
  131. data/proto_docs/google/cloud/ces/v1beta/golden_run.rb +40 -0
  132. data/proto_docs/google/cloud/ces/v1beta/google_search_tool.rb +76 -0
  133. data/proto_docs/google/cloud/ces/v1beta/guardrail.rb +324 -0
  134. data/proto_docs/google/cloud/ces/v1beta/mcp_tool.rb +110 -0
  135. data/proto_docs/google/cloud/ces/v1beta/mcp_toolset.rb +118 -0
  136. data/proto_docs/google/cloud/ces/v1beta/mocks.rb +60 -0
  137. data/proto_docs/google/cloud/ces/v1beta/omnichannel.rb +163 -0
  138. data/proto_docs/google/cloud/ces/v1beta/omnichannel_service.rb +45 -0
  139. data/proto_docs/google/cloud/ces/v1beta/open_api_tool.rb +66 -0
  140. data/proto_docs/google/cloud/ces/v1beta/open_api_toolset.rb +57 -0
  141. data/proto_docs/google/cloud/ces/v1beta/python_function.rb +47 -0
  142. data/proto_docs/google/cloud/ces/v1beta/schema.rb +162 -0
  143. data/proto_docs/google/cloud/ces/v1beta/search_suggestions.rb +55 -0
  144. data/proto_docs/google/cloud/ces/v1beta/security_settings.rb +80 -0
  145. data/proto_docs/google/cloud/ces/v1beta/session_service.rb +493 -0
  146. data/proto_docs/google/cloud/ces/v1beta/system_tool.rb +38 -0
  147. data/proto_docs/google/cloud/ces/v1beta/tool.rb +136 -0
  148. data/proto_docs/google/cloud/ces/v1beta/tool_service.rb +185 -0
  149. data/proto_docs/google/cloud/ces/v1beta/toolset.rb +80 -0
  150. data/proto_docs/google/cloud/ces/v1beta/toolset_tool.rb +40 -0
  151. data/proto_docs/google/cloud/ces/v1beta/widget_service.rb +62 -0
  152. data/proto_docs/google/cloud/ces/v1beta/widget_tool.rb +182 -0
  153. data/proto_docs/google/longrunning/operations.rb +191 -0
  154. data/proto_docs/google/protobuf/any.rb +145 -0
  155. data/proto_docs/google/protobuf/duration.rb +98 -0
  156. data/proto_docs/google/protobuf/empty.rb +34 -0
  157. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  158. data/proto_docs/google/protobuf/struct.rb +108 -0
  159. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  160. data/proto_docs/google/rpc/status.rb +48 -0
  161. metadata +208 -9
@@ -0,0 +1,1087 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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 Ces
23
+ module V1beta
24
+ # Request message for
25
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation_result_metrics EvaluationService.RunEvaluationResultMetrics}.
26
+ # @!attribute [rw] evaluation_result_id
27
+ # @return [::String]
28
+ # Required. The evaluation result to run metrics for.
29
+ # Format:
30
+ # `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}`
31
+ class RunEvaluationResultMetricsRequest
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Response message for
37
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation_result_metrics EvaluationService.RunEvaluationResultMetrics}.
38
+ # @!attribute [r] status
39
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationResult::Outcome]
40
+ # Output only. The status of the evaluation result metrics calculation.
41
+ class RunEvaluationResultMetricsResponse
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+
46
+ # Response message for
47
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation EvaluationService.RunEvaluation}.
48
+ # @!attribute [rw] evaluation_run
49
+ # @return [::String]
50
+ # The name of the evaluation run that was created.
51
+ # Format:
52
+ # `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}`
53
+ class RunEvaluationResponse
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # Operation metadata for
59
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation EvaluationService.RunEvaluation}.
60
+ # @!attribute [r] evaluations
61
+ # @return [::Array<::String>]
62
+ # Output only. The list of evaluations that were run.
63
+ # Format:
64
+ # `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
65
+ # @!attribute [r] evaluation_run
66
+ # @return [::String]
67
+ # Output only. The evaluation run that was created.
68
+ # Format:
69
+ # `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}`
70
+ # @!attribute [r] create_time
71
+ # @return [::Google::Protobuf::Timestamp]
72
+ # Output only. The time the operation was created.
73
+ # @!attribute [r] end_time
74
+ # @return [::Google::Protobuf::Timestamp]
75
+ # Output only. The time the operation completed.
76
+ # @!attribute [r] verb
77
+ # @return [::String]
78
+ # Output only. The verb of the operation.
79
+ # @!attribute [r] cancel_requested
80
+ # @return [::Boolean]
81
+ # Output only. Identifies whether the user has requested cancellation of the
82
+ # operation. Operations that have been cancelled successfully have
83
+ # {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
84
+ # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of `1`,
85
+ # corresponding to `Code.CANCELLED`.
86
+ class RunEvaluationOperationMetadata
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # Operation metadata for
92
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#generate_evaluation EvaluationService.GenerateEvaluation}.
93
+ class GenerateEvaluationOperationMetadata
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+
98
+ # Operation metadata for
99
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation_run EvaluationService.DeleteEvaluationRun}.
100
+ class DeleteEvaluationRunOperationMetadata
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+
105
+ # Request message for
106
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#create_evaluation EvaluationService.CreateEvaluation}.
107
+ # @!attribute [rw] parent
108
+ # @return [::String]
109
+ # Required. The app to create the evaluation for.
110
+ # Format:
111
+ # `projects/{project}/locations/{location}/apps/{app}`
112
+ # @!attribute [rw] evaluation_id
113
+ # @return [::String]
114
+ # Optional. The ID to use for the evaluation, which will become the final
115
+ # component of the evaluation's resource name. If not provided, a unique ID
116
+ # will be automatically assigned for the evaluation.
117
+ # @!attribute [rw] evaluation
118
+ # @return [::Google::Cloud::Ces::V1beta::Evaluation]
119
+ # Required. The evaluation to create.
120
+ class CreateEvaluationRequest
121
+ include ::Google::Protobuf::MessageExts
122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
123
+ end
124
+
125
+ # Request message for
126
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#generate_evaluation EvaluationService.GenerateEvaluation}.
127
+ # @!attribute [rw] conversation
128
+ # @return [::String]
129
+ # Required. The conversation to create the golden evaluation for.
130
+ # Format:
131
+ # `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`
132
+ # @!attribute [rw] source
133
+ # @deprecated This field is deprecated and may be removed in the next major version update.
134
+ # @return [::Google::Cloud::Ces::V1beta::Conversation::Source]
135
+ # Optional. Indicate the source of the conversation. If not set, all sources
136
+ # will be searched.
137
+ class GenerateEvaluationRequest
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+ end
141
+
142
+ # Request message for
143
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#import_evaluations EvaluationService.ImportEvaluations}.
144
+ # @!attribute [rw] conversation_list
145
+ # @return [::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ConversationList]
146
+ # The conversations to import the evaluations from.
147
+ #
148
+ # Note: The following fields are mutually exclusive: `conversation_list`, `gcs_uri`, `csv_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
149
+ # @!attribute [rw] gcs_uri
150
+ # @return [::String]
151
+ # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
152
+ # from which to import evaluations. The format of this URI must be
153
+ # `gs://<bucket-name>/<object-name>`.
154
+ #
155
+ # Note: The following fields are mutually exclusive: `gcs_uri`, `conversation_list`, `csv_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
156
+ # @!attribute [rw] csv_content
157
+ # @return [::String]
158
+ # Raw bytes representing the csv file with the evaluations structure.
159
+ #
160
+ # Note: The following fields are mutually exclusive: `csv_content`, `conversation_list`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
161
+ # @!attribute [rw] parent
162
+ # @return [::String]
163
+ # Required. The app to import the evaluations into.
164
+ # Format:
165
+ # `projects/{project}/locations/{location}/apps/{app}`
166
+ # @!attribute [rw] import_options
167
+ # @return [::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ImportOptions]
168
+ # Optional. Options governing the import process for the evaluations.
169
+ class ImportEvaluationsRequest
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+
173
+ # A list of conversation resource names.
174
+ # @!attribute [rw] conversations
175
+ # @return [::Array<::String>]
176
+ # Optional. Conversation resource names.
177
+ class ConversationList
178
+ include ::Google::Protobuf::MessageExts
179
+ extend ::Google::Protobuf::MessageExts::ClassMethods
180
+ end
181
+
182
+ # Configuration options for the evaluation import process.
183
+ # These options control how the import behaves, particularly when
184
+ # conflicts arise with existing evaluations data.
185
+ # @!attribute [rw] conflict_resolution_strategy
186
+ # @return [::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ImportOptions::ConflictResolutionStrategy]
187
+ # Optional. The strategy to use when resolving conflicts during import.
188
+ class ImportOptions
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+
192
+ # Defines the strategy for handling conflicts when an evaluation with the
193
+ # same evaluation ID already exists in the app.
194
+ module ConflictResolutionStrategy
195
+ # The conflict resolution strategy is unspecified.
196
+ CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED = 0
197
+
198
+ # Overwrite the existing evaluation with the new one.
199
+ OVERWRITE = 1
200
+
201
+ # Keep the existing evaluation and skip the new one.
202
+ SKIP = 2
203
+
204
+ # Keep the existing evaluation and duplicate the new one as a new
205
+ # evaluation.
206
+ DUPLICATE = 3
207
+ end
208
+ end
209
+ end
210
+
211
+ # Response message for
212
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#import_evaluations EvaluationService.ImportEvaluations}.
213
+ # @!attribute [rw] evaluations
214
+ # @return [::Array<::Google::Cloud::Ces::V1beta::Evaluation>]
215
+ # The list of evaluations that were imported into the app.
216
+ # @!attribute [rw] evaluation_results
217
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationResult>]
218
+ # The list of evaluation results that were imported into the app.
219
+ # @!attribute [rw] evaluation_runs
220
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationRun>]
221
+ # The list of evaluation runs that were imported into the app.
222
+ # @!attribute [rw] error_messages
223
+ # @return [::Array<::String>]
224
+ # Optional. A list of error messages associated with evaluations that failed
225
+ # to be imported.
226
+ # @!attribute [rw] import_failure_count
227
+ # @return [::Integer]
228
+ # The number of evaluations that either failed to import entirely or
229
+ # completed import with one or more errors.
230
+ # @!attribute [rw] evaluation_result_import_failure_count
231
+ # @return [::Integer]
232
+ # The number of evaluation results that either failed to import entirely or
233
+ # completed import with one or more errors.
234
+ # @!attribute [rw] evaluation_run_import_failure_count
235
+ # @return [::Integer]
236
+ # The number of evaluation runs that either failed to import entirely or
237
+ # completed import with one or more errors.
238
+ class ImportEvaluationsResponse
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
243
+ # Represents the metadata of the long-running operation for
244
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#import_evaluations EvaluationService.ImportEvaluations}.
245
+ # @!attribute [r] create_time
246
+ # @return [::Google::Protobuf::Timestamp]
247
+ # Output only. The time the operation was created.
248
+ # @!attribute [r] end_time
249
+ # @return [::Google::Protobuf::Timestamp]
250
+ # Output only. The time the operation finished running.
251
+ # @!attribute [r] status_message
252
+ # @return [::String]
253
+ # Output only. Human-readable status of the operation, if any.
254
+ class ImportEvaluationsOperationMetadata
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
259
+ # Request message for
260
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#create_evaluation_dataset EvaluationService.CreateEvaluationDataset}.
261
+ # @!attribute [rw] parent
262
+ # @return [::String]
263
+ # Required. The app to create the evaluation for.
264
+ # Format:
265
+ # `projects/{project}/locations/{location}/apps/{app}`
266
+ # @!attribute [rw] evaluation_dataset_id
267
+ # @return [::String]
268
+ # Optional. The ID to use for the evaluation dataset, which will become the
269
+ # final component of the evaluation dataset's resource name. If not provided,
270
+ # a unique ID will be automatically assigned for the evaluation.
271
+ # @!attribute [rw] evaluation_dataset
272
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationDataset]
273
+ # Required. The evaluation dataset to create.
274
+ class CreateEvaluationDatasetRequest
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Request message for
280
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#update_evaluation EvaluationService.UpdateEvaluation}.
281
+ # @!attribute [rw] evaluation
282
+ # @return [::Google::Cloud::Ces::V1beta::Evaluation]
283
+ # Required. The evaluation to update.
284
+ # @!attribute [rw] update_mask
285
+ # @return [::Google::Protobuf::FieldMask]
286
+ # Optional. Field mask is used to control which fields get updated. If the
287
+ # mask is not present, all fields will be updated.
288
+ class UpdateEvaluationRequest
289
+ include ::Google::Protobuf::MessageExts
290
+ extend ::Google::Protobuf::MessageExts::ClassMethods
291
+ end
292
+
293
+ # Request message for
294
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#update_evaluation_dataset EvaluationService.UpdateEvaluationDataset}.
295
+ # @!attribute [rw] evaluation_dataset
296
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationDataset]
297
+ # Required. The evaluation dataset to update.
298
+ # @!attribute [rw] update_mask
299
+ # @return [::Google::Protobuf::FieldMask]
300
+ # Optional. Field mask is used to control which fields get updated. If the
301
+ # mask is not present, all fields will be updated.
302
+ class UpdateEvaluationDatasetRequest
303
+ include ::Google::Protobuf::MessageExts
304
+ extend ::Google::Protobuf::MessageExts::ClassMethods
305
+ end
306
+
307
+ # Request message for
308
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation EvaluationService.DeleteEvaluation}.
309
+ # @!attribute [rw] name
310
+ # @return [::String]
311
+ # Required. The resource name of the evaluation to delete.
312
+ # @!attribute [rw] force
313
+ # @return [::Boolean]
314
+ # Optional. Indicates whether to forcefully delete the evaluation, even if it
315
+ # is still referenced by evaluation datasets.
316
+ #
317
+ # * If `force = false`, the deletion will fail if any datasets still
318
+ # reference the evaluation.
319
+ # * If `force = true`, all existing references from datasets will be removed
320
+ # and the evaluation will be deleted.
321
+ # @!attribute [rw] etag
322
+ # @return [::String]
323
+ # Optional. The current etag of the evaluation. If an etag is not provided,
324
+ # the deletion will overwrite any concurrent changes. If an etag is provided
325
+ # and does not match the current etag of the evaluation, deletion will be
326
+ # blocked and an ABORTED error will be returned.
327
+ class DeleteEvaluationRequest
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # Request message for
333
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation_result EvaluationService.DeleteEvaluationResult}.
334
+ # @!attribute [rw] name
335
+ # @return [::String]
336
+ # Required. The resource name of the evaluation result to delete.
337
+ class DeleteEvaluationResultRequest
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # Request message for
343
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation_dataset EvaluationService.DeleteEvaluationDataset}.
344
+ # @!attribute [rw] name
345
+ # @return [::String]
346
+ # Required. The resource name of the evaluation dataset to delete.
347
+ # @!attribute [rw] etag
348
+ # @return [::String]
349
+ # Optional. The current etag of the evaluation dataset. If an etag is not
350
+ # provided, the deletion will overwrite any concurrent changes. If an etag is
351
+ # provided and does not match the current etag of the evaluation dataset,
352
+ # deletion will be blocked and an ABORTED error will be returned.
353
+ class DeleteEvaluationDatasetRequest
354
+ include ::Google::Protobuf::MessageExts
355
+ extend ::Google::Protobuf::MessageExts::ClassMethods
356
+ end
357
+
358
+ # Request message for
359
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation_run EvaluationService.DeleteEvaluationRun}.
360
+ # @!attribute [rw] name
361
+ # @return [::String]
362
+ # Required. The resource name of the evaluation run to delete.
363
+ class DeleteEvaluationRunRequest
364
+ include ::Google::Protobuf::MessageExts
365
+ extend ::Google::Protobuf::MessageExts::ClassMethods
366
+ end
367
+
368
+ # Request message for
369
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_evaluation EvaluationService.GetEvaluation}.
370
+ # @!attribute [rw] name
371
+ # @return [::String]
372
+ # Required. The resource name of the evaluation to retrieve.
373
+ class GetEvaluationRequest
374
+ include ::Google::Protobuf::MessageExts
375
+ extend ::Google::Protobuf::MessageExts::ClassMethods
376
+ end
377
+
378
+ # Request message for
379
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_evaluation_result EvaluationService.GetEvaluationResult}.
380
+ # @!attribute [rw] name
381
+ # @return [::String]
382
+ # Required. The resource name of the evaluation result to retrieve.
383
+ class GetEvaluationResultRequest
384
+ include ::Google::Protobuf::MessageExts
385
+ extend ::Google::Protobuf::MessageExts::ClassMethods
386
+ end
387
+
388
+ # Request message for
389
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_evaluation_dataset EvaluationService.GetEvaluationDataset}.
390
+ # @!attribute [rw] name
391
+ # @return [::String]
392
+ # Required. The resource name of the evaluation dataset to retrieve.
393
+ class GetEvaluationDatasetRequest
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+
398
+ # Request message for
399
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_evaluation_run EvaluationService.GetEvaluationRun}.
400
+ # @!attribute [rw] name
401
+ # @return [::String]
402
+ # Required. The resource name of the evaluation run to retrieve.
403
+ class GetEvaluationRunRequest
404
+ include ::Google::Protobuf::MessageExts
405
+ extend ::Google::Protobuf::MessageExts::ClassMethods
406
+ end
407
+
408
+ # Request message for
409
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}.
410
+ # @!attribute [rw] parent
411
+ # @return [::String]
412
+ # Required. The resource name of the app to list evaluations from.
413
+ # @!attribute [rw] page_size
414
+ # @return [::Integer]
415
+ # Optional. Requested page size. Server may return fewer items than
416
+ # requested. If unspecified, server will pick an appropriate default.
417
+ # @!attribute [rw] page_token
418
+ # @return [::String]
419
+ # Optional. The
420
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationsResponse#next_page_token next_page_token}
421
+ # value returned from a previous list
422
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}
423
+ # call.
424
+ # @!attribute [rw] filter
425
+ # @deprecated This field is deprecated and may be removed in the next major version update.
426
+ # @return [::String]
427
+ # Optional. Deprecated: Use evaluation_filter and evaluation_run_filter
428
+ # instead.
429
+ # @!attribute [rw] evaluation_filter
430
+ # @return [::String]
431
+ # Optional. Filter to be applied on the evaluation when listing the
432
+ # evaluations. See https://google.aip.dev/160 for more details. Supported
433
+ # fields: evaluation_datasets
434
+ # @!attribute [rw] evaluation_run_filter
435
+ # @return [::String]
436
+ # Optional. Filter string for fields on the associated EvaluationRun
437
+ # resources. See https://google.aip.dev/160 for more details. Supported
438
+ # fields: create_time, initiated_by, app_version_display_name
439
+ # @!attribute [rw] order_by
440
+ # @return [::String]
441
+ # Optional. Field to sort by. Only "name" and "create_time", and
442
+ # "update_time" are supported. Time fields are ordered in descending order,
443
+ # and the name field is ordered in ascending order. If not included,
444
+ # "update_time" will be the default. See https://google.aip.dev/132#ordering
445
+ # for more details.
446
+ # @!attribute [rw] last_ten_results
447
+ # @return [::Boolean]
448
+ # Optional. Whether to include the last 10 evaluation results for each
449
+ # evaluation in the response.
450
+ class ListEvaluationsRequest
451
+ include ::Google::Protobuf::MessageExts
452
+ extend ::Google::Protobuf::MessageExts::ClassMethods
453
+ end
454
+
455
+ # Request message for
456
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}.
457
+ # @!attribute [rw] parent
458
+ # @return [::String]
459
+ # Required. The resource name of the evaluation to list evaluation results
460
+ # from. To filter by evaluation run, use `-` as the evaluation ID and specify
461
+ # the evaluation run ID in the filter. For example:
462
+ # `projects/{project}/locations/{location}/apps/{app}/evaluations/-`
463
+ # @!attribute [rw] page_size
464
+ # @return [::Integer]
465
+ # Optional. Requested page size. Server may return fewer items than
466
+ # requested. If unspecified, server will pick an appropriate default.
467
+ # @!attribute [rw] page_token
468
+ # @return [::String]
469
+ # Optional. The
470
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationResultsResponse#next_page_token next_page_token}
471
+ # value returned from a previous list
472
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}
473
+ # call.
474
+ # @!attribute [rw] filter
475
+ # @return [::String]
476
+ # Optional. Filter to be applied when listing the evaluation results.
477
+ # See https://google.aip.dev/160 for more details.
478
+ # @!attribute [rw] order_by
479
+ # @return [::String]
480
+ # Optional. Field to sort by. Only "name" and "create_time", and
481
+ # "update_time" are supported. Time fields are ordered in descending order,
482
+ # and the name field is ordered in ascending order. If not included,
483
+ # "update_time" will be the default. See https://google.aip.dev/132#ordering
484
+ # for more details.
485
+ class ListEvaluationResultsRequest
486
+ include ::Google::Protobuf::MessageExts
487
+ extend ::Google::Protobuf::MessageExts::ClassMethods
488
+ end
489
+
490
+ # Request message for
491
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_datasets EvaluationService.ListEvaluationDatasets}.
492
+ # @!attribute [rw] parent
493
+ # @return [::String]
494
+ # Required. The resource name of the app to list evaluation datasets from.
495
+ # @!attribute [rw] page_size
496
+ # @return [::Integer]
497
+ # Optional. Requested page size. Server may return fewer items than
498
+ # requested. If unspecified, server will pick an appropriate default.
499
+ # @!attribute [rw] page_token
500
+ # @return [::String]
501
+ # Optional. The
502
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationDatasetsResponse#next_page_token next_page_token}
503
+ # value returned from a previous list
504
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_datasets EvaluationService.ListEvaluationDatasets}
505
+ # call.
506
+ # @!attribute [rw] filter
507
+ # @return [::String]
508
+ # Optional. Filter to be applied when listing the evaluation datasets.
509
+ # See https://google.aip.dev/160 for more details.
510
+ # @!attribute [rw] order_by
511
+ # @return [::String]
512
+ # Optional. Field to sort by. Only "name" and "create_time", and
513
+ # "update_time" are supported. Time fields are ordered in descending order,
514
+ # and the name field is ordered in ascending order. If not included,
515
+ # "update_time" will be the default. See https://google.aip.dev/132#ordering
516
+ # for more details.
517
+ class ListEvaluationDatasetsRequest
518
+ include ::Google::Protobuf::MessageExts
519
+ extend ::Google::Protobuf::MessageExts::ClassMethods
520
+ end
521
+
522
+ # Request message for
523
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_runs EvaluationService.ListEvaluationRuns}.
524
+ # @!attribute [rw] parent
525
+ # @return [::String]
526
+ # Required. The resource name of the app to list evaluation runs from.
527
+ # @!attribute [rw] page_size
528
+ # @return [::Integer]
529
+ # Optional. Requested page size. Server may return fewer items than
530
+ # requested. If unspecified, server will pick an appropriate default.
531
+ # @!attribute [rw] page_token
532
+ # @return [::String]
533
+ # Optional. The
534
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationRunsResponse#next_page_token next_page_token}
535
+ # value returned from a previous list
536
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_runs EvaluationService.ListEvaluationRuns}
537
+ # call.
538
+ # @!attribute [rw] filter
539
+ # @return [::String]
540
+ # Optional. Filter to be applied when listing the evaluation runs.
541
+ # See https://google.aip.dev/160 for more details.
542
+ # @!attribute [rw] order_by
543
+ # @return [::String]
544
+ # Optional. Field to sort by. Only "name" and "create_time", and
545
+ # "update_time" are supported. Time fields are ordered in descending order,
546
+ # and the name field is ordered in ascending order. If not included,
547
+ # "update_time" will be the default. See https://google.aip.dev/132#ordering
548
+ # for more details.
549
+ class ListEvaluationRunsRequest
550
+ include ::Google::Protobuf::MessageExts
551
+ extend ::Google::Protobuf::MessageExts::ClassMethods
552
+ end
553
+
554
+ # Response message for
555
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}.
556
+ # @!attribute [rw] evaluations
557
+ # @return [::Array<::Google::Cloud::Ces::V1beta::Evaluation>]
558
+ # The list of evaluations.
559
+ # @!attribute [rw] next_page_token
560
+ # @return [::String]
561
+ # A token that can be sent as
562
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationsRequest#page_token ListEvaluationsRequest.page_token}
563
+ # to retrieve the next page. Absence of this field indicates there are no
564
+ # subsequent pages.
565
+ class ListEvaluationsResponse
566
+ include ::Google::Protobuf::MessageExts
567
+ extend ::Google::Protobuf::MessageExts::ClassMethods
568
+ end
569
+
570
+ # Response message for
571
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}.
572
+ # @!attribute [rw] evaluation_results
573
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationResult>]
574
+ # The list of evaluation results.
575
+ # @!attribute [rw] next_page_token
576
+ # @return [::String]
577
+ # A token that can be sent as
578
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationResultsRequest#page_token ListEvaluationResultsRequest.page_token}
579
+ # to retrieve the next page. Absence of this field indicates there are no
580
+ # subsequent pages.
581
+ class ListEvaluationResultsResponse
582
+ include ::Google::Protobuf::MessageExts
583
+ extend ::Google::Protobuf::MessageExts::ClassMethods
584
+ end
585
+
586
+ # Response message for
587
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_datasets EvaluationService.ListEvaluationDatasets}.
588
+ # @!attribute [rw] evaluation_datasets
589
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationDataset>]
590
+ # The list of evaluation datasets.
591
+ # @!attribute [rw] next_page_token
592
+ # @return [::String]
593
+ # A token that can be sent as
594
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationDatasetsRequest#page_token ListEvaluationDatasetsRequest.page_token}
595
+ # to retrieve the next page. Absence of this field indicates there are no
596
+ # subsequent pages.
597
+ class ListEvaluationDatasetsResponse
598
+ include ::Google::Protobuf::MessageExts
599
+ extend ::Google::Protobuf::MessageExts::ClassMethods
600
+ end
601
+
602
+ # Response message for
603
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_runs EvaluationService.ListEvaluationRuns}.
604
+ # @!attribute [rw] evaluation_runs
605
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationRun>]
606
+ # The list of evaluation runs.
607
+ # @!attribute [rw] next_page_token
608
+ # @return [::String]
609
+ # A token that can be sent as
610
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationRunsRequest#page_token ListEvaluationRunsRequest.page_token}
611
+ # to retrieve the next page. Absence of this field indicates there are no
612
+ # subsequent pages.
613
+ class ListEvaluationRunsResponse
614
+ include ::Google::Protobuf::MessageExts
615
+ extend ::Google::Protobuf::MessageExts::ClassMethods
616
+ end
617
+
618
+ # Request message for
619
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#create_scheduled_evaluation_run EvaluationService.CreateScheduledEvaluationRun}.
620
+ # @!attribute [rw] parent
621
+ # @return [::String]
622
+ # Required. The app to create the scheduled evaluation run for.
623
+ # Format:
624
+ # `projects/{project}/locations/{location}/apps/{app}`
625
+ # @!attribute [rw] scheduled_evaluation_run_id
626
+ # @return [::String]
627
+ # Optional. The ID to use for the scheduled evaluation run, which will become
628
+ # the final component of the scheduled evaluation run's resource name. If not
629
+ # provided, a unique ID will be automatically assigned.
630
+ # @!attribute [rw] scheduled_evaluation_run
631
+ # @return [::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun]
632
+ # Required. The scheduled evaluation run to create.
633
+ class CreateScheduledEvaluationRunRequest
634
+ include ::Google::Protobuf::MessageExts
635
+ extend ::Google::Protobuf::MessageExts::ClassMethods
636
+ end
637
+
638
+ # Request message for
639
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_scheduled_evaluation_run EvaluationService.GetScheduledEvaluationRun}.
640
+ # @!attribute [rw] name
641
+ # @return [::String]
642
+ # Required. The resource name of the scheduled evaluation run to retrieve.
643
+ class GetScheduledEvaluationRunRequest
644
+ include ::Google::Protobuf::MessageExts
645
+ extend ::Google::Protobuf::MessageExts::ClassMethods
646
+ end
647
+
648
+ # Request message for
649
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_scheduled_evaluation_runs EvaluationService.ListScheduledEvaluationRuns}.
650
+ # @!attribute [rw] parent
651
+ # @return [::String]
652
+ # Required. The resource name of the app to list scheduled evaluation runs
653
+ # from.
654
+ # @!attribute [rw] page_size
655
+ # @return [::Integer]
656
+ # Optional. Requested page size. Server may return fewer items than
657
+ # requested. If unspecified, server will pick an appropriate default.
658
+ # @!attribute [rw] page_token
659
+ # @return [::String]
660
+ # Optional. The
661
+ # {::Google::Cloud::Ces::V1beta::ListScheduledEvaluationRunsResponse#next_page_token next_page_token}
662
+ # value returned from a previous list
663
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_scheduled_evaluation_runs EvaluationService.ListScheduledEvaluationRuns}
664
+ # call.
665
+ # @!attribute [rw] filter
666
+ # @return [::String]
667
+ # Optional. Filter to be applied when listing the scheduled evaluation runs.
668
+ # See https://google.aip.dev/160 for more details.
669
+ # Currently supports filtering by:
670
+ # * request.evaluations:evaluation_id
671
+ # * request.evaluation_dataset:evaluation_dataset_id
672
+ # @!attribute [rw] order_by
673
+ # @return [::String]
674
+ # Optional. Field to sort by. Supported fields are:
675
+ # "name" (ascending), "create_time" (descending), "update_time" (descending),
676
+ # "next_scheduled_execution" (ascending), and
677
+ # "last_completed_run.create_time" (descending).
678
+ # If not included, "update_time" will be the default.
679
+ # See https://google.aip.dev/132#ordering for more details.
680
+ class ListScheduledEvaluationRunsRequest
681
+ include ::Google::Protobuf::MessageExts
682
+ extend ::Google::Protobuf::MessageExts::ClassMethods
683
+ end
684
+
685
+ # Response message for
686
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_scheduled_evaluation_runs EvaluationService.ListScheduledEvaluationRuns}.
687
+ # @!attribute [rw] scheduled_evaluation_runs
688
+ # @return [::Array<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>]
689
+ # The list of scheduled evaluation runs.
690
+ # @!attribute [rw] next_page_token
691
+ # @return [::String]
692
+ # A token that can be sent as
693
+ # {::Google::Cloud::Ces::V1beta::ListScheduledEvaluationRunsRequest#page_token ListScheduledEvaluationRunsRequest.page_token}
694
+ # to retrieve the next page. Absence of this field indicates there are no
695
+ # subsequent pages.
696
+ class ListScheduledEvaluationRunsResponse
697
+ include ::Google::Protobuf::MessageExts
698
+ extend ::Google::Protobuf::MessageExts::ClassMethods
699
+ end
700
+
701
+ # Request message for
702
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#update_scheduled_evaluation_run EvaluationService.UpdateScheduledEvaluationRun}.
703
+ # @!attribute [rw] scheduled_evaluation_run
704
+ # @return [::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun]
705
+ # Required. The scheduled evaluation run to update.
706
+ # @!attribute [rw] update_mask
707
+ # @return [::Google::Protobuf::FieldMask]
708
+ # Optional. Field mask is used to control which fields get updated. If the
709
+ # mask is not present, all fields will be updated.
710
+ class UpdateScheduledEvaluationRunRequest
711
+ include ::Google::Protobuf::MessageExts
712
+ extend ::Google::Protobuf::MessageExts::ClassMethods
713
+ end
714
+
715
+ # Request message for
716
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_scheduled_evaluation_run EvaluationService.DeleteScheduledEvaluationRun}.
717
+ # @!attribute [rw] name
718
+ # @return [::String]
719
+ # Required. The resource name of the scheduled evaluation run to delete.
720
+ # @!attribute [rw] etag
721
+ # @return [::String]
722
+ # Optional. The etag of the ScheduledEvaluationRun.
723
+ # If provided, it must match the server's etag.
724
+ class DeleteScheduledEvaluationRunRequest
725
+ include ::Google::Protobuf::MessageExts
726
+ extend ::Google::Protobuf::MessageExts::ClassMethods
727
+ end
728
+
729
+ # Request message for
730
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#test_persona_voice EvaluationService.TestPersonaVoice}.
731
+ # @!attribute [rw] app
732
+ # @return [::String]
733
+ # Required. the resource name of the app to test the persona voice for.
734
+ # Format:
735
+ # `projects/{project}/locations/{location}/apps/{app}`
736
+ # @!attribute [rw] persona_id
737
+ # @return [::String]
738
+ # Required. The persona ID to test the voice for. Also accepts "default".
739
+ # @!attribute [rw] text
740
+ # @return [::String]
741
+ # Required. The text to test the voice for.
742
+ class TestPersonaVoiceRequest
743
+ include ::Google::Protobuf::MessageExts
744
+ extend ::Google::Protobuf::MessageExts::ClassMethods
745
+ end
746
+
747
+ # Request message for
748
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#upload_evaluation_audio EvaluationService.UploadEvaluationAudio}.
749
+ # @!attribute [rw] name
750
+ # @return [::String]
751
+ # Required. The resource name of the Evaluation for which to upload the
752
+ # evaluation audio. Format:
753
+ # `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
754
+ # @!attribute [rw] audio_content
755
+ # @return [::String]
756
+ # Required. The raw audio bytes.
757
+ # The format of the audio must be single-channel LINEAR16 with a sample
758
+ # rate of 16kHz (default InputAudioConfig).
759
+ # @!attribute [rw] previous_audio_gcs_uri
760
+ # @return [::String]
761
+ # Optional. The Google Cloud Storage URI of the previously uploaded audio
762
+ # file to be deleted. Format: `gs://<bucket-name>/<object-name>`
763
+ class UploadEvaluationAudioRequest
764
+ include ::Google::Protobuf::MessageExts
765
+ extend ::Google::Protobuf::MessageExts::ClassMethods
766
+ end
767
+
768
+ # Response message for
769
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#upload_evaluation_audio EvaluationService.UploadEvaluationAudio}.
770
+ # @!attribute [rw] audio_gcs_uri
771
+ # @return [::String]
772
+ # The Google Cloud Storage URI where the uploaded audio file is stored.
773
+ # Format: `gs://<bucket-name>/<object-name>`
774
+ # @!attribute [rw] transcript
775
+ # @return [::String]
776
+ # The transcript of the audio, generated by Cloud Speech-to-Text.
777
+ # @!attribute [rw] duration
778
+ # @return [::Google::Protobuf::Duration]
779
+ # The duration of the audio.
780
+ class UploadEvaluationAudioResponse
781
+ include ::Google::Protobuf::MessageExts
782
+ extend ::Google::Protobuf::MessageExts::ClassMethods
783
+ end
784
+
785
+ # Response message for
786
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#test_persona_voice EvaluationService.TestPersonaVoice}.
787
+ # @!attribute [rw] audio
788
+ # @return [::String]
789
+ # The audio data bytes of the synthesized voice.
790
+ class TestPersonaVoiceResponse
791
+ include ::Google::Protobuf::MessageExts
792
+ extend ::Google::Protobuf::MessageExts::ClassMethods
793
+ end
794
+
795
+ # Request message for
796
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#create_evaluation_expectation EvaluationService.CreateEvaluationExpectation}.
797
+ # @!attribute [rw] parent
798
+ # @return [::String]
799
+ # Required. The app to create the evaluation expectation for.
800
+ # Format:
801
+ # `projects/{project}/locations/{location}/apps/{app}`
802
+ # @!attribute [rw] evaluation_expectation_id
803
+ # @return [::String]
804
+ # Optional. The ID to use for the evaluation expectation, which will become
805
+ # the final component of the evaluation expectation's resource name. If not
806
+ # provided, a unique ID will be automatically assigned for the evaluation
807
+ # expectation.
808
+ # @!attribute [rw] evaluation_expectation
809
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationExpectation]
810
+ # Required. The evaluation expectation to create.
811
+ class CreateEvaluationExpectationRequest
812
+ include ::Google::Protobuf::MessageExts
813
+ extend ::Google::Protobuf::MessageExts::ClassMethods
814
+ end
815
+
816
+ # Request message for
817
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#update_evaluation_expectation EvaluationService.UpdateEvaluationExpectation}.
818
+ # @!attribute [rw] evaluation_expectation
819
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationExpectation]
820
+ # Required. The evaluation expectation to update.
821
+ # @!attribute [rw] update_mask
822
+ # @return [::Google::Protobuf::FieldMask]
823
+ # Optional. Field mask is used to control which fields get updated. If the
824
+ # mask is not present, all fields will be updated.
825
+ class UpdateEvaluationExpectationRequest
826
+ include ::Google::Protobuf::MessageExts
827
+ extend ::Google::Protobuf::MessageExts::ClassMethods
828
+ end
829
+
830
+ # Request message for
831
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#delete_evaluation_expectation EvaluationService.DeleteEvaluationExpectation}.
832
+ # @!attribute [rw] name
833
+ # @return [::String]
834
+ # Required. The resource name of the evaluation expectation to delete.
835
+ # @!attribute [rw] etag
836
+ # @return [::String]
837
+ # Optional. The current etag of the evaluation expectation. If an etag is not
838
+ # provided, the deletion will overwrite any concurrent changes. If an etag is
839
+ # provided and does not match the current etag of the evaluation expectation,
840
+ # deletion will be blocked and an ABORTED error will be returned.
841
+ class DeleteEvaluationExpectationRequest
842
+ include ::Google::Protobuf::MessageExts
843
+ extend ::Google::Protobuf::MessageExts::ClassMethods
844
+ end
845
+
846
+ # Request message for
847
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#get_evaluation_expectation EvaluationService.GetEvaluationExpectation}.
848
+ # @!attribute [rw] name
849
+ # @return [::String]
850
+ # Required. The resource name of the evaluation expectation to retrieve.
851
+ class GetEvaluationExpectationRequest
852
+ include ::Google::Protobuf::MessageExts
853
+ extend ::Google::Protobuf::MessageExts::ClassMethods
854
+ end
855
+
856
+ # Request message for
857
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_expectations EvaluationService.ListEvaluationExpectations}.
858
+ # @!attribute [rw] parent
859
+ # @return [::String]
860
+ # Required. The resource name of the app to list evaluation expectations
861
+ # from.
862
+ # @!attribute [rw] page_size
863
+ # @return [::Integer]
864
+ # Optional. Requested page size. Server may return fewer items than
865
+ # requested. If unspecified, server will pick an appropriate default.
866
+ # @!attribute [rw] page_token
867
+ # @return [::String]
868
+ # Optional. The
869
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationExpectationsResponse#next_page_token next_page_token}
870
+ # value returned from a previous list
871
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_expectations EvaluationService.ListEvaluationExpectations}
872
+ # call.
873
+ # @!attribute [rw] filter
874
+ # @return [::String]
875
+ # Optional. Filter to be applied when listing the evaluation expectations.
876
+ # See https://google.aip.dev/160 for more details.
877
+ # @!attribute [rw] order_by
878
+ # @return [::String]
879
+ # Optional. Field to sort by. Only "name" and "create_time", and
880
+ # "update_time" are supported. Time fields are ordered in descending order,
881
+ # and the name field is ordered in ascending order. If not included,
882
+ # "update_time" will be the default. See https://google.aip.dev/132#ordering
883
+ # for more details.
884
+ class ListEvaluationExpectationsRequest
885
+ include ::Google::Protobuf::MessageExts
886
+ extend ::Google::Protobuf::MessageExts::ClassMethods
887
+ end
888
+
889
+ # Response message for
890
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#list_evaluation_expectations EvaluationService.ListEvaluationExpectations}.
891
+ # @!attribute [rw] evaluation_expectations
892
+ # @return [::Array<::Google::Cloud::Ces::V1beta::EvaluationExpectation>]
893
+ # The list of evaluation expectations.
894
+ # @!attribute [rw] next_page_token
895
+ # @return [::String]
896
+ # A token that can be sent as
897
+ # {::Google::Cloud::Ces::V1beta::ListEvaluationExpectationsRequest#page_token ListEvaluationExpectationsRequest.page_token}
898
+ # to retrieve the next page. Absence of this field indicates there are no
899
+ # subsequent pages.
900
+ class ListEvaluationExpectationsResponse
901
+ include ::Google::Protobuf::MessageExts
902
+ extend ::Google::Protobuf::MessageExts::ClassMethods
903
+ end
904
+
905
+ # Options for exporting CES evaluation resources.
906
+ # @!attribute [rw] export_format
907
+ # @return [::Google::Cloud::Ces::V1beta::ExportOptions::ExportFormat]
908
+ # Optional. The format to export the evaluation results in. Defaults to JSON
909
+ # if not specified.
910
+ # @!attribute [rw] gcs_uri
911
+ # @return [::String]
912
+ # Optional. The Google Cloud Storage URI to write the exported Evaluation
913
+ # Results to.
914
+ class ExportOptions
915
+ include ::Google::Protobuf::MessageExts
916
+ extend ::Google::Protobuf::MessageExts::ClassMethods
917
+
918
+ # The format to export the items in. Defaults to JSON if not
919
+ # specified.
920
+ module ExportFormat
921
+ # Unspecified format.
922
+ EXPORT_FORMAT_UNSPECIFIED = 0
923
+
924
+ # JSON format.
925
+ JSON = 1
926
+
927
+ # YAML format.
928
+ YAML = 2
929
+ end
930
+ end
931
+
932
+ # Request message for
933
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluations EvaluationService.ExportEvaluations}.
934
+ # @!attribute [rw] parent
935
+ # @return [::String]
936
+ # Required. The resource name of the app to export evaluations from.
937
+ # Format: `projects/{project}/locations/{location}/apps/{app}`
938
+ # @!attribute [rw] names
939
+ # @return [::Array<::String>]
940
+ # Required. The resource names of the evaluations to export.
941
+ # @!attribute [rw] export_options
942
+ # @return [::Google::Cloud::Ces::V1beta::ExportOptions]
943
+ # Optional. The export options for the evaluations.
944
+ # @!attribute [rw] include_evaluation_results
945
+ # @return [::Boolean]
946
+ # Optional. Includes evaluation results in the export. At least one of
947
+ # include_evaluation_results or include_evaluations must be set.
948
+ # @!attribute [rw] include_evaluations
949
+ # @return [::Boolean]
950
+ # Optional. Includes evaluations in the export. At least one of
951
+ # include_evaluation_results or include_evaluations must be set.
952
+ class ExportEvaluationsRequest
953
+ include ::Google::Protobuf::MessageExts
954
+ extend ::Google::Protobuf::MessageExts::ClassMethods
955
+ end
956
+
957
+ # Response message for
958
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluations EvaluationService.ExportEvaluations}.
959
+ # @!attribute [rw] evaluations_content
960
+ # @return [::String]
961
+ # The content of the exported Evaluations. This will be populated if
962
+ # gcs_uri was not specified in the request.
963
+ #
964
+ # Note: The following fields are mutually exclusive: `evaluations_content`, `evaluations_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
965
+ # @!attribute [rw] evaluations_uri
966
+ # @return [::String]
967
+ # The Google Cloud Storage URI folder where the exported evaluations were
968
+ # written. This will be populated if gcs_uri was specified in the request.
969
+ #
970
+ # Note: The following fields are mutually exclusive: `evaluations_uri`, `evaluations_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
971
+ # @!attribute [r] failed_evaluations
972
+ # @return [::Google::Protobuf::Map{::String => ::String}]
973
+ # Output only. A map of evaluation resource names that could not be exported,
974
+ # to the reason why they failed.
975
+ class ExportEvaluationsResponse
976
+ include ::Google::Protobuf::MessageExts
977
+ extend ::Google::Protobuf::MessageExts::ClassMethods
978
+
979
+ # @!attribute [rw] key
980
+ # @return [::String]
981
+ # @!attribute [rw] value
982
+ # @return [::String]
983
+ class FailedEvaluationsEntry
984
+ include ::Google::Protobuf::MessageExts
985
+ extend ::Google::Protobuf::MessageExts::ClassMethods
986
+ end
987
+ end
988
+
989
+ # Request message for
990
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_results EvaluationService.ExportEvaluationResults}.
991
+ # @!attribute [rw] parent
992
+ # @return [::String]
993
+ # Required. The resource name of the evaluation to export evaluation results
994
+ # from. Format:
995
+ # `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
996
+ # @!attribute [rw] names
997
+ # @return [::Array<::String>]
998
+ # Required. The resource names of the evaluation results to export.
999
+ # @!attribute [rw] export_options
1000
+ # @return [::Google::Cloud::Ces::V1beta::ExportOptions]
1001
+ # Optional. The export options for the evaluation results.
1002
+ class ExportEvaluationResultsRequest
1003
+ include ::Google::Protobuf::MessageExts
1004
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1005
+ end
1006
+
1007
+ # Response message for
1008
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_results EvaluationService.ExportEvaluationResults}.
1009
+ # @!attribute [rw] evaluation_results_content
1010
+ # @return [::String]
1011
+ # The content of the exported Evaluation Results. This will be populated if
1012
+ # gcs_uri was not specified in the request.
1013
+ #
1014
+ # Note: The following fields are mutually exclusive: `evaluation_results_content`, `evaluation_results_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1015
+ # @!attribute [rw] evaluation_results_uri
1016
+ # @return [::String]
1017
+ # The Google Cloud Storage URI folder where the exported Evaluation Results
1018
+ # were written. This will be populated if gcs_uri was specified in the
1019
+ # request.
1020
+ #
1021
+ # Note: The following fields are mutually exclusive: `evaluation_results_uri`, `evaluation_results_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1022
+ class ExportEvaluationResultsResponse
1023
+ include ::Google::Protobuf::MessageExts
1024
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1025
+ end
1026
+
1027
+ # Request message for
1028
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_runs EvaluationService.ExportEvaluationRuns}.
1029
+ # @!attribute [rw] parent
1030
+ # @return [::String]
1031
+ # Required. The resource name of the app to export evaluation runs from.
1032
+ # Format: `projects/{project}/locations/{location}/apps/{app}`
1033
+ # @!attribute [rw] names
1034
+ # @return [::Array<::String>]
1035
+ # Required. The resource names of the evaluation runs to export.
1036
+ # @!attribute [rw] export_options
1037
+ # @return [::Google::Cloud::Ces::V1beta::ExportOptions]
1038
+ # Optional. The export options for the evaluation runs.
1039
+ class ExportEvaluationRunsRequest
1040
+ include ::Google::Protobuf::MessageExts
1041
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1042
+ end
1043
+
1044
+ # Response message for
1045
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_runs EvaluationService.ExportEvaluationRuns}.
1046
+ # @!attribute [rw] evaluation_runs_content
1047
+ # @return [::String]
1048
+ # The content of the exported Evaluation Runs. This will be populated if
1049
+ # gcs_uri was not specified in the request.
1050
+ #
1051
+ # Note: The following fields are mutually exclusive: `evaluation_runs_content`, `evaluation_runs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1052
+ # @!attribute [rw] evaluation_runs_uri
1053
+ # @return [::String]
1054
+ # The Google Cloud Storage URI folder where the exported Evaluation Runs
1055
+ # were written. This will be populated if gcs_uri was specified in the
1056
+ # request.
1057
+ #
1058
+ # Note: The following fields are mutually exclusive: `evaluation_runs_uri`, `evaluation_runs_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1059
+ class ExportEvaluationRunsResponse
1060
+ include ::Google::Protobuf::MessageExts
1061
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1062
+ end
1063
+
1064
+ # Operation metadata for
1065
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_runs EvaluationService.ExportEvaluationRuns}.
1066
+ class ExportEvaluationRunsOperationMetadata
1067
+ include ::Google::Protobuf::MessageExts
1068
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1069
+ end
1070
+
1071
+ # Operation metadata for
1072
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_results EvaluationService.ExportEvaluationResults}.
1073
+ class ExportEvaluationResultsOperationMetadata
1074
+ include ::Google::Protobuf::MessageExts
1075
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1076
+ end
1077
+
1078
+ # Operation metadata for
1079
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation_result_metrics EvaluationService.RunEvaluationResultMetrics}.
1080
+ class RunEvaluationResultMetricsOperationMetadata
1081
+ include ::Google::Protobuf::MessageExts
1082
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1083
+ end
1084
+ end
1085
+ end
1086
+ end
1087
+ end