Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CompleteQueryRequest.
Request message for CompletionService.CompleteQuery method.
Generated from protobuf message google.cloud.discoveryengine.v1.CompleteQueryRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ data_store |
string
Required. The parent data store resource name for which the completion is performed, such as |
↳ query |
string
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. |
↳ query_model |
string
Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * |
↳ user_pseudo_id |
string
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 |
↳ include_tail_suggestions |
bool
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. |
getDataStore
Required. The parent data store resource name for which the completion is
performed, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataStore
Required. The parent data store resource name for which the completion is
performed, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryModel
Specifies the autocomplete data model. 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:documentis the default model for regular dataStores.search-historyis the default model for site search dataStores.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQueryModel
Specifies the autocomplete data model. 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:documentis the default model for regular dataStores.search-historyis the default model for site search dataStores.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserPseudoId
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
characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUserPseudoId
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
characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 |
|