Class: Google::Cloud::DiscoveryEngine::V1beta::RankRequest

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

Overview

Request message for RankService.Rank method.

Instance Attribute Summary collapse

Instance Attribute Details

#ignore_record_details_in_response ⇒ ::Boolean

Returns If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.

Returns:

  • (::Boolean) —

    If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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

#model ⇒ ::String

Returns The identifier of the model to use. It is one of:

  • semantic-ranker-512@latest: Semantic ranking model with maxiumn input token size 512.

It is set to semantic-ranker-512@latest by default if unspecified.

Returns:

  • (::String) —

    The identifier of the model to use. It is one of:

    • semantic-ranker-512@latest: Semantic ranking model with maxiumn input token size 512.

    It is set to semantic-ranker-512@latest by default if unspecified.



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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

#query ⇒ ::String

Returns The query to use.

Returns:

  • (::String) —

    The query to use.



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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

#ranking_config ⇒ ::String

Returns Required. The resource name of the rank service config, such as projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config.

Returns:

  • (::String) —

    Required. The resource name of the rank service config, such as projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config.



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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

#records ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>

Returns Required. A list of records to rank. At most 200 records to rank.

Returns:



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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

#top_n ⇒ ::Integer

The number of results to return. If this is unset or no bigger than zero, returns all results.

Returns:

  • (::Integer) —

    The number of results to return. If this is unset or no bigger than zero, returns all results.



81
82
83
84
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb', line 81

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