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

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

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

Overview

A set of ranking signals.

Defined Under Namespace

Classes: CustomSignal

Instance Attribute Summary

• #boosting_factor ⇒ ::Float

  Combined custom boosts for a doc.

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

  A list of custom clearbox signals.

• #default_rank ⇒ ::Float

  The default rank of the result.

• #document_age ⇒ ::Float

  Age of the document in hours.

• #keyword_similarity_score ⇒ ::Float

  Keyword matching adjustment.

• #pctr_rank ⇒ ::Float

  Predicted conversion rate adjustment as a rank.

• #relevance_score ⇒ ::Float

  Semantic relevance adjustment.

• #semantic_similarity_score ⇒ ::Float

  Semantic similarity adjustment.

• #topicality_rank ⇒ ::Float

  Topicality adjustment as a rank.

Instance Attribute Details

#boosting_factor ⇒ ::Float

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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::V1::SearchResponse::SearchResult::RankSignals::CustomSignal>

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 1313

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