com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1CompletionSuggestion

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1CompletionSuggestion

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1CompletionSuggestion
extends com.google.api.client.json.GenericJson

Autocomplete suggestions that are imported from Customer.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1CompletionSuggestion()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1CompletionSuggestion	clone()
List<String>	getAlternativePhrases() Alternative matching phrases for this suggestion.
Long	getFrequency() Frequency of this suggestion.
Double	getGlobalScore() Global score of this suggestion.
String	getGroupId() If two suggestions have the same groupId, they will not be returned together.
Double	getGroupScore() The score of this suggestion within its group.
String	getLanguageCode() BCP-47 language code of this suggestion.
String	getSuggestion() Required.
GoogleCloudDiscoveryengineV1CompletionSuggestion	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1CompletionSuggestion	setAlternativePhrases(List<String> alternativePhrases) Alternative matching phrases for this suggestion.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setFrequency(Long frequency) Frequency of this suggestion.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setGlobalScore(Double globalScore) Global score of this suggestion.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setGroupId(String groupId) If two suggestions have the same groupId, they will not be returned together.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setGroupScore(Double groupScore) The score of this suggestion within its group.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setLanguageCode(String languageCode) BCP-47 language code of this suggestion.
GoogleCloudDiscoveryengineV1CompletionSuggestion	setSuggestion(String suggestion) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1CompletionSuggestion

public GoogleCloudDiscoveryengineV1CompletionSuggestion()

Method Detail

getAlternativePhrases

public List<String> getAlternativePhrases()

Alternative matching phrases for this suggestion.

Returns:

value or null for none

setAlternativePhrases

public GoogleCloudDiscoveryengineV1CompletionSuggestion setAlternativePhrases(List<String> alternativePhrases)

Alternative matching phrases for this suggestion.

Parameters:

alternativePhrases - alternativePhrases or null for none

getFrequency

public Long getFrequency()

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

Returns:

value or null for none

setFrequency

public GoogleCloudDiscoveryengineV1CompletionSuggestion setFrequency(Long frequency)

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

Parameters:

frequency - frequency or null for none

getGlobalScore

public Double getGlobalScore()

Global score of this suggestion. Control how this suggestion would be scored / ranked.

Returns:

value or null for none

setGlobalScore

public GoogleCloudDiscoveryengineV1CompletionSuggestion setGlobalScore(Double globalScore)

Global score of this suggestion. Control how this suggestion would be scored / ranked.

Parameters:

globalScore - globalScore or null for none

getGroupId

public String getGroupId()

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:

value or null for none

setGroupId

public GoogleCloudDiscoveryengineV1CompletionSuggestion setGroupId(String groupId)

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.

Parameters:

groupId - groupId or null for none

getGroupScore

public Double getGroupScore()

The score of this suggestion within its group.

Returns:

value or null for none

setGroupScore

public GoogleCloudDiscoveryengineV1CompletionSuggestion setGroupScore(Double groupScore)

The score of this suggestion within its group.

Parameters:

groupScore - groupScore or null for none

getLanguageCode

public String getLanguageCode()

BCP-47 language code of this suggestion.

Returns:

value or null for none

setLanguageCode

public GoogleCloudDiscoveryengineV1CompletionSuggestion setLanguageCode(String languageCode)

BCP-47 language code of this suggestion.

Parameters:

languageCode - languageCode or null for none

getSuggestion

public String getSuggestion()

Required. The suggestion text.

Returns:

value or null for none

setSuggestion

public GoogleCloudDiscoveryengineV1CompletionSuggestion setSuggestion(String suggestion)

Required. The suggestion text.

Parameters:

suggestion - suggestion or null for none

set

public GoogleCloudDiscoveryengineV1CompletionSuggestion set(String fieldName,
                                                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1CompletionSuggestion clone()

Overrides:

clone in class com.google.api.client.json.GenericJson