google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

data/proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb

@@ -25,7 +25,7 @@ module Google
         # [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].
         # @!attribute [rw] name
         #   @return [::String]
-        #     Immutable. Resource name of the `AssistAnswer`.
+        #     Immutable. Identifier. Resource name of the `AssistAnswer`.
         #     Format:
         #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
         #
@@ -34,12 +34,25 @@ module Google
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::State]
         #     State of the answer generation.
+        # @!attribute [r] connector_display_names
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Output only. Maps an internal connector agent name (the machine identifier
+        #     embedded in tool names, e.g. `custom_mcp_<fingerprint>_agent`) to the
+        #     connector's human-readable display name. Populated at serving time for
+        #     custom MCP / agent gateway connectors so user-facing surfaces (e.g. the
+        #     tool-call chip) can show the connector name instead of its internal
+        #     identifier. Empty when there are no such connectors.
         # @!attribute [rw] replies
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::Reply>]
         #     Replies of the assistant.
         # @!attribute [rw] assist_skipped_reasons
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::AssistSkippedReason>]
         #     Reasons for not answering the assist call.
+        # @!attribute [rw] customer_policy_enforcement_result
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult]
+        #     Optional. The field contains information about the various policy checks'
+        #     results like the banned phrases or the Model Armor checks. This field is
+        #     populated only if the assist call was skipped due to a policy violation.
         class AssistAnswer
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,11 +61,113 @@ module Google
           # @!attribute [rw] grounded_content
           #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
           #     Possibly grounded response text or media from the assistant.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time when the reply was created.
           class Reply
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Customer policy enforcement results. Contains the results of the various
+          # policy checks, like the banned phrases or the Model Armor checks.
+          # @!attribute [rw] verdict
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult::Verdict]
+          #     Final verdict of the customer policy enforcement. If only one policy
+          #     blocked the processing, the verdict is BLOCK.
+          # @!attribute [rw] policy_results
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult::PolicyEnforcementResult>]
+          #     Customer policy enforcement results.
+          #     Populated only if the assist call was skipped due to a policy
+          #     violation. It contains results from those filters that blocked the
+          #     processing of the query.
+          # @!attribute [r] violation_source
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult::ViolationSource]
+          #     Output only. The source of the violation.
+          class CustomerPolicyEnforcementResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Customer policy enforcement result for the banned phrase policy.
+            # @!attribute [rw] banned_phrases
+            #   @return [::Array<::String>]
+            #     The banned phrases that were found in the query or the answer.
+            class BannedPhraseEnforcementResult
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Customer policy enforcement result for the Model Armor policy.
+            # @!attribute [rw] model_armor_violation
+            #   @return [::String]
+            #     The Model Armor violation that was found.
+            #
+            #     Note: The following fields are mutually exclusive: `model_armor_violation`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            # @!attribute [rw] error
+            #   @return [::Google::Rpc::Status]
+            #     The error returned by Model Armor if the policy enforcement failed
+            #     for some reason.
+            #
+            #     Note: The following fields are mutually exclusive: `error`, `model_armor_violation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            class ModelArmorEnforcementResult
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Customer policy enforcement result for a single policy type.
+            # @!attribute [rw] banned_phrase_enforcement_result
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult::BannedPhraseEnforcementResult]
+            #     The policy enforcement result for the banned phrase policy.
+            #
+            #     Note: The following fields are mutually exclusive: `banned_phrase_enforcement_result`, `model_armor_enforcement_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            # @!attribute [rw] model_armor_enforcement_result
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::CustomerPolicyEnforcementResult::ModelArmorEnforcementResult]
+            #     The policy enforcement result for the Model Armor policy.
+            #
+            #     Note: The following fields are mutually exclusive: `model_armor_enforcement_result`, `banned_phrase_enforcement_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            class PolicyEnforcementResult
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The verdict of the customer policy enforcement.
+            module Verdict
+              # Unknown value.
+              UNSPECIFIED = 0
+
+              # There was no policy violation.
+              ALLOW = 1
+
+              # Processing was blocked by the customer policy.
+              BLOCK = 2
+            end
+
+            # If the assist call was skipped due to a policy violation, this contains
+            # the source of the violation.
+            module ViolationSource
+              # Unknown value.
+              VIOLATION_SOURCE_UNSPECIFIED = 0
+
+              # Violation found in the system response.
+              SYSTEM = 1
+
+              # Violation found in the user prompt.
+              PROMPT = 2
+
+              # Violation found in the user attachment.
+              ATTACHMENT = 3
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class ConnectorDisplayNamesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # State of the answer generation.
           module State
             # Unknown.
@@ -69,6 +184,10 @@ module Google
 
             # Assist operation has been skipped.
             SKIPPED = 4
+
+            # Assist operation has been cancelled (e.g. client closed the stream).
+            # May contain a partial response.
+            CANCELLED = 5
           end
 
           # Possible reasons for not answering an assist call.
@@ -197,6 +316,10 @@ module Google
         # @!attribute [rw] content
         #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent]
         #     The content.
+        # @!attribute [rw] citation_metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::CitationMetadata]
+        #     Source attribution of the generated content. See also
+        #     https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
         class AssistantGroundedContent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -205,6 +328,9 @@ module Google
           # @!attribute [rw] segments
           #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Segment>]
           #     Grounding information for parts of the text.
+          # @!attribute [rw] visual_segments
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::VisualSegment>]
+          #     Grounding information for parts of the visual content.
           # @!attribute [rw] references
           #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference>]
           #     References for the grounded text.
@@ -235,18 +361,41 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Grounding information for a visual segment.
+            # @!attribute [rw] reference_indices
+            #   @return [::Array<::Integer>]
+            #     References for the visual segment.
+            # @!attribute [rw] content_id
+            #   @return [::String]
+            #     The content id of the visual segment. In order to display the citation
+            #     of the visual element, this content_id needs to match with the
+            #     `grounded_content.content_metadata.content_id` field.
+            class VisualSegment
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Referenced content and related document metadata.
             # @!attribute [rw] content
             #   @return [::String]
             #     Referenced text content.
+            # @!attribute [rw] code_snippet
+            #   @return [::String]
+            #     Chunk of code snippet from the referenced document.
             # @!attribute [rw] document_metadata
             #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata]
             #     Document metadata.
+            # @!attribute [r] chunk_metadata
+            #   @return [::Google::Protobuf::Struct]
+            #     Output only. Generic structured chunk metadata from upstream data
+            #     source connectors.
             class Reference
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
 
               # Document metadata.
+              # @!attribute [rw] language
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata::Language]
               # @!attribute [rw] document
               #   @return [::String]
               #     Document resource name.
@@ -265,9 +414,23 @@ module Google
               #     Domain name from the document URI. Note that the `uri` field may
               #     contain a URL that redirects to the actual website, in which case
               #     this will contain the domain name of the target site.
+              # @!attribute [rw] mime_type
+              #   @return [::String]
+              #     The mime type of the document.
+              #     https://www.iana.org/assignments/media-types/media-types.xhtml.
               class DocumentMetadata
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Language of the referenced content. For now, it is only used for
+                # code.
+                module Language
+                  LANGUAGE_UNSPECIFIED = 0
+
+                  PYTHON = 1
+
+                  SQL = 2
+                end
               end
             end
           end

data/proto_docs/google/cloud/discoveryengine/v1/assistant.rb

@@ -29,9 +29,226 @@ module Google
         #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
         #
         #     It must be a UTF-8 encoded string with a length limit of 1024 characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The assistant display name.
+        #
+        #     It must be a UTF-8 encoded string with a length limit of 128 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Description for additional information. Expected to be shown on
+        #     the configuration UI, not to the users of the assistant.
+        # @!attribute [rw] generation_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::GenerationConfig]
+        #     Optional. Configuration for the generation of the assistant response.
+        # @!attribute [rw] web_grounding_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::WebGroundingType]
+        #     Optional. The type of web grounding to use.
+        # @!attribute [rw] default_web_grounding_toggle_off
+        #   @return [::Boolean]
+        #     Optional. This field controls the default web grounding toggle for end
+        #     users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH`
+        #     or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is
+        #     set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH`
+        #     or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web
+        #     grounding enabled by default on UI. If true, grounding toggle will be
+        #     disabled by default on UI. End users can still enable web grounding in
+        #     the UI if web grounding is enabled.
+        # @!attribute [rw] enabled_tools
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::Assistant::ToolList}]
+        #     Optional. Note: not implemented yet. Use
+        #     [enabled_actions][google.cloud.discoveryengine.v1.Assistant.enabled_actions]
+        #     instead. The enabled tools on this assistant. The keys are connector name,
+        #     for example
+        #     "projects/\\{projectId}/locations/\\{locationId}/collections/\\{collectionId}/dataconnector
+        #     The values consist of admin enabled tools towards the connector
+        #     instance. Admin can selectively enable multiple tools on any of the
+        #     connector instances that they created in the project. For example
+        #     \\{"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2,
+        #     "transferTicket")],
+        #      "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
+        # @!attribute [rw] customer_policy
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::CustomerPolicy]
+        #     Optional. Customer policy for the assistant.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Represents the time when this Assistant was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Represents the time when this Assistant was most recently
+        #     updated.
         class Assistant
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for the generation of the assistant response.
+          # @!attribute [rw] default_model_id
+          #   @return [::String]
+          #     Optional. The default model to use for assistant.
+          # @!attribute [rw] allowed_model_ids
+          #   @return [::Array<::String>]
+          #     Optional. The list of models that are allowed to be used for assistant.
+          # @!attribute [rw] system_instruction
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::GenerationConfig::SystemInstruction]
+          #     System instruction, also known as the prompt preamble for LLM calls.
+          #     See also
+          #     https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
+          # @!attribute [rw] default_language
+          #   @return [::String]
+          #     The default language to use for the generation of the assistant
+          #     response.
+          #     Use an ISO 639-1 language code such as `en`.
+          #     If not specified, the language will be automatically detected.
+          class GenerationConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # System instruction, also known as the prompt preamble for LLM calls.
+            # @!attribute [rw] additional_system_instruction
+            #   @return [::String]
+            #     Optional. Additional system instruction that will be added to the
+            #     default system instruction.
+            class SystemInstruction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Information to identify a tool.
+          # @!attribute [rw] tool_name
+          #   @return [::String]
+          #     The name of the tool as defined by
+          #     DataConnectorService.QueryAvailableActions.
+          #     Note: it's using `action` in the DataConnectorService apis, but they are
+          #     the same as the `tool` here.
+          # @!attribute [rw] tool_display_name
+          #   @return [::String]
+          #     The display name of the tool.
+          class ToolInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The enabled tools on a connector
+          # @!attribute [rw] tool_info
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Assistant::ToolInfo>]
+          #     The list of tools with corresponding tool information.
+          class ToolList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Customer-defined policy for the assistant.
+          # @!attribute [rw] banned_phrases
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Assistant::CustomerPolicy::BannedPhrase>]
+          #     Optional. List of banned phrases.
+          # @!attribute [rw] model_armor_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::CustomerPolicy::ModelArmorConfig]
+          #     Optional. Model Armor configuration to be used for sanitizing user
+          #     prompts and assistant responses.
+          # @!attribute [rw] data_protection_policy
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::DataProtectionPolicy]
+          #     Optional. Data protection policy to be used for sanitizing file uploads.
+          class CustomerPolicy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Definition of a customer-defined banned phrase. A banned phrase is not
+            # allowed to appear in the user query or the LLM response, or else the
+            # answer will be refused.
+            # @!attribute [rw] phrase
+            #   @return [::String]
+            #     Required. The raw string content to be banned.
+            # @!attribute [rw] match_type
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::CustomerPolicy::BannedPhrase::BannedPhraseMatchType]
+            #     Optional. Match type for the banned phrase.
+            # @!attribute [rw] ignore_diacritics
+            #   @return [::Boolean]
+            #     Optional. If true, diacritical marks (e.g., accents, umlauts) are
+            #     ignored when matching banned phrases. For example, "cafe" would match
+            #     "café".
+            class BannedPhrase
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The matching method for the banned phrase.
+              module BannedPhraseMatchType
+                # Defaults to SIMPLE_STRING_MATCH.
+                BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED = 0
+
+                # The banned phrase matches if it is found anywhere in the text as an
+                # exact substring.
+                SIMPLE_STRING_MATCH = 1
+
+                # Banned phrase only matches if the pattern found in the text is
+                # surrounded by word delimiters. The phrase itself may still contain
+                # word delimiters.
+                WORD_BOUNDARY_STRING_MATCH = 2
+              end
+            end
+
+            # Configuration for customer defined Model Armor templates to be used for
+            # sanitizing user prompts and assistant responses.
+            # @!attribute [rw] user_prompt_template
+            #   @return [::String]
+            #     Optional. The resource name of the Model Armor template for sanitizing
+            #     user prompts. Format:
+            #     `projects/{project}/locations/{location}/templates/{template_id}`
+            #
+            #     If not specified, no sanitization will be applied to the user prompt.
+            # @!attribute [rw] response_template
+            #   @return [::String]
+            #     Optional. The resource name of the Model Armor template for sanitizing
+            #     assistant responses. Format:
+            #     `projects/{project}/locations/{location}/templates/{template_id}`
+            #
+            #     If not specified, no sanitization will be applied to the assistant
+            #     response.
+            # @!attribute [rw] failure_mode
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::CustomerPolicy::ModelArmorConfig::FailureMode]
+            #     Optional. Defines the failure mode for Model Armor sanitization.
+            class ModelArmorConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Determines the behavior when Model Armor fails to process a request.
+              module FailureMode
+                # Unspecified failure mode, default behavior is `FAIL_CLOSED`.
+                FAILURE_MODE_UNSPECIFIED = 0
+
+                # In case of a Model Armor processing failure, the request is allowed
+                # to proceed without any changes.
+                FAIL_OPEN = 1
+
+                # In case of a Model Armor processing failure, the request is rejected.
+                FAIL_CLOSED = 2
+              end
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Assistant::ToolList]
+          class EnabledToolsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The type of web grounding to use.
+          module WebGroundingType
+            # Default, unspecified setting. This is the same as disabled.
+            WEB_GROUNDING_TYPE_UNSPECIFIED = 0
+
+            # Web grounding is disabled.
+            WEB_GROUNDING_TYPE_DISABLED = 1
+
+            # Grounding with Google Search is enabled.
+            WEB_GROUNDING_TYPE_GOOGLE_SEARCH = 2
+
+            # Grounding with Enterprise Web Search is enabled.
+            WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH = 3
+          end
         end
       end
     end