Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompletionSuggestion

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

Overview

Autocomplete suggestions that are imported from Customer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaCompletionSuggestion

Returns a new instance of GoogleCloudDiscoveryengineV1alphaCompletionSuggestion.



4805
4806
4807
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4805

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


4769
4770
4771
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4769

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) 


4775
4776
4777
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4775

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) 


4781
4782
4783
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4781

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) 


4788
4789
4790
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4788

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) 


4793
4794
4795
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4793

def group_score
  @group_score
end

#language_code ⇒ String

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

Returns:

  • (String) 


4798
4799
4800
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4798

def language_code
  @language_code
end

#suggestion ⇒ String

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

Returns:

  • (String) 


4803
4804
4805
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4803

def suggestion
  @suggestion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4810
4811
4812
4813
4814
4815
4816
4817
4818
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4810

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