Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionSuggestion
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionSuggestion
- 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
-
#alternative_phrases ⇒ Array<String>
Alternative matching phrases for this suggestion.
-
#frequency ⇒ Fixnum
Frequency of this suggestion.
-
#global_score ⇒ Float
Global score of this suggestion.
-
#group_id ⇒ String
If two suggestions have the same groupId, they will not be returned together.
-
#group_score ⇒ Float
The score of this suggestion within its group.
-
#language_code ⇒ String
BCP-47 language code of this suggestion.
-
#suggestion ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CompletionSuggestion
constructor
A new instance of GoogleCloudDiscoveryengineV1CompletionSuggestion.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CompletionSuggestion
Returns a new instance of GoogleCloudDiscoveryengineV1CompletionSuggestion.
2624 2625 2626 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2624 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
2588 2589 2590 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2588 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
2594 2595 2596 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2594 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
2600 2601 2602 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2600 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
2607 2608 2609 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2607 def group_id @group_id end |
#group_score ⇒ Float
The score of this suggestion within its group.
Corresponds to the JSON property groupScore
2612 2613 2614 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2612 def group_score @group_score end |
#language_code ⇒ String
BCP-47 language code of this suggestion.
Corresponds to the JSON property languageCode
2617 2618 2619 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2617 def language_code @language_code end |
#suggestion ⇒ String
Required. The suggestion text.
Corresponds to the JSON property suggestion
2622 2623 2624 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2622 def suggestion @suggestion end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2629 2630 2631 2632 2633 2634 2635 2636 2637 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2629 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 |