Class: Google::Cloud::DiscoveryEngine::V1::RankingRecord

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

Overview

Record message for RankService.Rank method.

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ ::String

Returns The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Returns:

  • (::String) —

    The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.



48
49
50
51
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 48

class RankingRecord
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

Returns The unique ID to represent the record.

Returns:

  • (::String) —

    The unique ID to represent the record.



48
49
50
51
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 48

class RankingRecord
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#score ⇒ ::Float

Returns The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.

Returns:

  • (::Float) —

    The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.



48
49
50
51
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 48

class RankingRecord
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#title ⇒ ::String

Returns The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Returns:

  • (::String) —

    The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.



48
49
50
51
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 48

class RankingRecord
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end