Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankingRecord

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

Record message for RankService.Rank method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1RankingRecord

Returns a new instance of GoogleCloudDiscoveryengineV1RankingRecord.



7456
7457
7458
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7456

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

Instance Attribute Details

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

Returns:

  • (String) 


7436
7437
7438
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7436

def content
  @content
end

#id ⇒ String

The unique ID to represent the record. Corresponds to the JSON property id

Returns:

  • (String) 


7441
7442
7443
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7441

def id
  @id
end

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

Returns:

  • (Float) 


7448
7449
7450
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7448

def score
  @score
end

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

Returns:

  • (String) 


7454
7455
7456
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7454

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7461
7462
7463
7464
7465
7466
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7461

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @id = args[:id] if args.key?(:id)
  @score = args[:score] if args.key?(:score)
  @title = args[:title] if args.key?(:title)
end