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

Class GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest

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.GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request message for CompletionService.AdvancedCompleteQuery method. .

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	clone()
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec	getBoostSpec() Optional.
List<String>	getExperimentIds() Optional.
Boolean	getIncludeTailSuggestions() Indicates if tail suggestions should be returned if there are no suggestions that match the full query.
String	getQuery() Required.
String	getQueryModel() Specifies the autocomplete query model, which only applies to the QUERY SuggestionType.
List<String>	getSuggestionTypes() Optional.
List<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec>	getSuggestionTypeSpecs() Optional.
GoogleCloudDiscoveryengineV1UserInfo	getUserInfo() Optional.
String	getUserPseudoId() Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setBoostSpec(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec boostSpec) Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setExperimentIds(List<String> experimentIds) Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setIncludeTailSuggestions(Boolean includeTailSuggestions) Indicates if tail suggestions should be returned if there are no suggestions that match the full query.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setQuery(String query) Required.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setQueryModel(String queryModel) Specifies the autocomplete query model, which only applies to the QUERY SuggestionType.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setSuggestionTypes(List<String> suggestionTypes) Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setSuggestionTypeSpecs(List<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec> suggestionTypeSpecs) Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setUserInfo(GoogleCloudDiscoveryengineV1UserInfo userInfo) Optional.
GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest	setUserPseudoId(String userPseudoId) Optional.

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

GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest()

Method Detail

getBoostSpec

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec getBoostSpec()

Optional. Specification to boost suggestions matching the condition.

Returns:

value or null for none

setBoostSpec

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setBoostSpec(GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec boostSpec)

Optional. Specification to boost suggestions matching the condition.

Parameters:

boostSpec - boostSpec or null for none

getExperimentIds

public List<String> getExperimentIds()

Optional. Experiment ids for this request.

Returns:

value or null for none

setExperimentIds

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setExperimentIds(List<String> experimentIds)

Optional. Experiment ids for this request.

Parameters:

experimentIds - experimentIds or null for none

getIncludeTailSuggestions

public Boolean getIncludeTailSuggestions()

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

Returns:

value or null for none

setIncludeTailSuggestions

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setIncludeTailSuggestions(Boolean includeTailSuggestions)

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

Parameters:

includeTailSuggestions - includeTailSuggestions or null for none

getQuery

public String getQuery()

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.

Returns:

value or null for none

setQuery

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setQuery(String query)

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.

Parameters:

query - query or null for none

getQueryModel

public String getQueryModel()

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user- event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.

Returns:

value or null for none

setQueryModel

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setQueryModel(String queryModel)

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user- event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.

Parameters:

queryModel - queryModel or null for none

getSuggestionTypeSpecs

public List<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec> getSuggestionTypeSpecs()

Optional. Specification of each suggestion type.

Returns:

value or null for none

setSuggestionTypeSpecs

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setSuggestionTypeSpecs(List<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec> suggestionTypeSpecs)

Optional. Specification of each suggestion type.

Parameters:

suggestionTypeSpecs - suggestionTypeSpecs or null for none

getSuggestionTypes

public List<String> getSuggestionTypes()

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

Returns:

value or null for none

setSuggestionTypes

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setSuggestionTypes(List<String> suggestionTypes)

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

Parameters:

suggestionTypes - suggestionTypes or null for none

getUserInfo

public GoogleCloudDiscoveryengineV1UserInfo getUserInfo()

Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

Returns:

value or null for none

setUserInfo

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setUserInfo(GoogleCloudDiscoveryengineV1UserInfo userInfo)

Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

Parameters:

userInfo - userInfo or null for none

getUserPseudoId

public String getUserPseudoId()

Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128

Returns:

value or null for none

setUserPseudoId

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest setUserPseudoId(String userPseudoId)

Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128

Parameters:

userPseudoId - userPseudoId or null for none

set

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest set(String fieldName,
                                                                    Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest clone()

Overrides:

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