Class: Google::Cloud::Retail::V2::ServingConfig
- Inherits:
-
Object
- Object
- Google::Cloud::Retail::V2::ServingConfig
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/retail/v2/serving_config.rb
Overview
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
Defined Under Namespace
Modules: DiversityType
Instance Attribute Summary collapse
-
#boost_control_ids ⇒ ::Array<::String>
Condition boost specifications.
-
#display_name ⇒ ::String
Required.
-
#diversity_level ⇒ ::String
How much diversity to use in recommendation model results e.g.
-
#diversity_type ⇒ ::Google::Cloud::Retail::V2::ServingConfig::DiversityType
What kind of diversity to use - data driven or rule based.
-
#do_not_associate_control_ids ⇒ ::Array<::String>
Condition do not associate specifications.
-
#dynamic_facet_spec ⇒ ::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec
The specification for dynamically generated facets.
-
#enable_category_filter_level ⇒ ::String
Whether to add additional category filters on the
similar-items
model. -
#facet_control_ids ⇒ ::Array<::String>
Facet specifications for faceted search.
-
#filter_control_ids ⇒ ::Array<::String>
Condition filter specifications.
-
#ignore_control_ids ⇒ ::Array<::String>
Condition ignore specifications.
-
#ignore_recs_denylist ⇒ ::Boolean
When the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results.
-
#model_id ⇒ ::String
The id of the model in the same Catalog to use at serving time.
-
#name ⇒ ::String
Immutable.
-
#oneway_synonyms_control_ids ⇒ ::Array<::String>
Condition oneway synonyms specifications.
-
#personalization_spec ⇒ ::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec
The specification for personalization spec.
-
#price_reranking_level ⇒ ::String
How much price ranking we want in serving results.
-
#redirect_control_ids ⇒ ::Array<::String>
Condition redirect specifications.
-
#replacement_control_ids ⇒ ::Array<::String>
Condition replacement specifications.
-
#solution_types ⇒ ::Array<::Google::Cloud::Retail::V2::SolutionType>
Required.
-
#twoway_synonyms_control_ids ⇒ ::Array<::String>
Condition synonyms specifications.
Instance Attribute Details
#boost_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#display_name ⇒ ::String
Returns 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.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#diversity_level ⇒ ::String
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#diversity_type ⇒ ::Google::Cloud::Retail::V2::ServingConfig::DiversityType
Returns What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#do_not_associate_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#dynamic_facet_spec ⇒ ::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#enable_category_filter_level ⇒ ::String
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#facet_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#filter_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#ignore_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#ignore_recs_denylist ⇒ ::Boolean
Returns When the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#model_id ⇒ ::String
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#name ⇒ ::String
Returns Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/servingConfig/*
.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#oneway_synonyms_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#personalization_spec ⇒ ::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec
Returns The specification for personalization spec.
Can only be set if solution_types is [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#price_reranking_level ⇒ ::String
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#redirect_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#replacement_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#solution_types ⇒ ::Array<::Google::Cloud::Retail::V2::SolutionType>
Returns Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |
#twoway_synonyms_control_ids ⇒ ::Array<::String>
Returns 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][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'proto_docs/google/cloud/retail/v2/serving_config.rb', line 240 class ServingConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # What type of diversity - data or rule based. module DiversityType # Default value. DIVERSITY_TYPE_UNSPECIFIED = 0 # Rule based diversity. RULE_BASED_DIVERSITY = 2 # Data driven diversity. DATA_DRIVEN_DIVERSITY = 3 end end |