google-apis-discoveryengine_v1 0.47.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a1984fea79b1204ca0f384c027daaad249fbfd9bfa8be77f3f2b7a991347c71
-  data.tar.gz: 3b421b320cf898d3ac6fca0213256732706b3c9fd421474fd03a9f222bac0431
+  metadata.gz: ee49b1bf268d9daf09a17cec0b4236b127f53410f403a1adf083bb939e5122c5
+  data.tar.gz: c4f0cc1595392f2f7dd6f6b35bfae3462562a7ca33c2d615159d7bc873bfc472
 SHA512:
-  metadata.gz: 13b88840f4250c827cca3e1db80c189f2c6fc2bfb0da2dfffe9b363a6c50754cec1841a783973eba767ba465ca469597eabf55c3bf2a1453b33222b8f9d40f55
-  data.tar.gz: b302f2e2db31a52bc09d98cfda5774576777d5e233909d7a661af5943ebd7c4e34db4edb4ad78fc12b4b3d3d47965e2c6b47b43a7c3f9aaa2525d4348f632d7e
+  metadata.gz: c49af7964e53800f856bf43a8b728478bf4b595ea67a78aed604523ea70b9b8cc1f17b2be9597b1646149ebefa9b4ee0cc1c8170dc67b34440965dacd251a190
+  data.tar.gz: d313c9577233d234012ac0ea7f3ebf4d5aad25b0b0270e8600961e5d9376392087e43593cf2df2587a13007b6dbed16a0a9fa9afda1d2d2a85c42acfdb9e4bde

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1
 
+### v0.48.0 (2025-08-24)
+
+* Regenerated from discovery document revision 20250816
+
 ### v0.47.0 (2025-08-10)
 
 * Regenerated from discovery document revision 20250803

data/lib/google/apis/discoveryengine_v1/classes.rb

@@ -10683,6 +10683,65 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec]
         attr_accessor :query_expansion_spec
       
+        # Optional. The ranking expression controls the customized ranking on retrieval
+        # documents. This overrides ServingConfig.ranking_expression. The syntax and
+        # supported features depend on the `ranking_expression_backend` value. If `
+        # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
+        # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
+        # it should be a single function or multiple functions that are joined by "+". *
+        # ranking_expression = function, ` " + ", function `; Supported functions: *
+        # double * relevance_score * double * dotProduct(embedding_field_path) Function
+        # variables: * `relevance_score`: pre-defined keywords, used for measure
+        # relevance between query and document. * `embedding_field_path`: the document
+        # embedding field used with query embedding vector. * `dotProduct`: embedding
+        # function between `embedding_field_path` and query embedding vector. Example
+        # ranking expression: If document has an embedding field doc_embedding, the
+        # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
+        # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
+        # the following expression types (and combinations of those chained using + or *
+        # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
+        # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
+        # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
+        # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
+        # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
+        # examples of ranking formulas that use the supported ranking expression types: -
+        # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
+        # mostly rank by the logarithm of `keyword_similarity_score` with slight `
+        # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
+        # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
+        # rank by the exponent of `semantic_similarity_score` filling the value with 0
+        # if it's NaN, also add constant 0.3 adjustment to the final score if `
+        # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
+        # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
+        # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
+        # semantic_smilarity_score`. The following signals are supported: * `
+        # semantic_similarity_score`: semantic similarity adjustment that is calculated
+        # using the embeddings generated by a proprietary Google model. This score
+        # determines how semantically similar a search query is to a document. * `
+        # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
+        # BM25) ranking function. This score is calculated using a probabilistic model
+        # to estimate the probability that a document is relevant to a given query. * `
+        # relevance_score`: semantic relevance adjustment that uses a proprietary Google
+        # model to determine the meaning and intent behind a user's query in context
+        # with the content in the documents. * `pctr_rank`: predicted conversion rate
+        # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
+        # relevance and attractiveness of a search result from a user's perspective. A
+        # higher pCTR suggests that the result is more likely to satisfy the user's
+        # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
+        # freshness adjustment as a rank * `document_age`: The time in hours elapsed
+        # since the document was last updated, a floating-point number (e.g., 0.25 means
+        # 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses
+        # proprietary Google model to determine the keyword-based overlap between the
+        # query and the document. * `base_rank`: the default rank of the result
+        # Corresponds to the JSON property `rankingExpression`
+        # @return [String]
+        attr_accessor :ranking_expression
+      
+        # Optional. The backend to use for the ranking expression evaluation.
+        # Corresponds to the JSON property `rankingExpressionBackend`
+        # @return [String]
+        attr_accessor :ranking_expression_backend
+      
         # The specification for returning the document relevance score.
         # Corresponds to the JSON property `relevanceScoreSpec`
         # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec]
@@ -10792,6 +10851,8 @@ module Google
           @params = args[:params] if args.key?(:params)
           @query = args[:query] if args.key?(:query)
           @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
+          @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
+          @ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
           @relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
           @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
           @safe_search = args[:safe_search] if args.key?(:safe_search)
@@ -11314,6 +11375,8 @@ module Google
       
         # Required. Full resource name of DataStore, such as `projects/`project`/
         # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
+        # The path must include the project number, project id is not supported for this
+        # field.
         # Corresponds to the JSON property `dataStore`
         # @return [String]
         attr_accessor :data_store
@@ -11864,6 +11927,11 @@ module Google
         # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList>]
         attr_accessor :model_scores
       
+        # A set of ranking signals.
+        # Corresponds to the JSON property `rankSignals`
+        # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals]
+        attr_accessor :rank_signals
+      
         def initialize(**args)
            update!(**args)
         end
@@ -11874,6 +11942,99 @@ module Google
           @document = args[:document] if args.key?(:document)
           @id = args[:id] if args.key?(:id)
           @model_scores = args[:model_scores] if args.key?(:model_scores)
+          @rank_signals = args[:rank_signals] if args.key?(:rank_signals)
+        end
+      end
+      
+      # A set of ranking signals.
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Combined custom boosts for a doc.
+        # Corresponds to the JSON property `boostingFactor`
+        # @return [Float]
+        attr_accessor :boosting_factor
+      
+        # Optional. A list of custom clearbox signals.
+        # Corresponds to the JSON property `customSignals`
+        # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal>]
+        attr_accessor :custom_signals
+      
+        # Optional. The default rank of the result.
+        # Corresponds to the JSON property `defaultRank`
+        # @return [Float]
+        attr_accessor :default_rank
+      
+        # Optional. Age of the document in hours.
+        # Corresponds to the JSON property `documentAge`
+        # @return [Float]
+        attr_accessor :document_age
+      
+        # Optional. Keyword matching adjustment.
+        # Corresponds to the JSON property `keywordSimilarityScore`
+        # @return [Float]
+        attr_accessor :keyword_similarity_score
+      
+        # Optional. Predicted conversion rate adjustment as a rank.
+        # Corresponds to the JSON property `pctrRank`
+        # @return [Float]
+        attr_accessor :pctr_rank
+      
+        # Optional. Semantic relevance adjustment.
+        # Corresponds to the JSON property `relevanceScore`
+        # @return [Float]
+        attr_accessor :relevance_score
+      
+        # Optional. Semantic similarity adjustment.
+        # Corresponds to the JSON property `semanticSimilarityScore`
+        # @return [Float]
+        attr_accessor :semantic_similarity_score
+      
+        # Optional. Topicality adjustment as a rank.
+        # Corresponds to the JSON property `topicalityRank`
+        # @return [Float]
+        attr_accessor :topicality_rank
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @boosting_factor = args[:boosting_factor] if args.key?(:boosting_factor)
+          @custom_signals = args[:custom_signals] if args.key?(:custom_signals)
+          @default_rank = args[:default_rank] if args.key?(:default_rank)
+          @document_age = args[:document_age] if args.key?(:document_age)
+          @keyword_similarity_score = args[:keyword_similarity_score] if args.key?(:keyword_similarity_score)
+          @pctr_rank = args[:pctr_rank] if args.key?(:pctr_rank)
+          @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
+          @semantic_similarity_score = args[:semantic_similarity_score] if args.key?(:semantic_similarity_score)
+          @topicality_rank = args[:topicality_rank] if args.key?(:topicality_rank)
+        end
+      end
+      
+      # Custom clearbox signal represented by name and value pair.
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Name of the signal.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Optional. Float value representing the ranking signal (e.g. 1.25 for BM25).
+        # Corresponds to the JSON property `value`
+        # @return [Float]
+        attr_accessor :value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @name = args[:name] if args.key?(:name)
+          @value = args[:value] if args.key?(:value)
         end
       end
       
@@ -13809,6 +13970,13 @@ module Google
         # @return [String]
         attr_accessor :service_name
       
+        # Optional. Whether to use static secrets for the connector. If true, the
+        # secrets provided in the action_params will be ignored.
+        # Corresponds to the JSON property `useStaticSecrets`
+        # @return [Boolean]
+        attr_accessor :use_static_secrets
+        alias_method :use_static_secrets?, :use_static_secrets
+      
         def initialize(**args)
            update!(**args)
         end
@@ -13818,6 +13986,7 @@ module Google
           @action_params = args[:action_params] if args.key?(:action_params)
           @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
           @service_name = args[:service_name] if args.key?(:service_name)
+          @use_static_secrets = args[:use_static_secrets] if args.key?(:use_static_secrets)
         end
       end
       
@@ -15808,6 +15977,14 @@ module Google
         # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
         attr_accessor :errors
       
+        # Optional. If the connector is a hybrid connector, determines whether ingestion
+        # is enabled and appropriate resources are provisioned during connector creation.
+        # If the connector is not a hybrid connector, this field is ignored.
+        # Corresponds to the JSON property `hybridIngestionDisabled`
+        # @return [Boolean]
+        attr_accessor :hybrid_ingestion_disabled
+        alias_method :hybrid_ingestion_disabled?, :hybrid_ingestion_disabled
+      
         # The refresh interval to sync the Access Control List information for the
         # documents ingested by this connector. If not set, the access control list will
         # be refreshed at the default interval of 30 minutes. The identity refresh
@@ -15987,6 +16164,7 @@ module Google
           @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
           @entities = args[:entities] if args.key?(:entities)
           @errors = args[:errors] if args.key?(:errors)
+          @hybrid_ingestion_disabled = args[:hybrid_ingestion_disabled] if args.key?(:hybrid_ingestion_disabled)
           @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
           @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
           @incremental_refresh_interval = args[:incremental_refresh_interval] if args.key?(:incremental_refresh_interval)
@@ -18594,8 +18772,8 @@ module Google
       
         # A comma-separated list of fields to order by, sorted in ascending order. Use "
         # desc" after a field name for descending. Supported fields: * `update_time` * `
-        # create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
-        # create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        # create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
+        # create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
         # first, then by update_time.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
@@ -20496,6 +20674,8 @@ module Google
       
         # Required. Full resource name of DataStore, such as `projects/`project`/
         # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
+        # The path must include the project number, project id is not supported for this
+        # field.
         # Corresponds to the JSON property `dataStore`
         # @return [String]
         attr_accessor :data_store
@@ -25865,6 +26045,8 @@ module Google
       
         # Required. Full resource name of DataStore, such as `projects/`project`/
         # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
+        # The path must include the project number, project id is not supported for this
+        # field.
         # Corresponds to the JSON property `dataStore`
         # @return [String]
         attr_accessor :data_store

data/lib/google/apis/discoveryengine_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1
       # Version of the google-apis-discoveryengine_v1 gem
-      GEM_VERSION = "0.47.0"
+      GEM_VERSION = "0.48.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250803"
+      REVISION = "20250816"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1/representations.rb

@@ -1912,6 +1912,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1SearchResponseSessionInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -7244,6 +7256,8 @@ module Google
           property :query, as: 'query'
           property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec::Representation
       
+          property :ranking_expression, as: 'rankingExpression'
+          property :ranking_expression_backend, as: 'rankingExpressionBackend'
           property :relevance_score_spec, as: 'relevanceScoreSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec::Representation
       
           property :relevance_threshold, as: 'relevanceThreshold'
@@ -7522,6 +7536,32 @@ module Google
           property :id, as: 'id'
           hash :model_scores, as: 'modelScores', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList::Representation
       
+          property :rank_signals, as: 'rankSignals', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :boosting_factor, as: 'boostingFactor'
+          collection :custom_signals, as: 'customSignals', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal::Representation
+      
+          property :default_rank, as: 'defaultRank'
+          property :document_age, as: 'documentAge'
+          property :keyword_similarity_score, as: 'keywordSimilarityScore'
+          property :pctr_rank, as: 'pctrRank'
+          property :relevance_score, as: 'relevanceScore'
+          property :semantic_similarity_score, as: 'semanticSimilarityScore'
+          property :topicality_rank, as: 'topicalityRank'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :name, as: 'name'
+          property :value, as: 'value'
         end
       end
       
@@ -8020,6 +8060,7 @@ module Google
           hash :action_params, as: 'actionParams'
           property :is_action_configured, as: 'isActionConfigured'
           property :service_name, as: 'serviceName'
+          property :use_static_secrets, as: 'useStaticSecrets'
         end
       end
       
@@ -8587,6 +8628,7 @@ module Google
       
           collection :errors, as: 'errors', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
       
+          property :hybrid_ingestion_disabled, as: 'hybridIngestionDisabled'
           property :identity_refresh_interval, as: 'identityRefreshInterval'
           property :identity_schedule_config, as: 'identityScheduleConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig::Representation
       

data/lib/google/apis/discoveryengine_v1/service.rb

@@ -2515,8 +2515,8 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
-        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
+        #   create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
         #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max
@@ -4734,8 +4734,8 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
-        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
+        #   create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
         #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max
@@ -6878,8 +6878,8 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
-        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
+        #   create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
         #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 0.48.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.47.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.48.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
 rdoc_options: []
 require_paths: