Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankingRecord

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

Overview

Record message for RankService.Rank method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaRankingRecord

Returns a new instance of GoogleCloudDiscoveryengineV1betaRankingRecord.



15910
15911
15912
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15910

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

Instance Attribute Details

#contentString

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)


15890
15891
15892
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15890

def content
  @content
end

#idString

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

Returns:

  • (String)


15895
15896
15897
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15895

def id
  @id
end

#scoreFloat

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)


15902
15903
15904
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15902

def score
  @score
end

#titleString

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)


15908
15909
15910
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15908

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15915
15916
15917
15918
15919
15920
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15915

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