Required. Immutable. Fully qualified name projects/*/locations/*/dataStores/*/completionConfigprojects/*/locations/*/collections/*/dataStores/*/completionConfigprojects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder
string
The matching order for autocomplete suggestions, e.g., a query consisting of sh with out-of-order specified would suggest women's
shoes, whereas a query of red s with exact-prefix specified would suggest red shoes. Currently supported values:
out-of-order
exact-prefix
Default value: exact-prefix.
maxSuggestions
integer
The maximum number of autocomplete suggestions returned per term.
maxSuggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions.
minPrefixLength
integer
The minimum number of characters needed to be typed in order to get suggestions.
minPrefixLength must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character.
queryModel
string
The data model of query suggestions for serving.
Currently supported values:
automatic - autocomplete backend automatic selects or mixes suggestions from different models.
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.
If query model is empty, the serving applies the "automatic" model by default.
The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine.
EnableMode
Specifies the enable mode of autocomplete generation pipelines.
Enums
ENABLE_MODE_UNSPECIFIED
When AutoComplete enable mode unspecified, it defaults to AUTOMATIC mode.
AUTOMATIC
AutoComplete will be enabled when the data store meets criteria.
MANUAL
AutoComplete will be enabled regardless of UCS data requirements.
[[["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-02-28 UTC."],[[["This document outlines the configuration options for customizing the Autocomplete API response for both engines and data stores."],["The `matchingOrder` field determines how suggestions are ordered, supporting `out-of-order` or `exact-prefix` matching."],["`maxSuggestions` and `minPrefixLength` fields control the quantity of suggestions returned and the minimum input length for suggestions to appear respectively."],["The `queryModel` field specifies the data model for generating suggestions, with options like `automatic`, `document`, `search-history`, `user-event`, or `document-completable`."],["The `enableMode` field, applicable only to DataStores, specifies how autocomplete is enabled, either `AUTOMATIC` based on data store criteria or `MANUAL` regardless of data requirements."]]],[]]