Google Cloud Discovery Engine V1 Client - Class AdvancedCompleteQueryRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AdvancedCompleteQueryRequest.

Request message for CompletionService.AdvancedCompleteQuery method.

.

Generated from protobuf message google.cloud.discoveryengine.v1.AdvancedCompleteQueryRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getCompletionConfig

Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Returns
Type Description
string

setCompletionConfig

Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
string

setQuery

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
string

setQueryModel

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.
Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
string

setUserPseudoId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getUserInfo

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

Returns
Type Description
UserInfo|null

hasUserInfo

clearUserInfo

setUserInfo

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

Parameter
Name Description
var UserInfo
Returns
Type Description
$this

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
Type Description
bool

setIncludeTailSuggestions

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getBoostSpec

Optional. Specification to boost suggestions matching the condition.

Returns
Type Description
AdvancedCompleteQueryRequest\BoostSpec|null

hasBoostSpec

clearBoostSpec

setBoostSpec

Optional. Specification to boost suggestions matching the condition.

Parameter
Name Description
var AdvancedCompleteQueryRequest\BoostSpec
Returns
Type Description
$this

getSuggestionTypes

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

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setSuggestionTypes

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

Parameter
Name Description
var int[]
Returns
Type Description
$this

getSuggestionTypeSpecs

Optional. Specification of each suggestion type.

Returns
Type Description
Google\Protobuf\RepeatedField<AdvancedCompleteQueryRequest\SuggestionTypeSpec>

setSuggestionTypeSpecs

Optional. Specification of each suggestion type.

Parameter
Name Description
var array<AdvancedCompleteQueryRequest\SuggestionTypeSpec>
Returns
Type Description
$this

getExperimentIds

Optional. Experiment ids for this request.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setExperimentIds

Optional. Experiment ids for this request.

Parameter
Name Description
var string[]
Returns
Type Description
$this