Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionSuggestion

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

Autocomplete suggestions that are imported from Customer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CompletionSuggestion

Returns a new instance of GoogleCloudDiscoveryengineV1CompletionSuggestion.



2334
2335
2336
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2334

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

Instance Attribute Details

#alternative_phrases ⇒ Array<String>

Alternative matching phrases for this suggestion. Corresponds to the JSON property alternativePhrases

Returns:

  • (Array<String>) 


2298
2299
2300
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2298

def alternative_phrases
  @alternative_phrases
end

#frequency ⇒ Fixnum

Frequency of this suggestion. Will be used to rank suggestions when score is not available. Corresponds to the JSON property frequency

Returns:

  • (Fixnum) 


2304
2305
2306
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2304

def frequency
  @frequency
end

#global_score ⇒ Float

Global score of this suggestion. Control how this suggestion would be scored / ranked. Corresponds to the JSON property globalScore

Returns:

  • (Float) 


2310
2311
2312
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2310

def global_score
  @global_score
end

#group_id ⇒ String

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. Corresponds to the JSON property groupId

Returns:

  • (String) 


2317
2318
2319
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2317

def group_id
  @group_id
end

#group_score ⇒ Float

The score of this suggestion within its group. Corresponds to the JSON property groupScore

Returns:

  • (Float) 


2322
2323
2324
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2322

def group_score
  @group_score
end

#language_code ⇒ String

BCP-47 language code of this suggestion. Corresponds to the JSON property languageCode

Returns:

  • (String) 


2327
2328
2329
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2327

def language_code
  @language_code
end

#suggestion ⇒ String

Required. The suggestion text. Corresponds to the JSON property suggestion

Returns:

  • (String) 


2332
2333
2334
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2332

def suggestion
  @suggestion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2339
2340
2341
2342
2343
2344
2345
2346
2347
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2339

def update!(**args)
  @alternative_phrases = args[:alternative_phrases] if args.key?(:alternative_phrases)
  @frequency = args[:frequency] if args.key?(:frequency)
  @global_score = args[:global_score] if args.key?(:global_score)
  @group_id = args[:group_id] if args.key?(:group_id)
  @group_score = args[:group_score] if args.key?(:group_score)
  @language_code = args[:language_code] if args.key?(:language_code)
  @suggestion = args[:suggestion] if args.key?(:suggestion)
end