Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. retail
  5. retail/v2
  6. ServingConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.retail/v2.ServingConfig

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. Auto-naming is currently not supported for this resource.

    Create ServingConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServingConfig(name: string, args: ServingConfigArgs, opts?: CustomResourceOptions);
    @overload
def ServingConfig(resource_name: str,
                  args: ServingConfigArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ServingConfig(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  serving_config_id: Optional[str] = None,
                  catalog_id: Optional[str] = None,
                  display_name: Optional[str] = None,
                  solution_types: Optional[Sequence[ServingConfigSolutionTypesItem]] = None,
                  ignore_control_ids: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  dynamic_facet_spec: Optional[GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs] = None,
                  enable_category_filter_level: Optional[str] = None,
                  facet_control_ids: Optional[Sequence[str]] = None,
                  filter_control_ids: Optional[Sequence[str]] = None,
                  boost_control_ids: Optional[Sequence[str]] = None,
                  location: Optional[str] = None,
                  model_id: Optional[str] = None,
                  do_not_associate_control_ids: Optional[Sequence[str]] = None,
                  oneway_synonyms_control_ids: Optional[Sequence[str]] = None,
                  personalization_spec: Optional[GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs] = None,
                  price_reranking_level: Optional[str] = None,
                  project: Optional[str] = None,
                  redirect_control_ids: Optional[Sequence[str]] = None,
                  replacement_control_ids: Optional[Sequence[str]] = None,
                  diversity_type: Optional[ServingConfigDiversityType] = None,
                  diversity_level: Optional[str] = None,
                  twoway_synonyms_control_ids: Optional[Sequence[str]] = None)
    func NewServingConfig(ctx *Context, name string, args ServingConfigArgs, opts ...ResourceOption) (*ServingConfig, error)
    public ServingConfig(string name, ServingConfigArgs args, CustomResourceOptions? opts = null)
    public ServingConfig(String name, ServingConfigArgs args)
public ServingConfig(String name, ServingConfigArgs args, CustomResourceOptions options)

    type: google-native:retail/v2:ServingConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServingConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServingConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServingConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServingConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServingConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var servingConfigResource = new GoogleNative.Retail.V2.ServingConfig("servingConfigResource", new()
{
    ServingConfigId = "string",
    CatalogId = "string",
    DisplayName = "string",
    SolutionTypes = new[]
    {
        GoogleNative.Retail.V2.ServingConfigSolutionTypesItem.SolutionTypeUnspecified,
    },
    IgnoreControlIds = new[]
    {
        "string",
    },
    Name = "string",
    DynamicFacetSpec = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs
    {
        Mode = GoogleNative.Retail.V2.GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode.ModeUnspecified,
    },
    EnableCategoryFilterLevel = "string",
    FacetControlIds = new[]
    {
        "string",
    },
    FilterControlIds = new[]
    {
        "string",
    },
    BoostControlIds = new[]
    {
        "string",
    },
    Location = "string",
    ModelId = "string",
    DoNotAssociateControlIds = new[]
    {
        "string",
    },
    OnewaySynonymsControlIds = new[]
    {
        "string",
    },
    PersonalizationSpec = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs
    {
        Mode = GoogleNative.Retail.V2.GoogleCloudRetailV2SearchRequestPersonalizationSpecMode.ModeUnspecified,
    },
    PriceRerankingLevel = "string",
    Project = "string",
    RedirectControlIds = new[]
    {
        "string",
    },
    ReplacementControlIds = new[]
    {
        "string",
    },
    DiversityType = GoogleNative.Retail.V2.ServingConfigDiversityType.DiversityTypeUnspecified,
    DiversityLevel = "string",
    TwowaySynonymsControlIds = new[]
    {
        "string",
    },
});

    example, err := retail.NewServingConfig(ctx, "servingConfigResource", &retail.ServingConfigArgs{
	ServingConfigId: pulumi.String("string"),
	CatalogId:       pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	SolutionTypes: retail.ServingConfigSolutionTypesItemArray{
		retail.ServingConfigSolutionTypesItemSolutionTypeUnspecified,
	},
	IgnoreControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	DynamicFacetSpec: &retail.GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs{
		Mode: retail.GoogleCloudRetailV2SearchRequestDynamicFacetSpecModeModeUnspecified,
	},
	EnableCategoryFilterLevel: pulumi.String("string"),
	FacetControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	FilterControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoostControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	ModelId:  pulumi.String("string"),
	DoNotAssociateControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	OnewaySynonymsControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PersonalizationSpec: &retail.GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs{
		Mode: retail.GoogleCloudRetailV2SearchRequestPersonalizationSpecModeModeUnspecified,
	},
	PriceRerankingLevel: pulumi.String("string"),
	Project:             pulumi.String("string"),
	RedirectControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReplacementControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DiversityType:  retail.ServingConfigDiversityTypeDiversityTypeUnspecified,
	DiversityLevel: pulumi.String("string"),
	TwowaySynonymsControlIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var servingConfigResource = new ServingConfig("servingConfigResource", ServingConfigArgs.builder()
    .servingConfigId("string")
    .catalogId("string")
    .displayName("string")
    .solutionTypes("SOLUTION_TYPE_UNSPECIFIED")
    .ignoreControlIds("string")
    .name("string")
    .dynamicFacetSpec(GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs.builder()
        .mode("MODE_UNSPECIFIED")
        .build())
    .enableCategoryFilterLevel("string")
    .facetControlIds("string")
    .filterControlIds("string")
    .boostControlIds("string")
    .location("string")
    .modelId("string")
    .doNotAssociateControlIds("string")
    .onewaySynonymsControlIds("string")
    .personalizationSpec(GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs.builder()
        .mode("MODE_UNSPECIFIED")
        .build())
    .priceRerankingLevel("string")
    .project("string")
    .redirectControlIds("string")
    .replacementControlIds("string")
    .diversityType("DIVERSITY_TYPE_UNSPECIFIED")
    .diversityLevel("string")
    .twowaySynonymsControlIds("string")
    .build());

    serving_config_resource = google_native.retail.v2.ServingConfig("servingConfigResource",
    serving_config_id="string",
    catalog_id="string",
    display_name="string",
    solution_types=[google_native.retail.v2.ServingConfigSolutionTypesItem.SOLUTION_TYPE_UNSPECIFIED],
    ignore_control_ids=["string"],
    name="string",
    dynamic_facet_spec={
        "mode": google_native.retail.v2.GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode.MODE_UNSPECIFIED,
    },
    enable_category_filter_level="string",
    facet_control_ids=["string"],
    filter_control_ids=["string"],
    boost_control_ids=["string"],
    location="string",
    model_id="string",
    do_not_associate_control_ids=["string"],
    oneway_synonyms_control_ids=["string"],
    personalization_spec={
        "mode": google_native.retail.v2.GoogleCloudRetailV2SearchRequestPersonalizationSpecMode.MODE_UNSPECIFIED,
    },
    price_reranking_level="string",
    project="string",
    redirect_control_ids=["string"],
    replacement_control_ids=["string"],
    diversity_type=google_native.retail.v2.ServingConfigDiversityType.DIVERSITY_TYPE_UNSPECIFIED,
    diversity_level="string",
    twoway_synonyms_control_ids=["string"])

    const servingConfigResource = new google_native.retail.v2.ServingConfig("servingConfigResource", {
    servingConfigId: "string",
    catalogId: "string",
    displayName: "string",
    solutionTypes: [google_native.retail.v2.ServingConfigSolutionTypesItem.SolutionTypeUnspecified],
    ignoreControlIds: ["string"],
    name: "string",
    dynamicFacetSpec: {
        mode: google_native.retail.v2.GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode.ModeUnspecified,
    },
    enableCategoryFilterLevel: "string",
    facetControlIds: ["string"],
    filterControlIds: ["string"],
    boostControlIds: ["string"],
    location: "string",
    modelId: "string",
    doNotAssociateControlIds: ["string"],
    onewaySynonymsControlIds: ["string"],
    personalizationSpec: {
        mode: google_native.retail.v2.GoogleCloudRetailV2SearchRequestPersonalizationSpecMode.ModeUnspecified,
    },
    priceRerankingLevel: "string",
    project: "string",
    redirectControlIds: ["string"],
    replacementControlIds: ["string"],
    diversityType: google_native.retail.v2.ServingConfigDiversityType.DiversityTypeUnspecified,
    diversityLevel: "string",
    twowaySynonymsControlIds: ["string"],
});

    type: google-native:retail/v2:ServingConfig
properties:
    boostControlIds:
        - string
    catalogId: string
    displayName: string
    diversityLevel: string
    diversityType: DIVERSITY_TYPE_UNSPECIFIED
    doNotAssociateControlIds:
        - string
    dynamicFacetSpec:
        mode: MODE_UNSPECIFIED
    enableCategoryFilterLevel: string
    facetControlIds:
        - string
    filterControlIds:
        - string
    ignoreControlIds:
        - string
    location: string
    modelId: string
    name: string
    onewaySynonymsControlIds:
        - string
    personalizationSpec:
        mode: MODE_UNSPECIFIED
    priceRerankingLevel: string
    project: string
    redirectControlIds:
        - string
    replacementControlIds:
        - string
    servingConfigId: string
    solutionTypes:
        - SOLUTION_TYPE_UNSPECIFIED
    twowaySynonymsControlIds:
        - string

    ServingConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ServingConfig resource accepts the following input properties:

    CatalogId string
    DisplayName string
    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.
    ServingConfigId string
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    SolutionTypes List<Pulumi.GoogleNative.Retail.V2.ServingConfigSolutionTypesItem>
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    BoostControlIds List<string>
    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.
    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 Pulumi.GoogleNative.Retail.V2.ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    DoNotAssociateControlIds List<string>
    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 Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2SearchRequestDynamicFacetSpec
    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.
    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 List<string>
    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 List<string>
    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 List<string>
    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.
    Location string
    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.
    Name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    OnewaySynonymsControlIds List<string>
    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 Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2SearchRequestPersonalizationSpec
    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.
    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.
    Project string
    RedirectControlIds List<string>
    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 List<string>
    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.
    TwowaySynonymsControlIds List<string>
    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.
    CatalogId string
    DisplayName string
    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.
    ServingConfigId string
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    SolutionTypes []ServingConfigSolutionTypesItem
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    BoostControlIds []string
    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.
    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 ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    DoNotAssociateControlIds []string
    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 GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs
    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.
    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 []string
    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 []string
    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 []string
    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.
    Location string
    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.
    Name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    OnewaySynonymsControlIds []string
    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 GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs
    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.
    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.
    Project string
    RedirectControlIds []string
    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 []string
    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.
    TwowaySynonymsControlIds []string
    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.
    catalogId String
    displayName String
    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.
    servingConfigId String
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    solutionTypes List<ServingConfigSolutionTypesItem>
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    boostControlIds List<String>
    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.
    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 ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    doNotAssociateControlIds List<String>
    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 GoogleCloudRetailV2SearchRequestDynamicFacetSpec
    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.
    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 List<String>
    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 List<String>
    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 List<String>
    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.
    location String
    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.
    name String
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    onewaySynonymsControlIds List<String>
    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 GoogleCloudRetailV2SearchRequestPersonalizationSpec
    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.
    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.
    project String
    redirectControlIds List<String>
    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 List<String>
    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.
    twowaySynonymsControlIds List<String>
    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.
    catalogId string
    displayName string
    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.
    servingConfigId string
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    solutionTypes ServingConfigSolutionTypesItem[]
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    boostControlIds string[]
    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.
    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 ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    doNotAssociateControlIds string[]
    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 GoogleCloudRetailV2SearchRequestDynamicFacetSpec
    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.
    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 string[]
    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 string[]
    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 string[]
    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.
    location string
    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.
    name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    onewaySynonymsControlIds string[]
    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 GoogleCloudRetailV2SearchRequestPersonalizationSpec
    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.
    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.
    project string
    redirectControlIds string[]
    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 string[]
    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.
    twowaySynonymsControlIds string[]
    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.
    catalog_id str
    display_name str
    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.
    serving_config_id str
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    solution_types Sequence[ServingConfigSolutionTypesItem]
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    boost_control_ids Sequence[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.
    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 ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    do_not_associate_control_ids Sequence[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.
    dynamic_facet_spec GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs
    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.
    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.
    facet_control_ids Sequence[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.
    filter_control_ids Sequence[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.
    ignore_control_ids Sequence[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.
    location str
    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.
    name str
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    oneway_synonyms_control_ids Sequence[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.
    personalization_spec GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs
    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.
    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-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.
    project str
    redirect_control_ids Sequence[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.
    replacement_control_ids Sequence[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.
    twoway_synonyms_control_ids Sequence[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.
    catalogId String
    displayName String
    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.
    servingConfigId String
    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
    solutionTypes List<"SOLUTION_TYPE_UNSPECIFIED" | "SOLUTION_TYPE_RECOMMENDATION" | "SOLUTION_TYPE_SEARCH">
    Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.
    boostControlIds List<String>
    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.
    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 "DIVERSITY_TYPE_UNSPECIFIED" | "RULE_BASED_DIVERSITY" | "DATA_DRIVEN_DIVERSITY"
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    doNotAssociateControlIds List<String>
    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 Property Map
    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.
    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 List<String>
    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 List<String>
    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 List<String>
    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.
    location String
    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.
    name String
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*
    onewaySynonymsControlIds List<String>
    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 Property Map
    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.
    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.
    project String
    redirectControlIds List<String>
    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 List<String>
    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.
    twowaySynonymsControlIds List<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServingConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GoogleCloudRetailV2SearchRequestDynamicFacetSpec, GoogleCloudRetailV2SearchRequestDynamicFacetSpecArgs

    Mode Pulumi.GoogleNative.Retail.V2.GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    Mode GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode "MODE_UNSPECIFIED" | "DISABLED" | "ENABLED"
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.

    GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode, GoogleCloudRetailV2SearchRequestDynamicFacetSpecModeArgs

    ModeUnspecified
    MODE_UNSPECIFIEDDefault value.
    Disabled
    DISABLEDDisable Dynamic Facet.
    Enabled
    ENABLEDAutomatic mode built by Google Retail Search.
    GoogleCloudRetailV2SearchRequestDynamicFacetSpecModeModeUnspecified
    MODE_UNSPECIFIEDDefault value.
    GoogleCloudRetailV2SearchRequestDynamicFacetSpecModeDisabled
    DISABLEDDisable Dynamic Facet.
    GoogleCloudRetailV2SearchRequestDynamicFacetSpecModeEnabled
    ENABLEDAutomatic mode built by Google Retail Search.
    ModeUnspecified
    MODE_UNSPECIFIEDDefault value.
    Disabled
    DISABLEDDisable Dynamic Facet.
    Enabled
    ENABLEDAutomatic mode built by Google Retail Search.
    ModeUnspecified
    MODE_UNSPECIFIEDDefault value.
    Disabled
    DISABLEDDisable Dynamic Facet.
    Enabled
    ENABLEDAutomatic mode built by Google Retail Search.
    MODE_UNSPECIFIED
    MODE_UNSPECIFIEDDefault value.
    DISABLED
    DISABLEDDisable Dynamic Facet.
    ENABLED
    ENABLEDAutomatic mode built by Google Retail Search.
    "MODE_UNSPECIFIED"
    MODE_UNSPECIFIEDDefault value.
    "DISABLED"
    DISABLEDDisable Dynamic Facet.
    "ENABLED"
    ENABLEDAutomatic mode built by Google Retail Search.

    GoogleCloudRetailV2SearchRequestDynamicFacetSpecResponse, GoogleCloudRetailV2SearchRequestDynamicFacetSpecResponseArgs

    Mode string
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    Mode string
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode String
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode string
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode str
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    mode String
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.

    GoogleCloudRetailV2SearchRequestPersonalizationSpec, GoogleCloudRetailV2SearchRequestPersonalizationSpecArgs

    GoogleCloudRetailV2SearchRequestPersonalizationSpecMode, GoogleCloudRetailV2SearchRequestPersonalizationSpecModeArgs

    ModeUnspecified
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    Auto
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    Disabled
    DISABLEDDisable personalization.
    GoogleCloudRetailV2SearchRequestPersonalizationSpecModeModeUnspecified
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    GoogleCloudRetailV2SearchRequestPersonalizationSpecModeAuto
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    GoogleCloudRetailV2SearchRequestPersonalizationSpecModeDisabled
    DISABLEDDisable personalization.
    ModeUnspecified
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    Auto
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    Disabled
    DISABLEDDisable personalization.
    ModeUnspecified
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    Auto
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    Disabled
    DISABLEDDisable personalization.
    MODE_UNSPECIFIED
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    AUTO
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    DISABLED
    DISABLEDDisable personalization.
    "MODE_UNSPECIFIED"
    MODE_UNSPECIFIEDDefault value. In this case, server behavior defaults to Mode.AUTO.
    "AUTO"
    AUTOLet CRS decide whether to use personalization based on quality of user event data.
    "DISABLED"
    DISABLEDDisable personalization.

    GoogleCloudRetailV2SearchRequestPersonalizationSpecResponse, GoogleCloudRetailV2SearchRequestPersonalizationSpecResponseArgs

    Mode string
    Defaults to Mode.AUTO.
    Mode string
    Defaults to Mode.AUTO.
    mode String
    Defaults to Mode.AUTO.
    mode string
    Defaults to Mode.AUTO.
    mode str
    Defaults to Mode.AUTO.
    mode String
    Defaults to Mode.AUTO.

    ServingConfigDiversityType, ServingConfigDiversityTypeArgs

    DiversityTypeUnspecified
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    RuleBasedDiversity
    RULE_BASED_DIVERSITYRule based diversity.
    DataDrivenDiversity
    DATA_DRIVEN_DIVERSITYData driven diversity.
    ServingConfigDiversityTypeDiversityTypeUnspecified
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    ServingConfigDiversityTypeRuleBasedDiversity
    RULE_BASED_DIVERSITYRule based diversity.
    ServingConfigDiversityTypeDataDrivenDiversity
    DATA_DRIVEN_DIVERSITYData driven diversity.
    DiversityTypeUnspecified
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    RuleBasedDiversity
    RULE_BASED_DIVERSITYRule based diversity.
    DataDrivenDiversity
    DATA_DRIVEN_DIVERSITYData driven diversity.
    DiversityTypeUnspecified
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    RuleBasedDiversity
    RULE_BASED_DIVERSITYRule based diversity.
    DataDrivenDiversity
    DATA_DRIVEN_DIVERSITYData driven diversity.
    DIVERSITY_TYPE_UNSPECIFIED
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    RULE_BASED_DIVERSITY
    RULE_BASED_DIVERSITYRule based diversity.
    DATA_DRIVEN_DIVERSITY
    DATA_DRIVEN_DIVERSITYData driven diversity.
    "DIVERSITY_TYPE_UNSPECIFIED"
    DIVERSITY_TYPE_UNSPECIFIEDDefault value.
    "RULE_BASED_DIVERSITY"
    RULE_BASED_DIVERSITYRule based diversity.
    "DATA_DRIVEN_DIVERSITY"
    DATA_DRIVEN_DIVERSITYData driven diversity.

    ServingConfigSolutionTypesItem, ServingConfigSolutionTypesItemArgs

    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Retail Search.
    ServingConfigSolutionTypesItemSolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    ServingConfigSolutionTypesItemSolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    ServingConfigSolutionTypesItemSolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Retail Search.
    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Retail Search.
    SolutionTypeUnspecified
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SolutionTypeRecommendation
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SolutionTypeSearch
    SOLUTION_TYPE_SEARCHUsed for Retail Search.
    SOLUTION_TYPE_UNSPECIFIED
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    SOLUTION_TYPE_RECOMMENDATION
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    SOLUTION_TYPE_SEARCH
    SOLUTION_TYPE_SEARCHUsed for Retail Search.
    "SOLUTION_TYPE_UNSPECIFIED"
    SOLUTION_TYPE_UNSPECIFIEDDefault value.
    "SOLUTION_TYPE_RECOMMENDATION"
    SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
    "SOLUTION_TYPE_SEARCH"
    SOLUTION_TYPE_SEARCHUsed for Retail Search.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native