ServingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
Attributes | |
|---|---|
| Name | Description |
name |
str
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
|
display_name |
str
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. |
model_id |
str
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. |
price_reranking_level |
str
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-raranking
- 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.
|
facet_control_ids |
MutableSequence[str]
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. |
dynamic_facet_spec |
google.cloud.retail_v2alpha.types.SearchRequest.DynamicFacetSpec
The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
boost_control_ids |
MutableSequence[str]
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. |
filter_control_ids |
MutableSequence[str]
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. |
redirect_control_ids |
MutableSequence[str]
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. |
twoway_synonyms_control_ids |
MutableSequence[str]
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. |
oneway_synonyms_control_ids |
MutableSequence[str]
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. |
do_not_associate_control_ids |
MutableSequence[str]
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. |
replacement_control_ids |
MutableSequence[str]
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. |
ignore_control_ids |
MutableSequence[str]
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. |
diversity_level |
str
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.
|
diversity_type |
google.cloud.retail_v2alpha.types.ServingConfig.DiversityType
What kind of diversity to use - data driven or rule based. |
enable_category_filter_level |
str
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.
|
personalization_spec |
google.cloud.retail_v2alpha.types.SearchRequest.PersonalizationSpec
The specification for personalization spec. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec. |
solution_types |
MutableSequence[google.cloud.retail_v2alpha.types.SolutionType]
Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution. |
Classes
DiversityType
DiversityType(value)What type of diversity - data or rule based. If none is specified, default to rule based.