Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompletionSuggestion

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

Autocomplete suggestions that are imported from Customer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaCompletionSuggestion

Returns a new instance of GoogleCloudDiscoveryengineV1betaCompletionSuggestion.



12516
12517
12518
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12516

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>) 


12480
12481
12482
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12480

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) 


12486
12487
12488
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12486

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) 


12492
12493
12494
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12492

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) 


12499
12500
12501
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12499

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) 


12504
12505
12506
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12504

def group_score
  @group_score
end

#language_code ⇒ String

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

Returns:

  • (String) 


12509
12510
12511
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12509

def language_code
  @language_code
end

#suggestion ⇒ String

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

Returns:

  • (String) 


12514
12515
12516
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12514

def suggestion
  @suggestion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12521
12522
12523
12524
12525
12526
12527
12528
12529
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 12521

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