google-cloud-ces-v1 0.a → 0.1.0

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# 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 Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don't have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the "Deprecation Policy" section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,227 @@
+# 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     It is the same concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1/agent.rb

@@ -0,0 +1,224 @@
+# 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 V1
+        # An agent acts as the fundamental building block that provides instructions to
+        # the Large Language Model (LLM) for executing specific tasks.
+        # @!attribute [rw] llm_agent
+        #   @return [::Google::Cloud::Ces::V1::Agent::LlmAgent]
+        #     Optional. The default agent type.
+        #
+        #     Note: The following fields are mutually exclusive: `llm_agent`, `remote_dialogflow_agent`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] remote_dialogflow_agent
+        #   @return [::Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent]
+        #     Optional. The remote
+        #     [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents)
+        #     agent to be used for the agent execution. If this field is set, all other
+        #     agent level properties will be ignored.
+        #
+        #     Note: If the Dialogflow agent is in a different project from the app, you
+        #     should grant `roles/dialogflow.client` to the CES service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
+        #
+        #     Note: The following fields are mutually exclusive: `remote_dialogflow_agent`, `llm_agent`. 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 agent.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Display name of the agent.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Human-readable description of the agent.
+        # @!attribute [rw] model_settings
+        #   @return [::Google::Cloud::Ces::V1::ModelSettings]
+        #     Optional. Configurations for the LLM model.
+        # @!attribute [rw] instruction
+        #   @return [::String]
+        #     Optional. Instructions for the LLM model to guide the agent's behavior.
+        # @!attribute [rw] tools
+        #   @return [::Array<::String>]
+        #     Optional. List of available tools for the agent.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+        # @!attribute [rw] child_agents
+        #   @return [::Array<::String>]
+        #     Optional. List of child agents in the agent tree.
+        #     Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+        # @!attribute [rw] before_agent_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute before the agent is called.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [rw] after_agent_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute after the agent is called.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [rw] before_model_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute before the model is called. If there are
+        #     multiple calls to the model, the callback will be executed multiple times.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [rw] after_model_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute after the model is called. If there are
+        #     multiple calls to the model, the callback will be executed multiple times.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [rw] before_tool_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute before the tool is invoked. If there are
+        #     multiple tool invocations, the callback will be executed multiple times.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [rw] after_tool_callbacks
+        #   @return [::Array<::Google::Cloud::Ces::V1::Callback>]
+        #     Optional. The callbacks to execute after the tool is invoked. If there are
+        #     multiple tool invocations, the callback will be executed multiple times.
+        #     The provided callbacks are executed sequentially in the exact order they
+        #     are given in the list. If a callback returns an overridden response,
+        #     execution stops and any remaining callbacks are skipped.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the agent was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the agent was last updated.
+        # @!attribute [rw] guardrails
+        #   @return [::Array<::String>]
+        #     Optional. List of guardrails for the agent.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+        # @!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] toolsets
+        #   @return [::Array<::Google::Cloud::Ces::V1::Agent::AgentToolset>]
+        #     Optional. List of toolsets for the agent.
+        # @!attribute [r] generated_summary
+        #   @return [::String]
+        #     Output only. If the agent is generated by the LLM assistant, this field
+        #     contains a descriptive summary of the generation.
+        # @!attribute [rw] transfer_rules
+        #   @return [::Array<::Google::Cloud::Ces::V1::TransferRule>]
+        #     Optional. Agent transfer rules.
+        #     If multiple rules match, the first one in the list will be used.
+        class Agent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Default agent type. The agent uses instructions and callbacks specified in
+          # the agent to perform the task using a large language model.
+          class LlmAgent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The agent which will transfer execution to a remote
+          # [Dialogflow
+          # CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent.
+          # The Dialogflow agent will process subsequent user queries until the session
+          # ends or flow ends, and the control is transferred back to the parent CES
+          # agent.
+          # @!attribute [rw] agent
+          #   @return [::String]
+          #     Required. The
+          #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
+          #     agent resource name.
+          #     Format: `projects/{project}/locations/{location}/agents/{agent}`
+          # @!attribute [rw] flow_id
+          #   @return [::String]
+          #     Optional. The flow ID of the flow in the Dialogflow agent.
+          # @!attribute [rw] environment_id
+          #   @return [::String]
+          #     Optional. The environment ID of the Dialogflow agent to be used for the
+          #     agent execution. If not specified, the draft environment will be used.
+          # @!attribute [rw] input_variable_mapping
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. The mapping of the app variables names to the Dialogflow
+          #     session parameters names to be sent to the Dialogflow agent as input.
+          # @!attribute [rw] output_variable_mapping
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. The mapping of the Dialogflow session parameters names to the
+          #     app variables names to be sent back to the CES agent after the Dialogflow
+          #     agent execution ends.
+          # @!attribute [rw] respect_response_interruption_settings
+          #   @return [::Boolean]
+          #     Optional. Indicates whether to respect the message-level interruption
+          #     settings configured in the Dialogflow agent.
+          #
+          #     * If false: all response messages from the Dialogflow agent follow the
+          #     app-level barge-in settings.
+          #     * If true: only response messages with
+          #     [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text)
+          #     set to true will be interruptable, all other messages follow the
+          #     app-level barge-in settings.
+          class RemoteDialogflowAgent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class InputVariableMappingEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class OutputVariableMappingEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # A toolset with a selection of its tools.
+          # @!attribute [rw] toolset
+          #   @return [::String]
+          #     Required. The resource name of the toolset.
+          #     Format:
+          #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+          # @!attribute [rw] tool_ids
+          #   @return [::Array<::String>]
+          #     Optional. The tools IDs to filter the toolset.
+          class AgentToolset
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end