google-cloud-ces-v1beta 0.1.0 → 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 (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/ces/v1beta/agent_card_pb.rb +26 -0
  4. data/lib/google/cloud/ces/v1beta/agent_pb.rb +1 -1
  5. data/lib/google/cloud/ces/v1beta/agent_service/client.rb +10 -4
  6. data/lib/google/cloud/ces/v1beta/agent_service/operations.rb +2 -0
  7. data/lib/google/cloud/ces/v1beta/agent_service/rest/client.rb +10 -4
  8. data/lib/google/cloud/ces/v1beta/agent_service/rest/operations.rb +2 -0
  9. data/lib/google/cloud/ces/v1beta/agent_service_pb.rb +2 -1
  10. data/lib/google/cloud/ces/v1beta/app_pb.rb +4 -1
  11. data/lib/google/cloud/ces/v1beta/conversation_pb.rb +1 -1
  12. data/lib/google/cloud/ces/v1beta/deployment_pb.rb +5 -1
  13. data/lib/google/cloud/ces/v1beta/evaluation_metrics_config_pb.rb +31 -0
  14. data/lib/google/cloud/ces/v1beta/evaluation_pb.rb +2 -1
  15. data/lib/google/cloud/ces/v1beta/evaluation_service/client.rb +318 -0
  16. data/lib/google/cloud/ces/v1beta/evaluation_service/operations.rb +2 -0
  17. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb +297 -0
  18. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/operations.rb +2 -0
  19. data/lib/google/cloud/ces/v1beta/evaluation_service/rest/service_stub.rb +186 -0
  20. data/lib/google/cloud/ces/v1beta/evaluation_service_pb.rb +8 -1
  21. data/lib/google/cloud/ces/v1beta/evaluation_service_services_pb.rb +6 -0
  22. data/lib/google/cloud/ces/v1beta/mcp_tool_pb.rb +2 -1
  23. data/lib/google/cloud/ces/v1beta/mcp_toolset_pb.rb +4 -1
  24. data/lib/google/cloud/ces/v1beta/python_function_pb.rb +2 -1
  25. data/lib/google/cloud/ces/v1beta/session_service/client.rb +2 -0
  26. data/lib/google/cloud/ces/v1beta/session_service/rest/client.rb +2 -0
  27. data/lib/google/cloud/ces/v1beta/session_service_pb.rb +2 -1
  28. data/lib/google/cloud/ces/v1beta/tool_pb.rb +3 -1
  29. data/lib/google/cloud/ces/v1beta/tool_service/client.rb +7 -1
  30. data/lib/google/cloud/ces/v1beta/tool_service/rest/client.rb +7 -1
  31. data/lib/google/cloud/ces/v1beta/tool_service_pb.rb +2 -1
  32. data/lib/google/cloud/ces/v1beta/version.rb +1 -1
  33. data/lib/google/cloud/ces/v1beta/widget_service/client.rb +2 -0
  34. data/lib/google/cloud/ces/v1beta/widget_service/rest/client.rb +2 -0
  35. data/lib/google/cloud/ces/v1beta/widget_tool_pb.rb +3 -1
  36. data/proto_docs/google/cloud/ces/v1beta/agent.rb +9 -0
  37. data/proto_docs/google/cloud/ces/v1beta/agent_card.rb +122 -0
  38. data/proto_docs/google/cloud/ces/v1beta/agent_service.rb +24 -3
  39. data/proto_docs/google/cloud/ces/v1beta/app.rb +50 -3
  40. data/proto_docs/google/cloud/ces/v1beta/conversation.rb +9 -6
  41. data/proto_docs/google/cloud/ces/v1beta/deployment.rb +61 -0
  42. data/proto_docs/google/cloud/ces/v1beta/evaluation.rb +82 -13
  43. data/proto_docs/google/cloud/ces/v1beta/evaluation_metrics_config.rb +151 -0
  44. data/proto_docs/google/cloud/ces/v1beta/evaluation_service.rb +80 -2
  45. data/proto_docs/google/cloud/ces/v1beta/mcp_tool.rb +25 -0
  46. data/proto_docs/google/cloud/ces/v1beta/mcp_toolset.rb +47 -0
  47. data/proto_docs/google/cloud/ces/v1beta/python_function.rb +3 -0
  48. data/proto_docs/google/cloud/ces/v1beta/session_service.rb +3 -0
  49. data/proto_docs/google/cloud/ces/v1beta/tool.rb +21 -11
  50. data/proto_docs/google/cloud/ces/v1beta/tool_service.rb +12 -0
  51. data/proto_docs/google/cloud/ces/v1beta/widget_tool.rb +36 -0
  52. metadata +7 -3
@@ -0,0 +1,151 @@
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
+ # Configures the metrics for an evaluation.
25
+ # @!attribute [rw] golden_metrics_config
26
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::GoldenMetricsConfig]
27
+ # Optional. Configuration for the golden metrics for the evaluation.
28
+ # @!attribute [rw] scenario_metrics_config
29
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ScenarioMetricsConfig]
30
+ # Optional. Configuration for the scenario metrics for the evaluation.
31
+ class EvaluationMetricsConfig
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+
35
+ # Configuration for similarity metrics for the evaluation.
36
+ # To disable the metric, set the message but do not set the
37
+ # `enable_semantic_similarity_metrics` field to true (or explicitly set it to
38
+ # false). To unset the configuration and fallback to the default behavior,
39
+ # omit the message entirely.
40
+ # @!attribute [rw] enable_semantic_similarity_metrics
41
+ # @return [::Boolean]
42
+ # Optional. Whether to calculate semantic similarity metrics for the
43
+ # evaluation.
44
+ class SemanticSimilarityMetricsConfig
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
49
+ # Configuration for correctness metrics for the evaluation.
50
+ # To disable the metric, set the message but do not set the
51
+ # `enable_tool_correctness_metrics` field to true (or explicitly set it to
52
+ # false). To unset the configuration and fallback to the default behavior,
53
+ # omit the message entirely.
54
+ # @!attribute [rw] enable_tool_correctness_metrics
55
+ # @return [::Boolean]
56
+ # Optional. Whether to calculate tool correctness metrics for the
57
+ # evaluation.
58
+ class ToolCorrectnessMetricsConfig
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+ end
62
+
63
+ # Configuration for the hallucination metrics for the evaluation.
64
+ # To disable the metric, set the message but do not set the
65
+ # `enable_hallucination_metrics` field to true (or explicitly set it to
66
+ # false). To unset the configuration and fallback to the default behavior,
67
+ # omit the message entirely.
68
+ # @!attribute [rw] enable_hallucination_metrics
69
+ # @return [::Boolean]
70
+ # Optional. Whether to calculate hallucination metrics for the evaluation.
71
+ class HallucinationMetricsConfig
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+
76
+ # Configuration for the user goal met metrics for the evaluation.
77
+ # To disable the metric, set the message but do not set the
78
+ # `enable_user_goal_met_metrics` field to true (or explicitly set it to
79
+ # false). To unset the configuration and fallback to the default behavior,
80
+ # omit the message entirely.
81
+ # @!attribute [rw] enable_user_goal_met_metrics
82
+ # @return [::Boolean]
83
+ # Optional. Whether to calculate the user goal met metrics for the
84
+ # evaluation.
85
+ class UserGoalMetMetricsConfig
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
89
+
90
+ # Configuration for the expectation level metrics for the evaluation.
91
+ # To disable the metric, set the message but do not set the
92
+ # `enable_expectations_met_metrics` field to true (or explicitly set it to
93
+ # false). To unset the configuration and fallback to the default behavior,
94
+ # omit the message entirely.
95
+ # @!attribute [rw] enable_expectations_met_metrics
96
+ # @return [::Boolean]
97
+ # Optional. Whether to calculate the expectation level metrics for the
98
+ # evaluation.
99
+ class ExpectationsMetMetricsConfig
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+
104
+ # Configuration for the golden metrics for the evaluation.
105
+ # @!attribute [rw] semantic_similarity_metrics_config
106
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::SemanticSimilarityMetricsConfig]
107
+ # Optional. Global configuration for semantic similarity metrics.
108
+ # @!attribute [rw] tool_correctness_metrics_config
109
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ToolCorrectnessMetricsConfig]
110
+ # Optional. Configuration for turn level tool correctness metrics.
111
+ # @!attribute [rw] step_tool_correctness_metrics_config
112
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ToolCorrectnessMetricsConfig]
113
+ # Optional. Configuration for step level tool correctness metrics.
114
+ class GoldenMetricsConfig
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Configuration for the scenario metrics for the evaluation.
120
+ # @!attribute [rw] user_goal_met_metrics_config
121
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::UserGoalMetMetricsConfig]
122
+ # Optional. Configuration for user goal met metrics.
123
+ # @!attribute [rw] expectations_met_metrics_config
124
+ # @return [::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig::ExpectationsMetMetricsConfig]
125
+ # Optional. Configuration for expectation level metrics.
126
+ class ScenarioMetricsConfig
127
+ include ::Google::Protobuf::MessageExts
128
+ extend ::Google::Protobuf::MessageExts::ClassMethods
129
+ end
130
+
131
+ # Supported comparison types for checking the agent's response.
132
+ module ComparisonType
133
+ # Unspecified comparison type. Behavior defaults to SEMANTIC_SIMILARITY
134
+ # for agent responses and tool calls.
135
+ COMPARISON_TYPE_UNSPECIFIED = 0
136
+
137
+ # Exact string match.
138
+ EQUALS = 1
139
+
140
+ # Substring match (checks if the expected string is contained in the
141
+ # actual response).
142
+ CONTAINS = 2
143
+
144
+ # Semantic similarity match (evaluates meaning similarity using an LLM).
145
+ SEMANTIC_SIMILARITY = 3
146
+ end
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -21,6 +21,28 @@ module Google
21
21
  module Cloud
22
22
  module Ces
23
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
+
24
46
  # Response message for
25
47
  # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#run_evaluation EvaluationService.RunEvaluation}.
26
48
  # @!attribute [rw] evaluation_run
@@ -964,8 +986,26 @@ module Google
964
986
  end
965
987
  end
966
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
+
967
1007
  # Response message for
968
- # [EvaluationService.ExportEvaluationResults][google.cloud.ces.v1beta.EvaluationService.ExportEvaluationResults].
1008
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_results EvaluationService.ExportEvaluationResults}.
969
1009
  # @!attribute [rw] evaluation_results_content
970
1010
  # @return [::String]
971
1011
  # The content of the exported Evaluation Results. This will be populated if
@@ -984,8 +1024,25 @@ module Google
984
1024
  extend ::Google::Protobuf::MessageExts::ClassMethods
985
1025
  end
986
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
+
987
1044
  # Response message for
988
- # [EvaluationService.ExportEvaluationRuns][google.cloud.ces.v1beta.EvaluationService.ExportEvaluationRuns].
1045
+ # {::Google::Cloud::Ces::V1beta::EvaluationService::Client#export_evaluation_runs EvaluationService.ExportEvaluationRuns}.
989
1046
  # @!attribute [rw] evaluation_runs_content
990
1047
  # @return [::String]
991
1048
  # The content of the exported Evaluation Runs. This will be populated if
@@ -1003,6 +1060,27 @@ module Google
1003
1060
  include ::Google::Protobuf::MessageExts
1004
1061
  extend ::Google::Protobuf::MessageExts::ClassMethods
1005
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
1006
1084
  end
1007
1085
  end
1008
1086
  end
@@ -27,6 +27,10 @@ module Google
27
27
  # @!attribute [rw] name
28
28
  # @return [::String]
29
29
  # Required. The name of the MCP tool.
30
+ # @!attribute [rw] name_override
31
+ # @return [::String]
32
+ # Optional. The name override of the MCP tool.
33
+ # This is populated if the name was overridden by a Toolset override.
30
34
  # @!attribute [rw] description
31
35
  # @return [::String]
32
36
  # Optional. The description of the MCP tool.
@@ -66,6 +70,10 @@ module Google
66
70
  # can be set in the session variables. See
67
71
  # https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
68
72
  # for more details.
73
+ # @!attribute [r] state
74
+ # @return [::Google::Cloud::Ces::V1beta::McpTool::State]
75
+ # Output only. The dynamic availability state of the tool on the external
76
+ # server.
69
77
  class McpTool
70
78
  include ::Google::Protobuf::MessageExts
71
79
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,6 +86,23 @@ module Google
78
86
  include ::Google::Protobuf::MessageExts
79
87
  extend ::Google::Protobuf::MessageExts::ClassMethods
80
88
  end
89
+
90
+ # Represents the dynamic availability state of the tool.
91
+ module State
92
+ # Default state.
93
+ STATE_UNSPECIFIED = 0
94
+
95
+ # The tool is available and actively offered by the server.
96
+ ACTIVE = 1
97
+
98
+ # The tool is configured or pinned, but currently not offered by the
99
+ # server.
100
+ INACTIVE = 2
101
+
102
+ # The tool exists on the server, but does not match the version on the
103
+ # server.
104
+ STALE = 3
105
+ end
81
106
  end
82
107
  end
83
108
  end
@@ -52,6 +52,11 @@ module Google
52
52
  # can be set in the session variables. See
53
53
  # https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
54
54
  # for more details.
55
+ # @!attribute [rw] tool_overrides
56
+ # @return [::Array<::Google::Cloud::Ces::V1beta::McpToolOverride>]
57
+ # Optional. Overrides for individual tools within this toolset.
58
+ # This allows overriding specific details like descriptions, names,
59
+ # or pinning the tools' states so they aren't fully dynamic.
55
60
  class McpToolset
56
61
  include ::Google::Protobuf::MessageExts
57
62
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -65,6 +70,48 @@ module Google
65
70
  extend ::Google::Protobuf::MessageExts::ClassMethods
66
71
  end
67
72
  end
73
+
74
+ # Overrides associated with a given tool in a Toolset.
75
+ # This enables "pinning" or "overriding" of tool definitions from the external
76
+ # dynamic server.
77
+ # @!attribute [rw] tool
78
+ # @return [::String]
79
+ # Required. The original name of the tool as it is emitted by the MCP server.
80
+ # @!attribute [rw] name_override
81
+ # @return [::String]
82
+ # Optional. If present, this tool uses this name in the Agent instead of the
83
+ # original name. This is primarily used as an alias if the MCP server offers
84
+ # poorly named tools.
85
+ # @!attribute [rw] description_override
86
+ # @return [::String]
87
+ # Optional. If present, this tool uses this description instead of the
88
+ # original description from the server.
89
+ # @!attribute [r] snapshot
90
+ # @return [::Google::Cloud::Ces::V1beta::McpToolDefinition]
91
+ # Output only. If present, this tool is "Pinned" and uses the snapshot values
92
+ # as fallbacks if the server becomes temporarily unavailable or if no
93
+ # Override is present.
94
+ class McpToolOverride
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+ end
98
+
99
+ # Container for a tool's core definition elements that are snapshot.
100
+ # Schemas in the snapshot are used as-is and cannot be overridden.
101
+ # @!attribute [r] description
102
+ # @return [::String]
103
+ # Output only. The description of the MCP tool. This can be overridden
104
+ # by `description_override` in `McpToolOverride`.
105
+ # @!attribute [r] input_schema
106
+ # @return [::Google::Cloud::Ces::V1beta::Schema]
107
+ # Output only. The schema of the input arguments of the MCP tool.
108
+ # @!attribute [r] output_schema
109
+ # @return [::Google::Cloud::Ces::V1beta::Schema]
110
+ # Output only. The schema of the output arguments of the MCP tool.
111
+ class McpToolDefinition
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
68
115
  end
69
116
  end
70
117
  end
@@ -34,6 +34,9 @@ module Google
34
34
  # @return [::String]
35
35
  # Output only. The description of the Python function, parsed from the python
36
36
  # code's docstring.
37
+ # @!attribute [rw] service_directory_config
38
+ # @return [::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig]
39
+ # Optional. Service Directory configuration for the tool.
37
40
  class PythonFunction
38
41
  include ::Google::Protobuf::MessageExts
39
42
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -207,6 +207,9 @@ module Google
207
207
  # @!attribute [rw] text
208
208
  # @return [::String]
209
209
  # Text used for citation.
210
+ # @!attribute [rw] requires_attribution
211
+ # @return [::Boolean]
212
+ # Whether this citation requires attribution to be shown to the end users.
210
213
  class CitedChunk
211
214
  include ::Google::Protobuf::MessageExts
212
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -27,58 +27,63 @@ module Google
27
27
  # @return [::Google::Cloud::Ces::V1beta::ClientFunction]
28
28
  # Optional. The client function.
29
29
  #
30
- # Note: The following fields are mutually exclusive: `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
30
+ # Note: The following fields are mutually exclusive: `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
31
31
  # @!attribute [rw] open_api_tool
32
32
  # @return [::Google::Cloud::Ces::V1beta::OpenApiTool]
33
33
  # Optional. The open API tool.
34
34
  #
35
- # Note: The following fields are mutually exclusive: `open_api_tool`, `client_function`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
35
+ # Note: The following fields are mutually exclusive: `open_api_tool`, `client_function`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
36
36
  # @!attribute [rw] google_search_tool
37
37
  # @return [::Google::Cloud::Ces::V1beta::GoogleSearchTool]
38
38
  # Optional. The google search tool.
39
39
  #
40
- # Note: The following fields are mutually exclusive: `google_search_tool`, `client_function`, `open_api_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
+ # Note: The following fields are mutually exclusive: `google_search_tool`, `client_function`, `open_api_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
41
41
  # @!attribute [rw] connector_tool
42
42
  # @return [::Google::Cloud::Ces::V1beta::ConnectorTool]
43
43
  # Optional. The Integration Connector tool.
44
44
  #
45
- # Note: The following fields are mutually exclusive: `connector_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
+ # Note: The following fields are mutually exclusive: `connector_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
46
46
  # @!attribute [rw] data_store_tool
47
47
  # @return [::Google::Cloud::Ces::V1beta::DataStoreTool]
48
48
  # Optional. The data store tool.
49
49
  #
50
- # Note: The following fields are mutually exclusive: `data_store_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
50
+ # Note: The following fields are mutually exclusive: `data_store_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
51
51
  # @!attribute [rw] python_function
52
52
  # @return [::Google::Cloud::Ces::V1beta::PythonFunction]
53
53
  # Optional. The python function tool.
54
54
  #
55
- # Note: The following fields are mutually exclusive: `python_function`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
55
+ # Note: The following fields are mutually exclusive: `python_function`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
56
  # @!attribute [rw] mcp_tool
57
57
  # @return [::Google::Cloud::Ces::V1beta::McpTool]
58
58
  # Optional. The MCP tool. An MCP tool cannot be created or updated directly
59
59
  # and is managed by the MCP toolset.
60
60
  #
61
- # Note: The following fields are mutually exclusive: `mcp_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
+ # Note: The following fields are mutually exclusive: `mcp_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
62
62
  # @!attribute [rw] file_search_tool
63
63
  # @return [::Google::Cloud::Ces::V1beta::FileSearchTool]
64
64
  # Optional. The file search tool.
65
65
  #
66
- # Note: The following fields are mutually exclusive: `file_search_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
+ # Note: The following fields are mutually exclusive: `file_search_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `system_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
67
67
  # @!attribute [rw] system_tool
68
68
  # @return [::Google::Cloud::Ces::V1beta::SystemTool]
69
69
  # Optional. The system tool.
70
70
  #
71
- # Note: The following fields are mutually exclusive: `system_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
71
+ # Note: The following fields are mutually exclusive: `system_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `agent_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
72
72
  # @!attribute [rw] agent_tool
73
73
  # @return [::Google::Cloud::Ces::V1beta::AgentTool]
74
74
  # Optional. The agent tool.
75
75
  #
76
- # Note: The following fields are mutually exclusive: `agent_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
76
+ # Note: The following fields are mutually exclusive: `agent_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `widget_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
77
77
  # @!attribute [rw] widget_tool
78
78
  # @return [::Google::Cloud::Ces::V1beta::WidgetTool]
79
79
  # Optional. The widget tool.
80
80
  #
81
- # Note: The following fields are mutually exclusive: `widget_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
81
+ # Note: The following fields are mutually exclusive: `widget_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `remote_agent_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
82
+ # @!attribute [rw] remote_agent_tool
83
+ # @return [::Google::Cloud::Ces::V1beta::RemoteAgentTool]
84
+ # Optional. The remote agent tool.
85
+ #
86
+ # Note: The following fields are mutually exclusive: `remote_agent_tool`, `client_function`, `open_api_tool`, `google_search_tool`, `connector_tool`, `data_store_tool`, `python_function`, `mcp_tool`, `file_search_tool`, `system_tool`, `agent_tool`, `widget_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
82
87
  # @!attribute [rw] name
83
88
  # @return [::String]
84
89
  # Identifier. The resource name of the tool. Format:
@@ -98,6 +103,11 @@ module Google
98
103
  # @!attribute [rw] execution_type
99
104
  # @return [::Google::Cloud::Ces::V1beta::ExecutionType]
100
105
  # Optional. The execution type of the tool.
106
+ # @!attribute [rw] timeout
107
+ # @return [::Google::Protobuf::Duration]
108
+ # Optional. The timeout for the tool execution. If not set, the default
109
+ # timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for
110
+ # `ASYNCHRONOUS` tools.
101
111
  # @!attribute [r] create_time
102
112
  # @return [::Google::Protobuf::Timestamp]
103
113
  # Output only. Timestamp when the tool was created.
@@ -88,6 +88,13 @@ module Google
88
88
  # @!attribute [rw] variables
89
89
  # @return [::Google::Protobuf::Struct]
90
90
  # The variable values at the end of the tool execution.
91
+ # @!attribute [rw] citations
92
+ # @return [::Google::Cloud::Ces::V1beta::Citations]
93
+ # Citations that provide the source information for the tool's execution.
94
+ # @!attribute [rw] google_search_suggestions
95
+ # @return [::Google::Cloud::Ces::V1beta::GoogleSearchSuggestions]
96
+ # The suggestions returned from Google Search as a result of invoking the
97
+ # Google Search Tool during the tool execution.
91
98
  class ExecuteToolResponse
92
99
  include ::Google::Protobuf::MessageExts
93
100
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -153,6 +160,11 @@ module Google
153
160
  # @return [::Array<::String>]
154
161
  # Optional. The identifiers of the tools to retrieve from the toolset.
155
162
  # If empty, all tools in the toolset will be returned.
163
+ # @!attribute [rw] bypass_persistence_config
164
+ # @return [::Boolean]
165
+ # Optional. If true, the returned tools will contain raw descriptions and
166
+ # schemas directly from the server, bypassing any stored persistence
167
+ # configurations (overrides/snapshots).
156
168
  class RetrieveToolsRequest
157
169
  include ::Google::Protobuf::MessageExts
158
170
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -45,10 +45,46 @@ module Google
45
45
  # @return [::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping]
46
46
  # Optional. The mapping that defines how data from a source tool is mapped to
47
47
  # the widget's input parameters.
48
+ # @!attribute [rw] text_response_config
49
+ # @return [::Google::Cloud::Ces::V1beta::WidgetTool::TextResponseConfig]
50
+ # Optional. Configuration for always-included text responses.
48
51
  class WidgetTool
49
52
  include ::Google::Protobuf::MessageExts
50
53
  extend ::Google::Protobuf::MessageExts::ClassMethods
51
54
 
55
+ # Configuration for the text response returned with the widget.
56
+ # @!attribute [rw] type
57
+ # @return [::Google::Cloud::Ces::V1beta::WidgetTool::TextResponseConfig::Type]
58
+ # Optional. The strategy for providing the text response.
59
+ # @!attribute [rw] static_text
60
+ # @return [::String]
61
+ # Optional. The static text response to return when type is STATIC.
62
+ # @!attribute [rw] text_response_instruction
63
+ # @return [::String]
64
+ # Optional. Instruction for the LLM on how to generate the text response.
65
+ # Used as the description for the text response parameter if type is
66
+ # LLM_GENERATED.
67
+ class TextResponseConfig
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+
71
+ # Defines how the text response is produced.
72
+ module Type
73
+ # Unspecified type.
74
+ TYPE_UNSPECIFIED = 0
75
+
76
+ # The LLM dynamically decides whether to generate a text response
77
+ # alongside the widget based on the conversation context.
78
+ NONE = 1
79
+
80
+ # The LLM is explicitly required to generate a text response.
81
+ LLM_GENERATED = 2
82
+
83
+ # A pre-defined static text response is always used.
84
+ STATIC = 3
85
+ end
86
+ end
87
+
52
88
  # Configuration for mapping data from a source tool to the widget's input
53
89
  # parameters.
54
90
  # @!attribute [rw] source_tool_name
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-ces-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -15,14 +15,14 @@ dependencies:
15
15
  requirements:
16
16
  - - "~>"
17
17
  - !ruby/object:Gem::Version
18
- version: '1.2'
18
+ version: '1.3'
19
19
  type: :runtime
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
23
  - - "~>"
24
24
  - !ruby/object:Gem::Version
25
- version: '1.2'
25
+ version: '1.3'
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: google-cloud-errors
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,7 @@ files:
66
66
  - README.md
67
67
  - lib/google-cloud-ces-v1beta.rb
68
68
  - lib/google/cloud/ces/v1beta.rb
69
+ - lib/google/cloud/ces/v1beta/agent_card_pb.rb
69
70
  - lib/google/cloud/ces/v1beta/agent_pb.rb
70
71
  - lib/google/cloud/ces/v1beta/agent_service.rb
71
72
  - lib/google/cloud/ces/v1beta/agent_service/client.rb
@@ -94,6 +95,7 @@ files:
94
95
  - lib/google/cloud/ces/v1beta/data_store_pb.rb
95
96
  - lib/google/cloud/ces/v1beta/data_store_tool_pb.rb
96
97
  - lib/google/cloud/ces/v1beta/deployment_pb.rb
98
+ - lib/google/cloud/ces/v1beta/evaluation_metrics_config_pb.rb
97
99
  - lib/google/cloud/ces/v1beta/evaluation_pb.rb
98
100
  - lib/google/cloud/ces/v1beta/evaluation_service.rb
99
101
  - lib/google/cloud/ces/v1beta/evaluation_service/client.rb
@@ -164,6 +166,7 @@ files:
164
166
  - proto_docs/google/api/launch_stage.rb
165
167
  - proto_docs/google/api/resource.rb
166
168
  - proto_docs/google/cloud/ces/v1beta/agent.rb
169
+ - proto_docs/google/cloud/ces/v1beta/agent_card.rb
167
170
  - proto_docs/google/cloud/ces/v1beta/agent_service.rb
168
171
  - proto_docs/google/cloud/ces/v1beta/agent_tool.rb
169
172
  - proto_docs/google/cloud/ces/v1beta/agent_transfers.rb
@@ -181,6 +184,7 @@ files:
181
184
  - proto_docs/google/cloud/ces/v1beta/data_store_tool.rb
182
185
  - proto_docs/google/cloud/ces/v1beta/deployment.rb
183
186
  - proto_docs/google/cloud/ces/v1beta/evaluation.rb
187
+ - proto_docs/google/cloud/ces/v1beta/evaluation_metrics_config.rb
184
188
  - proto_docs/google/cloud/ces/v1beta/evaluation_service.rb
185
189
  - proto_docs/google/cloud/ces/v1beta/example.rb
186
190
  - proto_docs/google/cloud/ces/v1beta/fakes.rb