Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion (v0.18.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion.

Autocomplete suggestions that are imported from Customer.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alternative_phrases

def alternative_phrases() -> ::Array<::String>
Returns
  • (::Array<::String>) — Alternative matching phrases for this suggestion.

#alternative_phrases=

def alternative_phrases=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Alternative matching phrases for this suggestion.
Returns
  • (::Array<::String>) — Alternative matching phrases for this suggestion.

#frequency

def frequency() -> ::Integer
Returns
  • (::Integer) — Frequency of this suggestion. Will be used to rank suggestions when score is not available.

    Note: The following fields are mutually exclusive: frequency, global_score. If a field in that set is populated, all other fields in the set will automatically be cleared.

#frequency=

def frequency=(value) -> ::Integer
Parameter
  • value (::Integer) — Frequency of this suggestion. Will be used to rank suggestions when score is not available.

    Note: The following fields are mutually exclusive: frequency, global_score. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — Frequency of this suggestion. Will be used to rank suggestions when score is not available.

    Note: The following fields are mutually exclusive: frequency, global_score. If a field in that set is populated, all other fields in the set will automatically be cleared.

#global_score

def global_score() -> ::Float
Returns
  • (::Float) — Global score of this suggestion. Control how this suggestion would be scored / ranked.

    Note: The following fields are mutually exclusive: global_score, frequency. If a field in that set is populated, all other fields in the set will automatically be cleared.

#global_score=

def global_score=(value) -> ::Float
Parameter
  • value (::Float) — Global score of this suggestion. Control how this suggestion would be scored / ranked.

    Note: The following fields are mutually exclusive: global_score, frequency. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Float) — Global score of this suggestion. Control how this suggestion would be scored / ranked.

    Note: The following fields are mutually exclusive: global_score, frequency. If a field in that set is populated, all other fields in the set will automatically be cleared.

#group_id

def group_id() -> ::String
Returns
  • (::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.

#group_id=

def group_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#group_score

def group_score() -> ::Float
Returns
  • (::Float) — The score of this suggestion within its group.

#group_score=

def group_score=(value) -> ::Float
Parameter
  • value (::Float) — The score of this suggestion within its group.
Returns
  • (::Float) — The score of this suggestion within its group.

#language_code

def language_code() -> ::String
Returns
  • (::String) — BCP-47 language code of this suggestion.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — BCP-47 language code of this suggestion.
Returns
  • (::String) — BCP-47 language code of this suggestion.

#suggestion

def suggestion() -> ::String
Returns
  • (::String) — Required. The suggestion text.

#suggestion=

def suggestion=(value) -> ::String
Parameter
  • value (::String) — Required. The suggestion text.
Returns
  • (::String) — Required. The suggestion text.