Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::RankRequest (v0.14.1)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::RankRequest.

Request message for RankService.Rank method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#ignore_record_details_in_response

def ignore_record_details_in_response() -> ::Boolean
Returns
  • (::Boolean) — If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.

#ignore_record_details_in_response=

def ignore_record_details_in_response=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#model

def model() -> ::String
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.

#model=

def model=(value) -> ::String
Parameter
  • value (::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.

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.

#query

def query() -> ::String
Returns
  • (::String) — The query to use.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — The query to use.
Returns
  • (::String) — The query to use.

#ranking_config

def ranking_config() -> ::String
Returns
  • (::String) — Required. The resource name of the rank service config, such as projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config.

#ranking_config=

def ranking_config=(value) -> ::String
Parameter
  • value (::String) — 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.

#records

def records() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>
Returns

#records=

def records=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>
Parameter
Returns

#top_n

def top_n() -> ::Integer
Returns
  • (::Integer) — The number of results to return. If this is unset or no bigger than zero, returns all results.

#top_n=

def top_n=(value) -> ::Integer
Parameter
  • value (::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.

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
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.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::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.

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.