Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

A set of ranking signals.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals.



31965
31966
31967
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31965

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boosting_factor ⇒ Float

Optional. Combined custom boosts for a doc. Corresponds to the JSON property boostingFactor

Returns:

  • (Float) 


31916
31917
31918
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31916

def boosting_factor
  @boosting_factor
end

#custom_signals ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignalsCustomSignal>

Optional. A list of custom clearbox signals. Corresponds to the JSON property customSignals

Returns:



31921
31922
31923
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31921

def custom_signals
  @custom_signals
end

#default_rank ⇒ Float

Optional. The default rank of the result. Corresponds to the JSON property defaultRank

Returns:

  • (Float) 


31926
31927
31928
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31926

def default_rank
  @default_rank
end

#document_age ⇒ Float

Optional. Age of the document in hours. Corresponds to the JSON property documentAge

Returns:

  • (Float) 


31931
31932
31933
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31931

def document_age
  @document_age
end

#keyword_similarity_score ⇒ Float

Optional. Keyword matching adjustment. Corresponds to the JSON property keywordSimilarityScore

Returns:

  • (Float) 


31936
31937
31938
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31936

def keyword_similarity_score
  @keyword_similarity_score
end

#pctr_rank ⇒ Float

Optional. Predicted conversion rate adjustment as a rank. Corresponds to the JSON property pctrRank

Returns:

  • (Float) 


31941
31942
31943
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31941

def pctr_rank
  @pctr_rank
end

#precomputed_expression_values ⇒ Array<Float>

Optional. A list of precomputed expression results for a given document, in the same order as requested in SearchRequest.custom_ranking_params. expressions_to_precompute. Corresponds to the JSON property precomputedExpressionValues

Returns:

  • (Array<Float>) 


31948
31949
31950
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31948

def precomputed_expression_values
  @precomputed_expression_values
end

#relevance_score ⇒ Float

Optional. Semantic relevance adjustment. Corresponds to the JSON property relevanceScore

Returns:

  • (Float) 


31953
31954
31955
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31953

def relevance_score
  @relevance_score
end

#semantic_similarity_score ⇒ Float

Optional. Semantic similarity adjustment. Corresponds to the JSON property semanticSimilarityScore

Returns:

  • (Float) 


31958
31959
31960
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31958

def semantic_similarity_score
  @semantic_similarity_score
end

#topicality_rank ⇒ Float

Optional. Topicality adjustment as a rank. Corresponds to the JSON property topicalityRank

Returns:

  • (Float) 


31963
31964
31965
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31963

def topicality_rank
  @topicality_rank
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31970
31971
31972
31973
31974
31975
31976
31977
31978
31979
31980
31981
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31970

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)
  @precomputed_expression_values = args[:precomputed_expression_values] if args.key?(:precomputed_expression_values)
  @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