catalogs_completion_config

Creates, updates, deletes, gets or lists a catalogs_completion_config resource.

Overview

Name	catalogs_completion_config
Type	Resource
Id	google.retail.catalogs_completion_config

Fields

Name	Datatype	Description
name	string	Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig
allowlistInputConfig	object	The input config source for completion data.
autoLearning	boolean	If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.
denylistInputConfig	object	The input config source for completion data.
lastAllowlistImportOperation	string	Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
lastDenylistImportOperation	string	Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
lastSuggestionsImportOperation	string	Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
matchingOrder	string	Specifies 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. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
minPrefixLength	integer	The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
suggestionsInputConfig	object	The input config source for completion data.

Methods

Name	Accessible by	Required Params	Description
projects_locations_catalogs_get_completion_config	SELECT	catalogsId, locationsId, projectsId	Gets a CompletionConfig.
projects_locations_catalogs_update_completion_config	UPDATE	catalogsId, locationsId, projectsId	Updates the CompletionConfigs.

SELECT examples

Gets a CompletionConfig.

SELECT
name,
allowlistInputConfig,
autoLearning,
denylistInputConfig,
lastAllowlistImportOperation,
lastDenylistImportOperation,
lastSuggestionsImportOperation,
matchingOrder,
maxSuggestions,
minPrefixLength,
suggestionsInputConfig
FROM google.retail.catalogs_completion_config
WHERE catalogsId = '{{ catalogsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

UPDATE example

Updates a catalogs_completion_config resource.

/*+ update */
UPDATE google.retail.catalogs_completion_config
SET 
name = '{{ name }}',
matchingOrder = '{{ matchingOrder }}',
maxSuggestions = '{{ maxSuggestions }}',
minPrefixLength = '{{ minPrefixLength }}',
autoLearning = true|false
WHERE 
catalogsId = '{{ catalogsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';