Class: Google::Cloud::DiscoveryEngine::V1::RankRequest

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

Request message for RankService.Rank method.

Defined Under Namespace

Classes: UserLabelsEntry

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.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::String

Returns The query to use.

Returns:

  • (::String) —

    The query to use.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ranking_config ⇒ ::String

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

Returns:

  • (::String) —

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



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

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

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The user labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/discoveryengine/v1/rank_service.rb', line 98

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end