Class: Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult::RankSignals

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

A set of ranking signals.

Defined Under Namespace

Classes: CustomSignal

Instance Attribute Summary collapse

Instance Attribute Details

#boosting_factor ⇒ ::Float

Returns Combined custom boosts for a doc.

Returns:

  • (::Float) —

    Combined custom boosts for a doc.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#custom_signals ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult::RankSignals::CustomSignal>

Returns A list of custom clearbox signals.

Returns:



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#default_rank ⇒ ::Float

Returns The default rank of the result.

Returns:

  • (::Float) —

    The default rank of the result.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#document_age ⇒ ::Float

Returns Age of the document in hours.

Returns:

  • (::Float) —

    Age of the document in hours.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#keyword_similarity_score ⇒ ::Float

Returns Keyword matching adjustment.

Returns:

  • (::Float) —

    Keyword matching adjustment.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pctr_rank ⇒ ::Float

Returns Predicted conversion rate adjustment as a rank.

Returns:

  • (::Float) —

    Predicted conversion rate adjustment as a rank.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#relevance_score ⇒ ::Float

Returns Semantic relevance adjustment.

Returns:

  • (::Float) —

    Semantic relevance adjustment.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#semantic_similarity_score ⇒ ::Float

Returns Semantic similarity adjustment.

Returns:

  • (::Float) —

    Semantic similarity adjustment.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#topicality_rank ⇒ ::Float

Returns Topicality adjustment as a rank.

Returns:

  • (::Float) —

    Topicality adjustment as a rank.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1378

class RankSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Custom clearbox signal represented by name and value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the signal.
  # @!attribute [rw] value
  #   @return [::Float]
  #     Float value representing the ranking signal (e.g. 1.25 for BM25).
  class CustomSignal
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end