google-cloud-discovery_engine-v1 1.1.0 → 1.3.0

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

@@ -21,6 +21,389 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1
+        # Base structured datatype containing multi-part content of a message.
+        # @!attribute [rw] role
+        #   @return [::String]
+        #     Producer of the content. Must be either `user` or `model`.
+        #
+        #     Intended to be used for multi-turn conversations. Otherwise, it can be left
+        #     unset.
+        # @!attribute [rw] parts
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent::Part>]
+        #     Ordered `Parts` that constitute a single message.
+        class GroundedGenerationContent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Single part of content.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     Inline text.
+          class Part
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Top-level message sent by the client for the `GenerateGroundedContent`
+        # method.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     Required. Location resource.
+        #
+        #     Format: `projects/{project}/locations/{location}`.
+        # @!attribute [rw] system_instruction
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent]
+        #     Content of the system instruction for the current API.
+        #
+        #     These instructions will take priority over any other prompt instructions
+        #     if the selected model is supporting them.
+        # @!attribute [rw] contents
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent>]
+        #     Content of the current conversation with the model.
+        #
+        #     For single-turn queries, this is a single instance. For multi-turn queries,
+        #     this is a repeated field that contains conversation history + latest
+        #     request.
+        #
+        #     Only a single-turn query is supported currently.
+        # @!attribute [rw] generation_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GenerationSpec]
+        #     Content generation specification.
+        # @!attribute [rw] grounding_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSpec]
+        #     Grounding specification.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class GenerateGroundedContentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Content generation specification.
+          # @!attribute [rw] model_id
+          #   @return [::String]
+          #     Specifies which Vertex model id to use for generation.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Language code for content. Use language tags defined by
+          #     [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
+          # @!attribute [rw] temperature
+          #   @return [::Float]
+          #     If specified, custom value for the temperature will be used.
+          # @!attribute [rw] top_p
+          #   @return [::Float]
+          #     If specified, custom value for nucleus sampling will be used.
+          # @!attribute [rw] top_k
+          #   @return [::Integer]
+          #     If specified, custom value for top-k sampling will be used.
+          # @!attribute [rw] frequency_penalty
+          #   @return [::Float]
+          #     If specified, custom value for frequency penalty will be used.
+          # @!attribute [rw] presence_penalty
+          #   @return [::Float]
+          #     If specified, custom value for presence penalty will be used.
+          # @!attribute [rw] max_output_tokens
+          #   @return [::Integer]
+          #     If specified, custom value for max output tokens will be used.
+          class GenerationSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the options to customize dynamic retrieval.
+          # @!attribute [rw] predictor
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration::DynamicRetrievalPredictor]
+          #     Specification for the predictor for dynamic retrieval.
+          class DynamicRetrievalConfiguration
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes the predictor settings for dynamic retrieval.
+            # @!attribute [rw] version
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration::DynamicRetrievalPredictor::Version]
+            #     The version of the predictor to be used in dynamic retrieval.
+            # @!attribute [rw] threshold
+            #   @return [::Float]
+            #     The value of the threshold. If the predictor will predict a
+            #     value smaller than this, it would suppress grounding in the source.
+            class DynamicRetrievalPredictor
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The version of the predictor to be used in dynamic retrieval.
+              module Version
+                # Automatically choose the best version of the retrieval predictor.
+                VERSION_UNSPECIFIED = 0
+
+                # The V1 model which is evaluating each source independently.
+                V1_INDEPENDENT = 1
+              end
+            end
+          end
+
+          # Grounding source.
+          # @!attribute [rw] inline_source
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::InlineSource]
+          #     If set, grounding is performed with inline content.
+          # @!attribute [rw] search_source
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::SearchSource]
+          #     If set, grounding is performed with Vertex AI Search.
+          # @!attribute [rw] google_search_source
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::GoogleSearchSource]
+          #     If set, grounding is performed with Google Search.
+          class GroundingSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Message to be used for grounding based on inline content.
+            # @!attribute [rw] grounding_facts
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
+            #     List of facts to be used for grounding.
+            # @!attribute [rw] attributes
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     Attributes associated with the content.
+            #
+            #     Common attributes include `source` (indicating where the content was
+            #     sourced from) and `author` (indicating the author of the content).
+            class InlineSource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class AttributesEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Message to be used for grounding with Vertex AI Search.
+            # @!attribute [rw] serving_config
+            #   @return [::String]
+            #     The resource name of the Engine to use.
+            #
+            #     Format:
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+            # @!attribute [rw] max_result_count
+            #   @return [::Integer]
+            #     Number of search results to return.
+            #
+            #     The default value is 10. The maximumm allowed value is 10.
+            # @!attribute [rw] filter
+            #   @return [::String]
+            #     Filter expression to be applied to the search.
+            #
+            #     The syntax is the same as
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
+            # @!attribute [rw] safe_search
+            #   @return [::Boolean]
+            #     If set, safe search is enabled in Vertex AI Search requests.
+            class SearchSource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Google Search config parameters.
+            # @!attribute [rw] dynamic_retrieval_config
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
+            #     Optional. Specifies the dynamic retrieval configuration for the given
+            #     source.
+            class GoogleSearchSource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Grounding specification.
+          # @!attribute [rw] grounding_sources
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource>]
+          #     Grounding sources.
+          class GroundingSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # @!attribute [rw] candidates
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate>]
+        #     Generated candidates.
+        class GenerateGroundedContentResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A response candidate generated from the model.
+          # @!attribute [rw] index
+          #   @return [::Integer]
+          #     Index of the candidate.
+          # @!attribute [rw] content
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent]
+          #     Content of the candidate.
+          # @!attribute [rw] grounding_score
+          #   @return [::Float]
+          #     The overall grounding score for the candidate, in the range of [0, 1].
+          # @!attribute [rw] grounding_metadata
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata]
+          #     Grounding metadata for the generated content.
+          class Candidate
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Citation for the generated content.
+            # @!attribute [rw] retrieval_metadata
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata>]
+            #     Retrieval metadata to provide an understanding in the
+            #     retrieval steps performed by the model. There can be multiple such
+            #     messages which can correspond to different parts of the retrieval. This
+            #     is a mechanism used to ensure transparency to our users.
+            # @!attribute [rw] support_chunks
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::FactChunk>]
+            #     List of chunks to be attributed across all claims in the candidate.
+            #     These are derived from the grounding sources supplied in the request.
+            # @!attribute [rw] web_search_queries
+            #   @return [::Array<::String>]
+            #     Web search queries for the following-up web search.
+            # @!attribute [rw] search_entry_point
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint]
+            #     Google search entry for the following-up web searches.
+            # @!attribute [rw] grounding_support
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::GroundingSupport>]
+            #     GroundingSupport across all claims in the answer candidate.
+            #     An support to a fact indicates that the claim is supported by
+            #     the fact.
+            class GroundingMetadata
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Describes the metadata associated with a retrieval step.
+              # @!attribute [rw] source
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata::Source]
+              #     Describes the source to which the metadata is referring to.
+              # @!attribute [rw] dynamic_retrieval_metadata
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalMetadata]
+              #     Metadata for dynamic retrieval.
+              class RetrievalMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # Describes the source to which the metadata is associated to.
+                module Source
+                  # Unspecified source.
+                  SOURCE_UNSPECIFIED = 0
+
+                  # Vertex AI search.
+                  VERTEX_AI_SEARCH = 1
+
+                  # Google Search.
+                  GOOGLE_SEARCH = 3
+
+                  # User inline provided content.
+                  INLINE_CONTENT = 2
+
+                  # Google Maps.
+                  GOOGLE_MAPS = 4
+                end
+              end
+
+              # Describes the metadata about dynamic retrieval.
+              # @!attribute [rw] predictor_metadata
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata]
+              #     Metadata for the dynamic retrieval predictor.
+              class DynamicRetrievalMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Describes the metadata about the dynamic retrieval predictor.
+              # @!attribute [rw] version
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata::Version]
+              #     The version of the predictor which was used in dynamic retrieval.
+              # @!attribute [rw] prediction
+              #   @return [::Float]
+              #     The value of the predictor. This should be between [0, 1] where
+              #     a value of 0 means that the query would not benefit from grounding,
+              #     while a value of 1.0 means that the query would benefit the most.
+              #     In between values allow to differentiate between different usefulness
+              #     scores for grounding.
+              class DynamicRetrievalPredictorMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # The version of the predictor which was used in dynamic retrieval.
+                module Version
+                  # Unspecified version, should never be used.
+                  VERSION_UNSPECIFIED = 0
+
+                  # The V1 model which is evaluating each source independently.
+                  V1_INDEPENDENT = 1
+                end
+              end
+
+              # Google search entry point.
+              # @!attribute [rw] rendered_content
+              #   @return [::String]
+              #     Web content snippet that can be embedded in a web page or an app
+              #     webview.
+              # @!attribute [rw] sdk_blob
+              #   @return [::String]
+              #     Base64 encoded JSON representing array of <search term, search url>
+              #     tuple.
+              class SearchEntryPoint
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Grounding info for a claim in the candidate and its support.
+              # @!attribute [rw] claim_text
+              #   @return [::String]
+              #     Text for the claim in the candidate. Always provided when a
+              #     support is found.
+              # @!attribute [rw] support_chunk_indices
+              #   @return [::Array<::Integer>]
+              #     A list of indices (into 'support_chunks') specifying the
+              #     citations associated with the claim. For instance [1,3,4] means
+              #     that support_chunks[1], support_chunks[3],
+              #     support_chunks[4] are the chunks attributed to the claim.
+              # @!attribute [rw] support_score
+              #   @return [::Float]
+              #     A score in the range of [0, 1] describing how grounded is a specific
+              #     claim in the support chunks indicated.
+              #     Higher value means that the claim is better supported by the chunks.
+              class GroundingSupport
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+
         # Specification for the grounding check.
         # @!attribute [rw] citation_threshold
         #   @return [::Float]

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

@@ -25,7 +25,7 @@ module Google
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. Full resource name of the project, for example
-        #     `projects/{project_number}`.
+        #     `projects/{project}`.
         #     Note that when making requests, project number and project id are both
         #     acceptable, but the server will always respond in project number.
         # @!attribute [r] create_time

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

@@ -26,7 +26,7 @@ module Google
         #   @return [::String]
         #     Required. The resource name of the catalog under which the events are
         #     created. The format is
-        #     `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`
+        #     `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
         # @!attribute [rw] filter
         #   @return [::String]
         #     Required. The filter string to specify the events to be deleted with a

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

@@ -53,7 +53,7 @@ module Google
         # @!attribute [rw] ranking_config
         #   @return [::String]
         #     Required. The resource name of the rank service config, such as
-        #     `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+        #     `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
         # @!attribute [rw] model
         #   @return [::String]
         #     The identifier of the model to use. It is one of:

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

@@ -76,6 +76,11 @@ module Google
         #     unset.
         #
         #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        # @!attribute [rw] one_box_page_size
+        #   @return [::Integer]
+        #     The maximum number of results to return for OneBox.
+        #     This applies to each OneBox type individually.
+        #     Default number is 10.
         # @!attribute [rw] data_store_specs
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>]
         #     Specs defining dataStores to filter on in a search call and configurations
@@ -278,6 +283,11 @@ module Google
           #     Required. Full resource name of
           #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, such as
           #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Optional. Filter specification to filter documents in the data store
+          #     specified by data_store field. For more information on filtering, see
+          #     [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
           class DataStoreSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -468,9 +478,93 @@ module Google
             #     ignored. Only one of the (condition, boost) combination or the
             #     boost_control_spec below are set. If both are set then the global boost
             #     is ignored and the more fine-grained boost_control_spec is applied.
+            # @!attribute [rw] boost_control_spec
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec]
+            #     Complex specification for custom ranking based on customer defined
+            #     attribute value.
             class ConditionBoostSpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Specification for custom ranking based on customer specified attribute
+              # value. It provides more controls for customized ranking than the simple
+              # (condition, boost) combination above.
+              # @!attribute [rw] field_name
+              #   @return [::String]
+              #     The name of the field whose value will be used to determine the
+              #     boost amount.
+              # @!attribute [rw] attribute_type
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
+              #     The attribute type to be used to determine the boost amount. The
+              #     attribute value can be derived from the field value of the specified
+              #     field_name. In the case of numerical it is straightforward i.e.
+              #     attribute_value = numerical_field_value. In the case of freshness
+              #     however, attribute_value = (time.now() - datetime_field_value).
+              # @!attribute [rw] interpolation_type
+              #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
+              #     The interpolation type to be applied to connect the control points
+              #     listed below.
+              # @!attribute [rw] control_points
+              #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
+              #     The control points used to define the curve. The monotonic function
+              #     (defined through the interpolation_type above) passes through the
+              #     control points listed here.
+              class BoostControlSpec
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # The control points used to define the curve. The curve defined
+                # through these control points can only be monotonically increasing
+                # or decreasing(constant values are acceptable).
+                # @!attribute [rw] attribute_value
+                #   @return [::String]
+                #     Can be one of:
+                #     1. The numerical field value.
+                #     2. The duration spec for freshness:
+                #     The value must be formatted as an XSD `dayTimeDuration` value (a
+                #     restricted subset of an ISO 8601 duration value). The pattern for
+                #     this is: `[nD][T[nH][nM][nS]]`.
+                # @!attribute [rw] boost_amount
+                #   @return [::Float]
+                #     The value between -1 to 1 by which to boost the score if the
+                #     attribute_value evaluates to the value specified above.
+                class ControlPoint
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+
+                # The attribute(or function) for which the custom ranking is to be
+                # applied.
+                module AttributeType
+                  # Unspecified AttributeType.
+                  ATTRIBUTE_TYPE_UNSPECIFIED = 0
+
+                  # The value of the numerical field will be used to dynamically update
+                  # the boost amount. In this case, the attribute_value (the x value)
+                  # of the control point will be the actual value of the numerical
+                  # field for which the boost_amount is specified.
+                  NUMERICAL = 1
+
+                  # For the freshness use case the attribute value will be the duration
+                  # between the current time and the date in the datetime field
+                  # specified. The value must be formatted as an XSD `dayTimeDuration`
+                  # value (a restricted subset of an ISO 8601 duration value). The
+                  # pattern for this is: `[nD][T[nH][nM][nS]]`.
+                  # For example, `5D`, `3DT12H30M`, `T24H`.
+                  FRESHNESS = 2
+                end
+
+                # The interpolation type to be applied. Default will be linear
+                # (Piecewise Linear).
+                module InterpolationType
+                  # Interpolation type is unspecified. In this case, it defaults to
+                  # Linear.
+                  INTERPOLATION_TYPE_UNSPECIFIED = 0
+
+                  # Piecewise linear interpolation will be applied.
+                  LINEAR = 1
+                end
+              end
             end
           end
 
@@ -650,6 +744,19 @@ module Google
             #     If this field is set to `false`, all search results are used regardless
             #     of relevance to generate answers. If set to `true`, only queries with
             #     high relevance search results will generate answers.
+            # @!attribute [rw] ignore_jail_breaking_query
+            #   @return [::Boolean]
+            #     Optional. Specifies whether to filter out jail-breaking queries. The
+            #     default value is `false`.
+            #
+            #     Google employs search-query classification to detect jail-breaking
+            #     queries. No summary is returned if the search query is classified as a
+            #     jail-breaking query. A user might add instructions to the query to
+            #     change the tone, style, language, content of the answer, or ask the
+            #     model to act as a different entity, e.g. "Reply in the tone of a
+            #     competing company's CEO". If this field is set to `true`, we skip
+            #     generating summaries for jail-breaking queries and return fallback
+            #     messages instead.
             # @!attribute [rw] model_prompt_spec
             #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
             #     If specified, the spec will be used to modify the prompt provided to
@@ -1132,6 +1239,7 @@ module Google
 
               # The non-summary seeking query ignored case.
               #
+              # Google skips the summary if the query is chit chat.
               # Only used when
               # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
               # is set to `true`.
@@ -1174,6 +1282,14 @@ module Google
               # Google skips the summary if there is a customer policy violation
               # detected. The policy is defined by the customer.
               CUSTOMER_POLICY_VIOLATION = 8
+
+              # The non-answer seeking query ignored case.
+              #
+              # Google skips the summary if the query doesn't have clear intent.
+              # Only used when
+              # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
+              # is set to `true`.
+              NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
             end
           end
 

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

@@ -346,6 +346,11 @@ module Google
         #     an INVALID_ARGUMENT error is thrown. Each URI should match at least one
         #     {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} in
         #     `site_search_engine`.
+        # @!attribute [rw] site_credential
+        #   @return [::String]
+        #     Optional. Full resource name of the [SiteCredential][], such as
+        #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
+        #     Only set to crawl private URIs.
         class RecrawlUrisRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -427,7 +427,7 @@ module Google
         #   @return [::String]
         #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document} resource full
         #     name, of the form:
-        #     `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
         # @!attribute [rw] uri
         #   @return [::String]
         #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document} URI - only

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.21
 signing_key: 
 specification_version: 4
 summary: Discovery Engine API.