Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

Request message for RankService.Rank method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1RankRequest

Returns a new instance of GoogleCloudDiscoveryengineV1RankRequest.



5538
5539
5540
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5538

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ignore_record_details_in_response ⇒ Boolean Also known as: ignore_record_details_in_response?

If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. Corresponds to the JSON property ignoreRecordDetailsInResponse

Returns:

  • (Boolean) 


5497
5498
5499
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5497

def ignore_record_details_in_response
  @ignore_record_details_in_response
end

#model ⇒ 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. Corresponds to the JSON property model

Returns:

  • (String) 


5505
5506
5507
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5505

def model
  @model
end

#query ⇒ String

The query to use. Corresponds to the JSON property query

Returns:

  • (String) 


5510
5511
5512
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5510

def query
  @query
end

#records ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankingRecord>

Required. A list of records to rank. At most 200 records to rank. Corresponds to the JSON property records

Returns:



5515
5516
5517
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5515

def records
  @records
end

#top_n ⇒ Fixnum

The number of results to return. If this is unset or no bigger than zero, returns all results. Corresponds to the JSON property topN

Returns:

  • (Fixnum) 


5521
5522
5523
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5521

def top_n
  @top_n
end

#user_labels ⇒ Hash<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. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


5536
5537
5538
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5536

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5543
5544
5545
5546
5547
5548
5549
5550
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5543

def update!(**args)
  @ignore_record_details_in_response = args[:ignore_record_details_in_response] if args.key?(:ignore_record_details_in_response)
  @model = args[:model] if args.key?(:model)
  @query = args[:query] if args.key?(:query)
  @records = args[:records] if args.key?(:records)
  @top_n = args[:top_n] if args.key?(:top_n)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
end