google-cloud-ces-v1beta 1.0.1 → 1.2.0

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

@@ -57,9 +57,30 @@ module Google
         #     Temperature controls the randomness of the model's responses. Lower
         #     temperatures produce responses that are more predictable. Higher
         #     temperatures produce responses that are more creative.
+        # @!attribute [rw] thinking_level
+        #   @return [::Google::Cloud::Ces::V1beta::ModelSettings::ThinkingLevel]
+        #     Optional. The thinking level of the model.
         class ModelSettings
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Thinking level configuration for the model.
+          module ThinkingLevel
+            # Thinking level is unspecified.
+            THINKING_LEVEL_UNSPECIFIED = 0
+
+            # Default thinking level.
+            DEFAULT = 1
+
+            # Low thinking level.
+            LOW = 2
+
+            # Medium thinking level.
+            MEDIUM = 3
+
+            # High thinking level.
+            HIGH = 4
+          end
         end
 
         # Action that is taken when a certain precondition is met.
@@ -437,6 +458,29 @@ module Google
           end
         end
 
+        # Represents a UI event payload.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     The media type (MIME type) indicating the format of the UI event payload
+        #     (e.g., "application/json+a2ui").
+        # @!attribute [rw] json_payload
+        #   @return [::String]
+        #     The JSON payload representing the A2UI surface.
+        class UiEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Session checkpoint containing inferred user intent for session title and UI.
+        # @!attribute [rw] user_intent
+        #   @return [::String]
+        #     Inferred user goal or topic for the session (e.g. "Building E-Commerce
+        #     Support Agent").
+        class SessionCheckpoint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The execution type of the tool or toolset.
         module ExecutionType
           # The execution type is unspecified. Defaults to `SYNCHRONOUS` if

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

@@ -84,6 +84,10 @@ module Google
           # @!attribute [rw] root_span
           #   @return [::Google::Cloud::Ces::V1beta::Span]
           #     Optional. The root span of the action processing.
+          # @!attribute [rw] user_intended_text
+          #   @return [::String]
+          #     Optional. The intended ground-truth text from the Simulated Caller
+          #     (Polysynth). Only populated when word error rate metrics are enabled.
           class Turn
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -275,6 +275,19 @@ module Google
             end
           end
 
+          # Snippets configuration.
+          # @!attribute [rw] enable_snippets
+          #   @return [::Boolean]
+          #     Optional. Whether snippets are enabled.
+          # @!attribute [rw] max_snippets
+          #   @return [::Integer]
+          #     Optional. Number of snippets to return per query.
+          #     If unset, returns all snippets from the service by default.
+          class SnippetsConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # If specified, will apply the given configuration for the specified
           # modality.
           # @!attribute [rw] modality_type
@@ -289,6 +302,9 @@ module Google
           # @!attribute [rw] grounding_config
           #   @return [::Google::Cloud::Ces::V1beta::DataStoreTool::GroundingConfig]
           #     Optional. The grounding configuration.
+          # @!attribute [rw] snippets_config
+          #   @return [::Google::Cloud::Ces::V1beta::DataStoreTool::SnippetsConfig]
+          #     Optional. The snippets configuration.
           class ModalityConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -121,9 +121,50 @@ module Google
         #   @return [::Google::Cloud::Ces::V1beta::InstagramCredentials]
         #     Optional. Input only. Ephemeral Instagram credentials required when
         #     configuring a Instagram channel profile.
+        # @!attribute [rw] model_settings
+        #   @return [::Google::Cloud::Ces::V1beta::ModelSettings]
+        #     Optional. Model settings for the deployment.
+        #     Overrides model settings configured at the app/agent levels.
+        #     Note: Deployment-level model settings override is gated behind an
+        #     allowlist. Contact the CXAS team to enable this field.
+        # @!attribute [rw] modality
+        #   @return [::Google::Cloud::Ces::V1beta::Deployment::Modality]
+        #     Optional. The modality of the deployment.
+        #     Note: Deployment-level modality override is gated behind an allowlist.
+        #     Contact the CXAS team to enable this field.
+        # @!attribute [rw] agent_registry_deployment
+        #   @return [::Google::Cloud::Ces::V1beta::AgentRegistryDeployment]
+        #     Optional. Configuration for deploying this deployment to Agent Registry.
+        #     If present, this deployment will be published to Agent Registry.
         class Deployment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The modality of the deployment.
+          module Modality
+            # Unknown modality.
+            MODALITY_UNSPECIFIED = 0
+
+            # Text modality.
+            MODALITY_TEXT = 1
+
+            # Voice modality.
+            MODALITY_VOICE = 2
+
+            # Video modality.
+            MODALITY_VIDEO = 3
+          end
+        end
+
+        # Configuration and status for Agent Registry deployment.
+        # @!attribute [r] agent_registry_service_name
+        #   @return [::String]
+        #     Optional. Output only. The resource name of the deployed Agent Registry
+        #     service. Format:
+        #     `projects/{project}/locations/{location}/services/{service}`
+        class AgentRegistryDeployment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Ephemeral Meta credentials for WhatsApp native integration.
@@ -144,7 +185,7 @@ module Google
         #     Required. The WhatsApp Business Account ID.
         # @!attribute [rw] conversation_profile_id
         #   @return [::String]
-        #     Required. The Conversation Profile ID to use for the deployment.
+        #     Optional. The Conversation Profile ID to use for the deployment.
         class WhatsAppCredentials
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -156,7 +197,7 @@ module Google
         #     Required. The Meta auth code provided by the embedded signup flow.
         # @!attribute [rw] conversation_profile_id
         #   @return [::String]
-        #     Required. The Conversation Profile ID to use for the deployment.
+        #     Optional. The Conversation Profile ID to use for the deployment.
         class InstagramCredentials
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -584,6 +584,14 @@ module Google
         # @!attribute [r] golden_run_method
         #   @return [::Google::Cloud::Ces::V1beta::GoldenRunMethod]
         #     Output only. The method used to run the golden evaluation.
+        # @!attribute [r] root_span
+        #   @return [::Google::Cloud::Ces::V1beta::Span]
+        #     Output only. The root span of the evaluation execution, which includes
+        #     information about each step of the evaluation.
+        # @!attribute [r] outcome_metadata
+        #   @return [::Google::Cloud::Ces::V1beta::EvaluationResult::OutcomeMetadata]
+        #     Output only. The outcome metadata of the evaluation. Only populated if
+        #     execution_state is COMPLETE.
         class EvaluationResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -934,10 +942,11 @@ module Google
           # The result of a user goal satisfaction check for a conversation.
           # @!attribute [r] score
           #   @return [::Integer]
-          #     Output only. The user task satisfaction score. Can be -1, 0, 1.
+          #     Output only. The user task satisfaction score. Can be -1, 0, 1, 2.
           # @!attribute [r] label
           #   @return [::String]
           #     Output only. The label associated with each score.
+          #     Score 2: Graceful Handoff
           #     Score 1: User Task Satisfied
           #     Score 0: User Task Not Satisfied
           #     Score -1: User Task Unspecified
@@ -1049,6 +1058,15 @@ module Google
             # Evaluation result execution was cancelled.
             CANCELLED = 4
           end
+
+          # Metadata about the outcome of the evaluation.
+          module OutcomeMetadata
+            # Unspecified outcome metadata.
+            OUTCOME_METADATA_UNSPECIFIED = 0
+
+            # The evaluation resulted in a graceful handoff to a human representative.
+            GRACEFUL_HANDOFF = 1
+          end
         end
 
         # An evaluation run represents an all the evaluation results from an
@@ -1401,11 +1419,9 @@ module Google
 
         # EvaluationConfig configures settings for running the evaluation.
         # @!attribute [rw] input_audio_config
-        #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::Google::Cloud::Ces::V1beta::InputAudioConfig]
         #     Optional. Configuration for processing the input audio.
         # @!attribute [rw] output_audio_config
-        #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::Google::Cloud::Ces::V1beta::OutputAudioConfig]
         #     Optional. Configuration for generating the output audio.
         # @!attribute [rw] evaluation_channel
@@ -1496,8 +1512,8 @@ module Google
         #     Optional. The display name of the evaluation run.
         # @!attribute [rw] app_version
         #   @return [::String]
-        #     Optional. The app version to evaluate.
-        #     Format:
+        #     Optional. The app version to evaluate. At most one of `app_version` or
+        #     `deployment` can be set. Format:
         #     `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
         # @!attribute [rw] config
         #   @return [::Google::Cloud::Ces::V1beta::EvaluationConfig]

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

@@ -161,6 +161,9 @@ module Google
         # @!attribute [rw] data
         #   @return [::String]
         #     Required. Raw bytes of the image.
+        # @!attribute [rw] alt_text
+        #   @return [::String]
+        #     Optional. The alternative text for the image.
         class Image
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -190,6 +193,16 @@ module Google
         #   @return [::Google::Protobuf::Struct]
         #     Optional. The input parameters and values for the tool in JSON object
         #     format.
+        # @!attribute [r] parent_tool_call_id
+        #   @return [::String]
+        #     Output only. The id of the tool call that caused this one, when it was
+        #     issued by a sub-agent working on behalf of a parent call. Empty for
+        #     top-level calls. Lets a client group a sub-agent's work under the call that
+        #     started it instead of rendering every step as a sibling.
+        # @!attribute [r] agent_name
+        #   @return [::String]
+        #     Output only. Human-readable name of the agent that issued this call, e.g.
+        #     "Contract Architect". Empty when the root agent issued it.
         class ToolCall
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -220,6 +233,16 @@ module Google
         #     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 [r] parent_tool_call_id
+        #   @return [::String]
+        #     Output only. The id of the tool call that caused this one, when it was
+        #     issued by a sub-agent working on behalf of a parent call. Empty for
+        #     top-level calls. Lets a client group a sub-agent's work under the call that
+        #     started it instead of rendering every step as a sibling.
+        # @!attribute [r] agent_name
+        #   @return [::String]
+        #     Output only. Human-readable name of the agent that issued this call, e.g.
+        #     "Contract Architect". Empty when the root agent issued it.
         class ToolResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -28,31 +28,36 @@ module Google
         #     Optional. Guardrail that bans certain content from being used in the
         #     conversation.
         #
-        #     Note: The following fields are mutually exclusive: `content_filter`, `llm_prompt_security`, `llm_policy`, `model_safety`, `code_callback`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `content_filter`, `llm_prompt_security`, `llm_policy`, `model_safety`, `code_callback`, `supervisor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] llm_prompt_security
         #   @return [::Google::Cloud::Ces::V1beta::Guardrail::LlmPromptSecurity]
         #     Optional. Guardrail that blocks the conversation if the prompt is
         #     considered unsafe based on the LLM classification.
         #
-        #     Note: The following fields are mutually exclusive: `llm_prompt_security`, `content_filter`, `llm_policy`, `model_safety`, `code_callback`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `llm_prompt_security`, `content_filter`, `llm_policy`, `model_safety`, `code_callback`, `supervisor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] llm_policy
         #   @return [::Google::Cloud::Ces::V1beta::Guardrail::LlmPolicy]
         #     Optional. Guardrail that blocks the conversation if the LLM response is
         #     considered violating the policy based on the LLM classification.
         #
-        #     Note: The following fields are mutually exclusive: `llm_policy`, `content_filter`, `llm_prompt_security`, `model_safety`, `code_callback`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `llm_policy`, `content_filter`, `llm_prompt_security`, `model_safety`, `code_callback`, `supervisor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] model_safety
         #   @return [::Google::Cloud::Ces::V1beta::Guardrail::ModelSafety]
         #     Optional. Guardrail that blocks the conversation if the LLM response is
         #     considered unsafe based on the model safety settings.
         #
-        #     Note: The following fields are mutually exclusive: `model_safety`, `content_filter`, `llm_prompt_security`, `llm_policy`, `code_callback`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `model_safety`, `content_filter`, `llm_prompt_security`, `llm_policy`, `code_callback`, `supervisor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] code_callback
         #   @return [::Google::Cloud::Ces::V1beta::Guardrail::CodeCallback]
         #     Optional. Guardrail that potentially blocks the conversation based on the
         #     result of the callback execution.
         #
-        #     Note: The following fields are mutually exclusive: `code_callback`, `content_filter`, `llm_prompt_security`, `llm_policy`, `model_safety`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `code_callback`, `content_filter`, `llm_prompt_security`, `llm_policy`, `model_safety`, `supervisor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] supervisor
+        #   @return [::Google::Cloud::Ces::V1beta::Guardrail::Supervisor]
+        #     Optional. Guardrail that runs supervisor intervention.
+        #
+        #     Note: The following fields are mutually exclusive: `supervisor`, `content_filter`, `llm_prompt_security`, `llm_policy`, `model_safety`, `code_callback`. 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 guardrail.
@@ -102,6 +107,13 @@ module Google
           # @!attribute [rw] disregard_diacritics
           #   @return [::Boolean]
           #     Optional. If true, diacritics are ignored during matching.
+          # @!attribute [rw] sensitive_words_exemptions
+          #   @return [::Array<::String>]
+          #     Optional. Entries of the sensitive words list that this guardrail allows.
+          #     Only valid when match_type is SENSITIVE_WORDS. Each value must equal a
+          #     list entry (case-insensitive, surrounding whitespace ignored); other
+          #     values have no effect. Applies to this guardrail only. At most 1000
+          #     entries of up to 256 characters each.
           class ContentFilter
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -121,6 +133,12 @@ module Google
 
               # Content is matched using regular expression syntax.
               REGEXP_MATCH = 3
+
+              # Content is matched against a system-managed list of sensitive words
+              # and phrases. Attaching a guardrail with this match type to an app or
+              # agent replaces the default sensitive words filter for the affected
+              # agents; disable the guardrail to opt out of the default filter.
+              SENSITIVE_WORDS = 4
             end
           end
 
@@ -176,7 +194,9 @@ module Google
           #     Optional. Model settings.
           # @!attribute [rw] prompt
           #   @return [::String]
-          #     Required. Policy prompt.
+          #     Required. Policy prompt. Supports session variable placeholders (`{var}`)
+          #     as well as `{agent_system_instruction}` to inject the agent's resolved
+          #     system instructions.
           # @!attribute [rw] policy_scope
           #   @return [::Google::Cloud::Ces::V1beta::Guardrail::LlmPolicy::PolicyScope]
           #     Required. Defines when to apply the policy check during the conversation.
@@ -253,6 +273,12 @@ module Google
 
               # The harm category is sexually explicit content.
               HARM_CATEGORY_SEXUALLY_EXPLICIT = 4
+
+              # The harm category is profanity.
+              HARM_CATEGORY_PROFANITY = 5
+
+              # The harm category is toxic.
+              HARM_CATEGORY_TOXIC = 6
             end
 
             # Probability based thresholds levels for blocking.
@@ -317,6 +343,62 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Guardrail that runs supervisor intervention.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Ces::V1beta::Guardrail::Supervisor::Type]
+          #     Optional. The type of the supervisor.
+          # @!attribute [rw] detection_mode
+          #   @return [::Google::Cloud::Ces::V1beta::Guardrail::Supervisor::DetectionMode]
+          #     Optional. The detection mode of the supervisor.
+          class Supervisor
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Type of supervisor.
+            module Type
+              # Type is unspecified.
+              TYPE_UNSPECIFIED = 0
+
+              # Invalid text issue type.
+              INVALID_TEXT = 1
+
+              # Language shift issue type.
+              LANGUAGE_SHIFT = 2
+
+              # Speaker shift issue type.
+              SPEAKER_SHIFT = 3
+
+              # Audio mismatch issue type.
+              AUDIO_MISMATCH = 4
+
+              # Missing tool call issue type.
+              MISSING_TOOL_CALL = 5
+
+              # Custom issue type.
+              CUSTOM = 6
+
+              # Choppy audio issue type.
+              CHOPPY_AUDIO = 7
+
+              # Agent profanity issue type.
+              PROFANITY = 8
+            end
+
+            # Detection mode of the supervisor.
+            module DetectionMode
+              # Detection mode is unspecified. Default to NON_BLOCKING.
+              DETECTION_MODE_UNSPECIFIED = 0
+
+              # Non blocking detection mode.
+              # Response is not blocked when the supervisor detection is ongoing.
+              NON_BLOCKING = 1
+
+              # Blocking detection mode.
+              # Response is blocked when the supervisor detection is ongoing.
+              BLOCKING = 2
+            end
+          end
         end
       end
     end