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
defalternative_phrases()->::Array<::String>
Returns
(::Array<::String>) — Alternative matching phrases for this suggestion.
#alternative_phrases=
defalternative_phrases=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Alternative matching phrases for this suggestion.
Returns
(::Array<::String>) — Alternative matching phrases for this suggestion.
#frequency
deffrequency()->::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=
deffrequency=(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
defglobal_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=
defglobal_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
defgroup_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=
defgroup_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
defgroup_score()->::Float
Returns
(::Float) — The score of this suggestion within its group.
#group_score=
defgroup_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
deflanguage_code()->::String
Returns
(::String) — BCP-47 language code of this suggestion.
#language_code=
deflanguage_code=(value)->::String
Parameter
value (::String) — BCP-47 language code of this suggestion.
Returns
(::String) — BCP-47 language code of this suggestion.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-CompletionSuggestion) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CompletionSuggestion.\n\nAutocomplete suggestions that are imported from Customer. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #alternative_phrases\n\n def alternative_phrases() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Alternative matching phrases for this suggestion.\n\n### #alternative_phrases=\n\n def alternative_phrases=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Alternative matching phrases for this suggestion. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Alternative matching phrases for this suggestion.\n\n### #frequency\n\n def frequency() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Frequency of this suggestion. Will be used to rank suggestions when score is not available.\n\n 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.\n\n### #frequency=\n\n def frequency=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Frequency of this suggestion. Will be used to rank suggestions when score is not available.\n\n\nNote: 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. \n**Returns**\n\n- (::Integer) --- Frequency of this suggestion. Will be used to rank suggestions when score is not available.\n\n 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.\n\n### #global_score\n\n def global_score() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Global score of this suggestion. Control how this suggestion would be scored / ranked.\n\n 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.\n\n### #global_score=\n\n def global_score=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- Global score of this suggestion. Control how this suggestion would be scored / ranked.\n\n\nNote: 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. \n**Returns**\n\n- (::Float) --- Global score of this suggestion. Control how this suggestion would be scored / ranked.\n\n 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.\n\n### #group_id\n\n def group_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #group_id=\n\n def group_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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.\n\n### #group_score\n\n def group_score() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- The score of this suggestion within its group.\n\n### #group_score=\n\n def group_score=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- The score of this suggestion within its group. \n**Returns**\n\n- (::Float) --- The score of this suggestion within its group.\n\n### #language_code\n\n def language_code() -\u003e ::String\n\n**Returns**\n\n- (::String) --- BCP-47 language code of this suggestion.\n\n### #language_code=\n\n def language_code=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- BCP-47 language code of this suggestion. \n**Returns**\n\n- (::String) --- BCP-47 language code of this suggestion.\n\n### #suggestion\n\n def suggestion() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The suggestion text.\n\n### #suggestion=\n\n def suggestion=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The suggestion text. \n**Returns**\n\n- (::String) --- Required. The suggestion text."]]
