Generated from protobuf messagegoogle.cloud.discoveryengine.v1.CompleteQueryRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__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 asprojects/*/locations/global/collections/default_collection/dataStores/default_data_store.
↳ 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: * *document- Using suggestions generated from user-imported documents. * *search-history- Using suggestions generated from the past history ofSearchService.SearchAPI 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.
↳ 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 asunknown_visitor. This should be the same identifier asUserEvent.user_pseudo_idandSearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, anINVALID_ARGUMENTerror is returned.
↳ 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 asprojects/*/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 asprojects/*/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 ofSearchService.SearchAPI 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 ofSearchService.SearchAPI 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 asunknown_visitor.
This should be the same identifier asUserEvent.user_pseudo_idandSearchRequest.user_pseudo_id.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, anINVALID_ARGUMENTerror 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 asunknown_visitor.
This should be the same identifier asUserEvent.user_pseudo_idandSearchRequest.user_pseudo_id.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, anINVALID_ARGUMENTerror 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.
[[["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,["# Google Cloud Discovery Engine V1 Client - Class CompleteQueryRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.CompleteQueryRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.CompleteQueryRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.CompleteQueryRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.CompleteQueryRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.CompleteQueryRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.CompleteQueryRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.CompleteQueryRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.CompleteQueryRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.CompleteQueryRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.CompleteQueryRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.CompleteQueryRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.CompleteQueryRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.CompleteQueryRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.CompleteQueryRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.CompleteQueryRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.CompleteQueryRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.CompleteQueryRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CompleteQueryRequest.\n\nRequest message for\n[CompletionService.CompleteQuery](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.CompletionServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_CompletionServiceClient__completeQuery__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.CompleteQueryRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDataStore\n\nRequired. The parent data store resource name for which the completion is\nperformed, such as\n`projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.\n\n### setDataStore\n\nRequired. The parent data store resource name for which the completion is\nperformed, such as\n`projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.\n\n### getQuery\n\nRequired. The typeahead input used to fetch suggestions. Maximum length is\n128 characters.\n\n### setQuery\n\nRequired. The typeahead input used to fetch suggestions. Maximum length is\n128 characters.\n\n### getQueryModel\n\nSpecifies the autocomplete data model. This overrides any model specified\nin the Configuration \\\u003e Autocomplete section of the Cloud console. Currently\nsupported values:\n\n- `document` - Using suggestions generated from user-imported documents.\n\n- `search-history` - Using suggestions generated from the past history of\n [SearchService.Search](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.SearchServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_SearchServiceClient__search__)\n API calls. Do not use it when there is no traffic for Search API.\n\n- `user-event` - Using suggestions generated from user-imported search events.\n- `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:\n- `document` is the default model for regular dataStores.\n- `search-history` is the default model for site search dataStores.\n\n### setQueryModel\n\nSpecifies the autocomplete data model. This overrides any model specified\nin the Configuration \\\u003e Autocomplete section of the Cloud console. Currently\nsupported values:\n\n- `document` - Using suggestions generated from user-imported documents.\n\n- `search-history` - Using suggestions generated from the past history of\n [SearchService.Search](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.SearchServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_SearchServiceClient__search__)\n API calls. Do not use it when there is no traffic for Search API.\n\n- `user-event` - Using suggestions generated from user-imported search events.\n- `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values:\n- `document` is the default model for regular dataStores.\n- `search-history` is the default model for site search dataStores.\n\n### getUserPseudoId\n\nA unique identifier for tracking visitors. For example, this could be\nimplemented with an HTTP cookie, which should be able to uniquely identify\na visitor on a single device. This unique identifier should not change if\nthe visitor logs in or out of the website.\n\nThis field should NOT have a fixed value such as `unknown_visitor`.\nThis should be the same identifier as\n[UserEvent.user_pseudo_id](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getUserPseudoId__)\nand\n[SearchRequest.user_pseudo_id](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchRequest#_Google_Cloud_DiscoveryEngine_V1_SearchRequest__getUserPseudoId__).\nThe field must be a UTF-8 encoded string with a length limit of 128\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\n\n### setUserPseudoId\n\nA unique identifier for tracking visitors. For example, this could be\nimplemented with an HTTP cookie, which should be able to uniquely identify\na visitor on a single device. This unique identifier should not change if\nthe visitor logs in or out of the website.\n\nThis field should NOT have a fixed value such as `unknown_visitor`.\nThis should be the same identifier as\n[UserEvent.user_pseudo_id](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getUserPseudoId__)\nand\n[SearchRequest.user_pseudo_id](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchRequest#_Google_Cloud_DiscoveryEngine_V1_SearchRequest__getUserPseudoId__).\nThe field must be a UTF-8 encoded string with a length limit of 128\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\n\n### getIncludeTailSuggestions\n\nIndicates if tail suggestions should be returned if there are no\nsuggestions that match the full query. Even if set to true, if there are\nsuggestions that match the full query, those are returned and no\ntail suggestions are returned.\n\n### setIncludeTailSuggestions\n\nIndicates if tail suggestions should be returned if there are no\nsuggestions that match the full query. Even if set to true, if there are\nsuggestions that match the full query, those are returned and no\ntail suggestions are returned."]]
