serving_configs

Overview

Name	serving_configs
Type	Resource
Id	google.retail.serving_configs

Fields

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
boostControlIds	array	Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100. Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
displayName	string	Required. The human readable serving config display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: no-diversity low-diversity medium-diversity high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.
diversityType	string	What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
doNotAssociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
dynamicFacetSpec	object	The specifications of dynamically generated facets.
enableCategoryFilterLevel	string	Whether to add additional category filters on the similar-items model. If not specified, we enable it by default. Allowed values are: no-category-match: No additional filtering of original results from the model and the customer's filters. relaxed-category-match: Only keep results with categories that match at least one item categories in the PredictRequests's context item. * If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match). Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.
facetControlIds	array	Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
filterControlIds	array	Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
modelId	string	The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when solution_types is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
personalizationSpec	object	The specification for personalization.
priceRerankingLevel	string	How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are: no-price-reranking low-price-reranking medium-price-reranking high-price-reranking If not specified, we choose default based on model type. Default value: no-price-reranking. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.
redirectControlIds	array	Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. - Applied according to the order in the list. - A previously replaced term can not be re-replaced. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.
solutionTypes	array	Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
twowaySynonymsControlIds	array	Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

Methods

Name	Accessible by	Required Params	Description
projects_locations_catalogs_serving_configs_get	SELECT	catalogsId, locationsId, projectsId, servingConfigsId	Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
projects_locations_catalogs_serving_configs_list	SELECT	catalogsId, locationsId, projectsId	Lists all ServingConfigs linked to this catalog.
projects_locations_catalogs_serving_configs_create	INSERT	catalogsId, locationsId, projectsId	Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
projects_locations_catalogs_serving_configs_delete	DELETE	catalogsId, locationsId, projectsId, servingConfigsId	Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
_projects_locations_catalogs_serving_configs_list	EXEC	catalogsId, locationsId, projectsId	Lists all ServingConfigs linked to this catalog.
projects_locations_catalogs_serving_configs_patch	EXEC	catalogsId, locationsId, projectsId, servingConfigsId	Updates a ServingConfig.
projects_locations_catalogs_serving_configs_predict	EXEC	catalogsId, locationsId, projectsId, servingConfigsId	Makes a recommendation prediction.
projects_locations_catalogs_serving_configs_search	EXEC	catalogsId, locationsId, projectsId, servingConfigsId	Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.