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

data/proto_docs/google/cloud/ces/v1beta/tool_service.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1beta
+        # Request message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#execute_tool ToolService.ExecuteTool}.
+        # @!attribute [rw] tool
+        #   @return [::String]
+        #     Optional. The name of the tool to execute.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/apps/\\{app}/tools/\\{tool}
+        #
+        #     Note: The following fields are mutually exclusive: `tool`, `toolset_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] toolset_tool
+        #   @return [::Google::Cloud::Ces::V1beta::ToolsetTool]
+        #     Optional. The toolset tool to execute. Only one tool should match the
+        #     predicate from the toolset. Otherwise, an error will be returned.
+        #
+        #     Note: The following fields are mutually exclusive: `toolset_tool`, `tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] variables
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. The variables that are available for the tool execution.
+        #
+        #     Note: The following fields are mutually exclusive: `variables`, `context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] context
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. The
+        #     [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment
+        #     for details) to be passed to the Python tool.
+        #
+        #     Note: The following fields are mutually exclusive: `context`, `variables`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the app which the tool/toolset belongs to.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}`
+        # @!attribute [rw] args
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. The input parameters and values for the tool in JSON object
+        #     format.
+        # @!attribute [rw] mock_config
+        #   @return [::Google::Cloud::Ces::V1beta::MockConfig]
+        #     Optional. Mock configuration for the tool execution.
+        #     If this field is set, tools that call other tools will be
+        #     mocked based on the provided patterns and responses.
+        class ExecuteToolRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#execute_tool ToolService.ExecuteTool}.
+        # @!attribute [rw] tool
+        #   @return [::String]
+        #     The name of the tool that got executed.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+        #
+        #     Note: The following fields are mutually exclusive: `tool`, `toolset_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] toolset_tool
+        #   @return [::Google::Cloud::Ces::V1beta::ToolsetTool]
+        #     The toolset tool that got executed.
+        #
+        #     Note: The following fields are mutually exclusive: `toolset_tool`, `tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] response
+        #   @return [::Google::Protobuf::Struct]
+        #     The tool execution result in JSON object format.
+        #     Use "output" key to specify tool response and "error" key to specify
+        #     error details (if any). If "output" and "error" keys are not specified,
+        #     then whole "response" is treated as tool execution result.
+        # @!attribute [rw] variables
+        #   @return [::Google::Protobuf::Struct]
+        #     The variable values at the end of the tool execution.
+        # @!attribute [rw] citations
+        #   @return [::Google::Cloud::Ces::V1beta::Citations]
+        #     Citations that provide the source information for the tool's execution.
+        # @!attribute [rw] google_search_suggestions
+        #   @return [::Google::Cloud::Ces::V1beta::GoogleSearchSuggestions]
+        #     The suggestions returned from Google Search as a result of invoking the
+        #     Google Search Tool during the tool execution.
+        class ExecuteToolResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#retrieve_tool_schema ToolService.RetrieveToolSchema}.
+        # @!attribute [rw] tool
+        #   @return [::String]
+        #     Optional. The name of the tool to retrieve the schema for.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/apps/\\{app}/tools/\\{tool}
+        #
+        #     Note: The following fields are mutually exclusive: `tool`, `toolset_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] toolset_tool
+        #   @return [::Google::Cloud::Ces::V1beta::ToolsetTool]
+        #     Optional. The toolset tool to retrieve the schema for. Only one tool
+        #     should match the predicate from the toolset. Otherwise, an error will be
+        #     returned.
+        #
+        #     Note: The following fields are mutually exclusive: `toolset_tool`, `tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the app which the tool/toolset belongs to.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}`
+        class RetrieveToolSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#retrieve_tool_schema ToolService.RetrieveToolSchema}.
+        # @!attribute [rw] tool
+        #   @return [::String]
+        #     The name of the tool that the schema is for.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+        #
+        #     Note: The following fields are mutually exclusive: `tool`, `toolset_tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] toolset_tool
+        #   @return [::Google::Cloud::Ces::V1beta::ToolsetTool]
+        #     The toolset tool that the schema is for.
+        #
+        #     Note: The following fields are mutually exclusive: `toolset_tool`, `tool`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] input_schema
+        #   @return [::Google::Cloud::Ces::V1beta::Schema]
+        #     The schema of the tool input parameters.
+        # @!attribute [rw] output_schema
+        #   @return [::Google::Cloud::Ces::V1beta::Schema]
+        #     The schema of the tool output parameters.
+        class RetrieveToolSchemaResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#retrieve_tools ToolService.RetrieveTools}.
+        # @!attribute [rw] toolset
+        #   @return [::String]
+        #     Required. The name of the toolset to retrieve the tools for.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+        # @!attribute [rw] tool_ids
+        #   @return [::Array<::String>]
+        #     Optional. The identifiers of the tools to retrieve from the toolset.
+        #     If empty, all tools in the toolset will be returned.
+        # @!attribute [rw] bypass_persistence_config
+        #   @return [::Boolean]
+        #     Optional. If true, the returned tools will contain raw descriptions and
+        #     schemas directly from the server, bypassing any stored persistence
+        #     configurations (overrides/snapshots).
+        class RetrieveToolsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Ces::V1beta::ToolService::Client#retrieve_tools ToolService.RetrieveTools}.
+        # @!attribute [rw] tools
+        #   @return [::Array<::Google::Cloud::Ces::V1beta::Tool>]
+        #     The list of tools that are included in the specified toolset.
+        class RetrieveToolsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1beta/toolset.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1beta
+        # A toolset represents a group of dynamically managed tools that can be used
+        # by the agent.
+        # @!attribute [rw] mcp_toolset
+        #   @return [::Google::Cloud::Ces::V1beta::McpToolset]
+        #     Optional. A toolset that contains a list of tools that are offered by the
+        #     MCP server.
+        #
+        #     Note: The following fields are mutually exclusive: `mcp_toolset`, `open_api_toolset`, `connector_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] open_api_toolset
+        #   @return [::Google::Cloud::Ces::V1beta::OpenApiToolset]
+        #     Optional. A toolset that contains a list of tools that are defined by an
+        #     OpenAPI schema.
+        #
+        #     Note: The following fields are mutually exclusive: `open_api_toolset`, `mcp_toolset`, `connector_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] connector_toolset
+        #   @return [::Google::Cloud::Ces::V1beta::ConnectorToolset]
+        #     Optional. A toolset that generates tools from an Integration Connectors
+        #     Connection.
+        #
+        #     Note: The following fields are mutually exclusive: `connector_toolset`, `mcp_toolset`, `open_api_toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The unique identifier of the toolset.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. The display name of the toolset. Must be unique within the same
+        #     app.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the toolset.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the toolset was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the toolset was last updated.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     ETag used to ensure the object hasn't changed during a read-modify-write
+        #     operation. If the etag is empty, the update will overwrite any concurrent
+        #     changes.
+        # @!attribute [rw] execution_type
+        #   @return [::Google::Cloud::Ces::V1beta::ExecutionType]
+        #     Optional. The execution type of the tools in the toolset.
+        # @!attribute [rw] tool_fake_config
+        #   @return [::Google::Cloud::Ces::V1beta::ToolFakeConfig]
+        #     Optional. Configuration for tools behavior in fake mode.
+        class Toolset
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1beta/toolset_tool.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1beta
+        # A tool that is created from a toolset.
+        # @!attribute [rw] toolset
+        #   @return [::String]
+        #     Required. The resource name of the Toolset from which this tool is derived.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+        # @!attribute [rw] tool_id
+        #   @return [::String]
+        #     Optional. The tool ID to filter the tools to retrieve the schema for.
+        class ToolsetTool
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1beta/widget_service.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1beta
+        # Request message for
+        # {::Google::Cloud::Ces::V1beta::WidgetService::Client#generate_chat_token WidgetService.GenerateChatToken}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The session name to generate the chat token for.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/apps/\\{app}/sessions/\\{session}
+        # @!attribute [rw] deployment
+        #   @return [::String]
+        #     Required. The deployment of the app to use for the session.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/apps/\\{app}/deployments/\\{deployment}
+        # @!attribute [rw] recaptcha_token
+        #   @return [::String]
+        #     Optional. The reCAPTCHA token generated by the client-side chat widget.
+        # @!attribute [rw] live_handoff_enabled
+        #   @return [::Boolean]
+        #     Optional. Indicates if live handoff is enabled for the session.
+        class GenerateChatTokenRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Ces::V1beta::WidgetService::Client#generate_chat_token WidgetService.GenerateChatToken}.
+        # @!attribute [rw] chat_token
+        #   @return [::String]
+        #     The session scoped token for chat widget to authenticate with Session APIs.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time at which the chat token expires.
+        class GenerateChatTokenResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1beta/widget_tool.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1beta
+        # Represents a widget tool that the agent can invoke. When the tool is chosen
+        # by the agent, agent will return the widget to the client. The client is
+        # responsible for processing the widget and generating the next user query to
+        # continue the interaction with the agent.
+        # @!attribute [rw] parameters
+        #   @return [::Google::Cloud::Ces::V1beta::Schema]
+        #     Optional. The input parameters of the widget tool.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The display name of the widget tool.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the widget tool.
+        # @!attribute [rw] widget_type
+        #   @return [::Google::Cloud::Ces::V1beta::WidgetTool::WidgetType]
+        #     Optional. The type of the widget tool. If not specified, the default type
+        #     will be CUSTOMIZED.
+        # @!attribute [rw] ui_config
+        #   @return [::Google::Protobuf::Struct]
+        #     Optional. Configuration for rendering the widget.
+        # @!attribute [rw] data_mapping
+        #   @return [::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping]
+        #     Optional. The mapping that defines how data from a source tool is mapped to
+        #     the widget's input parameters.
+        # @!attribute [rw] text_response_config
+        #   @return [::Google::Cloud::Ces::V1beta::WidgetTool::TextResponseConfig]
+        #     Optional. Configuration for always-included text responses.
+        class WidgetTool
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for the text response returned with the widget.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Ces::V1beta::WidgetTool::TextResponseConfig::Type]
+          #     Optional. The strategy for providing the text response.
+          # @!attribute [rw] static_text
+          #   @return [::String]
+          #     Optional. The static text response to return when type is STATIC.
+          # @!attribute [rw] text_response_instruction
+          #   @return [::String]
+          #     Optional. Instruction for the LLM on how to generate the text response.
+          #     Used as the description for the text response parameter if type is
+          #     LLM_GENERATED.
+          class TextResponseConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Defines how the text response is produced.
+            module Type
+              # Unspecified type.
+              TYPE_UNSPECIFIED = 0
+
+              # The LLM dynamically decides whether to generate a text response
+              # alongside the widget based on the conversation context.
+              NONE = 1
+
+              # The LLM is explicitly required to generate a text response.
+              LLM_GENERATED = 2
+
+              # A pre-defined static text response is always used.
+              STATIC = 3
+            end
+          end
+
+          # Configuration for mapping data from a source tool to the widget's input
+          # parameters.
+          # @!attribute [rw] source_tool_name
+          #   @return [::String]
+          #     Optional. The resource name of the tool that provides the data for the
+          #     widget (e.g., a search tool or a custom function). Format:
+          #     `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+          # @!attribute [rw] field_mappings
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. A map of widget input parameter fields to the corresponding
+          #     output fields of the source tool.
+          # @!attribute [rw] python_function
+          #   @return [::Google::Cloud::Ces::V1beta::PythonFunction]
+          #     Optional. Configuration for a Python function used to transform the
+          #     source tool's output into the widget's input format.
+          # @!attribute [rw] mode
+          #   @return [::Google::Cloud::Ces::V1beta::WidgetTool::DataMapping::Mode]
+          #     Optional. The mode of the data mapping.
+          # @!attribute [rw] python_script
+          #   @deprecated This field is deprecated and may be removed in the next major version update.
+          #   @return [::String]
+          #     Deprecated: Use `python_function` instead.
+          class DataMapping
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class FieldMappingsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The strategy used to map data from the source tool to the widget.
+            module Mode
+              # Unspecified mode.
+              MODE_UNSPECIFIED = 0
+
+              # Use the `field_mappings` map for data transformation.
+              FIELD_MAPPING = 1
+
+              # Use the `python_script` for data transformation.
+              PYTHON_SCRIPT = 2
+            end
+          end
+
+          # All available widget types.
+          # New values may be added to this enum in the future.
+          module WidgetType
+            # Unspecified widget type.
+            WIDGET_TYPE_UNSPECIFIED = 0
+
+            # Custom widget type.
+            CUSTOM = 1
+
+            # Product carousel widget.
+            PRODUCT_CAROUSEL = 2
+
+            # Product details widget.
+            PRODUCT_DETAILS = 3
+
+            # Quick actions widget.
+            QUICK_ACTIONS = 4
+
+            # Product comparison widget.
+            PRODUCT_COMPARISON = 5
+
+            # Advanced product details widget.
+            ADVANCED_PRODUCT_DETAILS = 6
+
+            # Short form widget.
+            SHORT_FORM = 7
+
+            # Overall satisfaction widget.
+            OVERALL_SATISFACTION = 8
+
+            # Order summary widget.
+            ORDER_SUMMARY = 9
+
+            # Appointment details widget.
+            APPOINTMENT_DETAILS = 10
+
+            # Appointment scheduler widget.
+            APPOINTMENT_SCHEDULER = 11
+
+            # Contact form widget.
+            CONTACT_FORM = 12
+          end
+        end
+      end
+    end
+  end
+end