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.



23068
23069
23070
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23068

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


23032
23033
23034
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23032

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) 


23038
23039
23040
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23038

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) 


23044
23045
23046
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23044

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) 


23051
23052
23053
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23051

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) 


23056
23057
23058
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23056

def group_score
  @group_score
end

#language_code ⇒ String

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

Returns:

  • (String) 


23061
23062
23063
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23061

def language_code
  @language_code
end

#suggestion ⇒ String

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

Returns:

  • (String) 


23066
23067
23068
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23066

def suggestion
  @suggestion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23073
23074
23075
23076
23077
23078
23079
23080
23081
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23073

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