google-cloud-ces-v1beta 0.3.0 → 0.4.0

data/proto_docs/google/api/routing.rb

@@ -0,0 +1,463 @@
+# 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
+    # Specifies the routing information that should be sent along with the request
+    # in the form of routing header.
+    # **NOTE:** All service configuration rules follow the "last one wins" order.
+    #
+    # The examples below will apply to an RPC which has the following request type:
+    #
+    # Message Definition:
+    #
+    #     message Request {
+    #       // The name of the Table
+    #       // Values can be of the following formats:
+    #       // - `projects/<project>/tables/<table>`
+    #       // - `projects/<project>/instances/<instance>/tables/<table>`
+    #       // - `region/<region>/zones/<zone>/tables/<table>`
+    #       string table_name = 1;
+    #
+    #       // This value specifies routing for replication.
+    #       // It can be in the following formats:
+    #       // - `profiles/<profile_id>`
+    #       // - a legacy `profile_id` that can be any string
+    #       string app_profile_id = 2;
+    #     }
+    #
+    # Example message:
+    #
+    #     {
+    #       table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
+    #       app_profile_id: profiles/prof_qux
+    #     }
+    #
+    # The routing header consists of one or multiple key-value pairs. The order of
+    # the key-value pairs is undefined, the order of the `routing_parameters` in
+    # the `RoutingRule` only matters for the evaluation order of the path
+    # templates when `field` is the same. See the examples below for more details.
+    #
+    # Every key and value in the routing header must be percent-encoded,
+    # and joined together in the following format: `key1=value1&key2=value2`.
+    # The examples below skip the percent-encoding for readability.
+    #
+    # Example 1
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key equal to the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: app_profile_id=profiles/prof_qux
+    #
+    # Example 2
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key different from the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`, but name it `routing_id` in the header.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 3
+    #
+    # Extracting a field from the request to put into the routing
+    # header, while matching a path template syntax on the field's value.
+    #
+    # NB: it is more useful to send nothing than to send garbage for the purpose
+    # of dynamic routing, since garbage pollutes cache. Thus the matching.
+    #
+    # Sub-example 3a
+    #
+    # The field matches the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with project-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Sub-example 3b
+    #
+    # The field does not match the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with region-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     <no routing header will be sent>
+    #
+    # Sub-example 3c
+    #
+    # Multiple alternative conflictingly named path templates are
+    # specified. The one that matches is used to construct the header.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed, whether
+    #       // using the region- or projects-based syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Example 4
+    #
+    # Extracting a single routing header key-value pair by matching a
+    # template syntax on (a part of) a single request field.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take just the project id from the `table_name` field.
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=projects/proj_foo
+    #
+    # Example 5
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on (parts of) a single request
+    # field. The last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // If the `table_name` does not have instances information,
+    #       // take just the project id for routing.
+    #       // Otherwise take project + instance.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*/instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     routing_id=projects/proj_foo/instances/instance_bar
+    #
+    # Example 6
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several non-conflicting path templates on (parts of) a single request field.
+    #
+    # Sub-example 6a
+    #
+    # Make the templates strict, so that if the `table_name` does not
+    # have an instance information, nothing is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code needs two keys instead of one composite
+    #       // but works only for the tables with the "project-instance" name
+    #       // syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/instances/*/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Sub-example 6b
+    #
+    # Make the templates loose, so that if the `table_name` does not
+    # have an instance information, just the project id part is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code wants two keys instead of one composite
+    #       // but will work with just the `project_id` for tables without
+    #       // an instance in the `table_name`.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result (is the same as 6a for our example message because it has the instance
+    # information):
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Example 7
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several path templates on multiple request fields.
+    #
+    # NB: note that here there is no way to specify sending nothing if one of the
+    # fields does not match its template. E.g. if the `table_name` is in the wrong
+    # format, the `project_id` will not be sent, but the `routing_id` will be.
+    # The backend routing code has to be aware of that and be prepared to not
+    # receive a full complement of keys if it expects multiple.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing needs both `project_id` and `routing_id`
+    #       // (from the `app_profile_id` field) for routing.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&routing_id=profiles/prof_qux
+    #
+    # Example 8
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on several request fields. The
+    # last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The `routing_id` can be a project id or a region id depending on
+    #       // the table name format, but only if the `app_profile_id` is not set.
+    #       // If `app_profile_id` is set it should be used instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #          field: "table_name"
+    #          path_template: "{routing_id=regions/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 9
+    #
+    # Bringing it all together.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // For routing both `table_location` and a `routing_id` are needed.
+    #       //
+    #       // table_location can be either an instance id or a region+zone id.
+    #       //
+    #       // For `routing_id`, take the value of `app_profile_id`
+    #       // - If it's in the format `profiles/<profile_id>`, send
+    #       // just the `<profile_id>` part.
+    #       // - If it's any other literal, send it as is.
+    #       // If the `app_profile_id` is empty, and the `table_name` starts with
+    #       // the project_id, send that instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_location=regions/*/zones/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "profiles/{routing_id=*}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_location=instances/instance_bar&routing_id=prof_qux
+    # @!attribute [rw] routing_parameters
+    #   @return [::Array<::Google::Api::RoutingParameter>]
+    #     A collection of Routing Parameter specifications.
+    #     **NOTE:** If multiple Routing Parameters describe the same key
+    #     (via the `path_template` field or via the `field` field when
+    #     `path_template` is not provided), "last one wins" rule
+    #     determines which Parameter gets used.
+    #     See the examples for more details.
+    class RoutingRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A projection from an input message to the GRPC or REST header.
+    # @!attribute [rw] field
+    #   @return [::String]
+    #     A request field to extract the header key-value pair from.
+    # @!attribute [rw] path_template
+    #   @return [::String]
+    #     A pattern matching the key-value field. Optional.
+    #     If not specified, the whole field specified in the `field` field will be
+    #     taken as value, and its name used as key. If specified, it MUST contain
+    #     exactly one named segment (along with any number of unnamed segments) The
+    #     pattern will be matched over the field specified in the `field` field, then
+    #     if the match is successful:
+    #     - the name of the single named segment will be used as a header name,
+    #     - the match value of the segment will be used as a header value;
+    #     if the match is NOT successful, nothing will be sent.
+    #
+    #     Example:
+    #
+    #                   -- This is a field in the request message
+    #                  |   that the header value will be extracted from.
+    #                  |
+    #                  |                     -- This is the key name in the
+    #                  |                    |   routing header.
+    #                  V                    |
+    #         field: "table_name"           v
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #                                                    ^            ^
+    #                                                    |            |
+    #           In the {} brackets is the pattern that --             |
+    #           specifies what to extract from the                    |
+    #           field as a value to be sent.                          |
+    #                                                                 |
+    #          The string in the field must match the whole pattern --
+    #          before brackets, inside brackets, after brackets.
+    #
+    #     When looking at this specific example, we can see that:
+    #     - A key-value pair with the key `table_location`
+    #       and the value matching `instances/*` should be added
+    #       to the x-goog-request-params routing header.
+    #     - The value is extracted from the request message's `table_name` field
+    #       if it matches the full pattern specified:
+    #       `projects/*/instances/*/tables/*`.
+    #
+    #     **NB:** If the `path_template` field is not provided, the key name is
+    #     equal to the field name, and the whole field should be sent as a value.
+    #     This makes the pattern for the field and the value functionally equivalent
+    #     to `**`, and the configuration
+    #
+    #         {
+    #           field: "table_name"
+    #         }
+    #
+    #     is a functionally equivalent shorthand to:
+    #
+    #         {
+    #           field: "table_name"
+    #           path_template: "{table_name=**}"
+    #         }
+    #
+    #     See Example 1 for more details.
+    class RoutingParameter
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -1374,9 +1374,24 @@ module Google
           # @!attribute [rw] evaluation_run
           #   @return [::String]
           #     Required. The evaluation run used to inform quality report analysis.
+          # @!attribute [rw] algorithm
+          #   @return [::Google::Cloud::Ces::V1beta::GenerateAppResourceRequest::QualityReportGenerationConfig::LossAttributionAlgorithm]
+          #     Optional. The loss attribution algorithm to use.
           class QualityReportGenerationConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The algorithm to use for loss attribution.
+            module LossAttributionAlgorithm
+              # Unspecified.
+              LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED = 0
+
+              # App-centric loss attribution. Treats the app as a single unit.
+              APP_CENTRIC = 1
+
+              # Agent-centric loss attribution. Attributes loss to individual agents.
+              AGENT_CENTRIC = 2
+            end
           end
 
           # The configuration to be used for hill climbing fixes.

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

@@ -335,12 +335,12 @@ module Google
         # @!attribute [rw] disable_barge_in
         #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::Boolean]
-        #     Optional. Disables user barge-in while the agent is speaking. If true, user
-        #     input during agent response playback will be ignored.
-        #
-        #     Deprecated: `disable_barge_in` is deprecated in favor of
+        #     Optional. Deprecated: `disable_barge_in` is deprecated in favor of
         #     {::Google::Cloud::Ces::V1beta::ChannelProfile#disable_barge_in_control `disable_barge_in_control`}
         #     in ChannelProfile.
+        #
+        #     Disables user barge-in while the agent is speaking. If true, user input
+        #     during agent response playback will be ignored.
         # @!attribute [rw] barge_in_awareness
         #   @return [::Boolean]
         #     Optional. If enabled, the agent will adapt its next response based on the
@@ -361,12 +361,30 @@ module Google
         #     For the list of available voices, please refer to [Supported voices and
         #     languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud
         #     Text-to-Speech.
+        # @!attribute [rw] voice_sample_gcs_uri
+        #   @return [::String]
+        #     Optional. The Cloud Storage URI to the audio sample for voice cloning. The
+        #     audio sample should be a mono-channel, 24kHz WAV file.
+        #
+        #     Note: Please make sure the CES service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` has
+        #     `storage.objects.get` permission to the Cloud Storage object.
         # @!attribute [rw] speaking_rate
         #   @return [::Float]
         #     Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the
         #     normal native speed supported by the specific voice. 2.0 is twice as fast,
         #     and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will
         #     return an error.
+        # @!attribute [rw] model
+        #   @return [::String]
+        #     Optional. The model used to synthesize audio.
+        #     Currently supported values:
+        #     - "gemini-3.1-flash-tts-preview"
+        #     If empty, Chirp3-HD is used.
+        # @!attribute [rw] instruction
+        #   @return [::String]
+        #     Optional. The instruction used to synthesize speech when using a generative
+        #     model.
         class SynthesizeSpeechConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -404,6 +422,11 @@ module Google
         #     Optional. Configures the BigQuery export behaviors for the app. The
         #     conversation data is subject to redaction as configured in
         #     {::Google::Cloud::Ces::V1beta::LoggingSettings#redaction_config RedactionConfig}.
+        # @!attribute [rw] unredacted_bigquery_export_settings
+        #   @return [::Google::Cloud::Ces::V1beta::BigQueryExportSettings]
+        #     Optional. Configures the BigQuery export behaviors for the app.
+        #     The unredacted conversation data will be exported to BigQuery tables if it
+        #     is enabled.
         # @!attribute [rw] cloud_logging_settings
         #   @return [::Google::Cloud::Ces::V1beta::CloudLoggingSettings]
         #     Optional. Settings to describe the Cloud Logging behaviors for the app.
@@ -635,6 +658,9 @@ module Google
         #   @return [::Google::Cloud::Ces::V1beta::EvaluationSettings::ScenarioExecutionMode]
         #     Optional. The execution mode for scenario evaluations. If not provided,
         #     will default to QUALITY_OPTIMIZED.
+        # @!attribute [rw] evaluation_run_caching_settings
+        #   @return [::Google::Cloud::Ces::V1beta::EvaluationRunCachingSettings]
+        #     Optional. The caching settings to use for the evaluation run.
         class EvaluationSettings
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -202,6 +202,12 @@ module Google
         #   @return [::String]
         #     Optional. The noise suppression level of the channel profile.
         #     Available values are "low", "moderate", "high", "very_high".
+        # @!attribute [rw] whatsapp_config
+        #   @return [::Google::Cloud::Ces::V1beta::ChannelProfile::WhatsAppConfig]
+        #     Optional. Configuration specific to WhatsApp deployments.
+        # @!attribute [rw] instagram_config
+        #   @return [::Google::Cloud::Ces::V1beta::ChannelProfile::InstagramConfig]
+        #     Optional. Configuration specific to Instagram deployments.
         class ChannelProfile
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -303,6 +309,48 @@ module Google
             end
           end
 
+          # Configuration specific to WhatsApp deployments.
+          # @!attribute [rw] waba_id
+          #   @return [::String]
+          #     Required. The WhatsApp Business Account ID.
+          # @!attribute [rw] phone_number_id
+          #   @return [::String]
+          #     Required. The Meta phone number ID.
+          # @!attribute [rw] phone_number
+          #   @return [::String]
+          #     Optional. The phone number in E.164 format.
+          # @!attribute [r] display_name
+          #   @return [::String]
+          #     Output only. The fetched Meta business page name.
+          # @!attribute [r] thumbnail_url
+          #   @return [::String]
+          #     Output only. The fetched Meta business profile thumbnail URL.
+          # @!attribute [r] description
+          #   @return [::String]
+          #     Output only. The description of the Meta business page or profile.
+          class WhatsAppConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration specific to Instagram deployments.
+          # @!attribute [rw] instagram_account_id
+          #   @return [::String]
+          #     Required. The Instagram Account ID.
+          # @!attribute [r] display_name
+          #   @return [::String]
+          #     Output only. The fetched Meta business page name.
+          # @!attribute [r] thumbnail_url
+          #   @return [::String]
+          #     Output only. The fetched Meta business profile thumbnail URL.
+          # @!attribute [r] description
+          #   @return [::String]
+          #     Output only. The description of the Meta business page or profile.
+          class InstagramConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The type of the channel profile.
           module ChannelType
             # Unknown channel type.
@@ -323,11 +371,20 @@ module Google
             # Contact Center as a Service (CCaaS) channel.
             CONTACT_CENTER_AS_A_SERVICE = 6
 
+            # Contact Center as a Service (CCaaS Chat) channel.
+            CONTACT_CENTER_AS_A_SERVICE_CHAT = 11
+
             # Five9 channel.
             FIVE9 = 7
 
             # Third party contact center integration channel.
             CONTACT_CENTER_INTEGRATION = 8
+
+            # WhatsApp channel.
+            WHATSAPP = 9
+
+            # Instagram channel.
+            INSTAGRAM = 10
           end
         end
 
@@ -355,6 +412,31 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Settings for evaluation run caching.
+        # @!attribute [rw] run_caching_mode
+        #   @return [::Google::Cloud::Ces::V1beta::EvaluationRunCachingSettings::EvaluationRunCachingMode]
+        #     Optional. The caching mode to use for the evaluation run. If not set,
+        #     default to FORCE_RUN.
+        class EvaluationRunCachingSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The evaluation result caching behavior. Controls whether to return the last
+          # completed evaluation result (if existing) or to execute a new evaluation.
+          module EvaluationRunCachingMode
+            # The run caching mode is unspecified.
+            EVALUATION_RUN_CACHING_MODE_UNSPECIFIED = 0
+
+            # Always execute a full live simulation regardless of whether changelogs
+            # exist.
+            FORCE_RUN = 1
+
+            # Skip execution and copy previous verified results if no dependencies have
+            # mutated, the evaluation channel/run method are the same.
+            SKIP_IF_UNCHANGED = 2
+          end
+        end
+
         # The execution type of the tool or toolset.
         module ExecutionType
           # The execution type is unspecified. Defaults to `SYNCHRONOUS` if