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.



2530
2531
2532
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2530

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


2494
2495
2496
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2494

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) 


2500
2501
2502
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2500

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) 


2506
2507
2508
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2506

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) 


2513
2514
2515
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2513

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) 


2518
2519
2520
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2518

def group_score
  @group_score
end

#language_code ⇒ String

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

Returns:

  • (String) 


2523
2524
2525
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2523

def language_code
  @language_code
end

#suggestion ⇒ String

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

Returns:

  • (String) 


2528
2529
2530
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2528

def suggestion
  @suggestion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2535
2536
2537
2538
2539
2540
2541
2542
2543
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2535

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