Package com.google.cloud.retail.v2alpha

Interface ServingConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ServingConfig, ServingConfig.Builder
    public interface ServingConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/servingConfig/*`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/servingConfig/*`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         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.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         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.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for displayName.

      • getModelId

        String getModelId()
         The id of the model in the same
 [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string model_id = 3;
        Returns:
        The modelId.

      • getModelIdBytes

        com.google.protobuf.ByteString getModelIdBytes()
         The id of the model in the same
 [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string model_id = 3;
        Returns:
        The bytes for modelId.

      • getPriceRerankingLevel

        String getPriceRerankingLevel()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string price_reranking_level = 4;
        Returns:
        The priceRerankingLevel.

      • getPriceRerankingLevelBytes

        com.google.protobuf.ByteString getPriceRerankingLevelBytes()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string price_reranking_level = 4;
        Returns:
        The bytes for priceRerankingLevel.

      • getFacetControlIdsList

        List<String> getFacetControlIdsList()
         Facet specifications for faceted search. If empty, no facets are returned.
 The ids refer to the ids of [Control][google.cloud.retail.v2alpha.Control]
 resources with only the Facet control set. These controls are assumed to be
 in the same [Catalog][google.cloud.retail.v2alpha.Catalog] as the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig].
 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string facet_control_ids = 5;
        Returns:
        A list containing the facetControlIds.

      • getFacetControlIdsCount

        int getFacetControlIdsCount()
         Facet specifications for faceted search. If empty, no facets are returned.
 The ids refer to the ids of [Control][google.cloud.retail.v2alpha.Control]
 resources with only the Facet control set. These controls are assumed to be
 in the same [Catalog][google.cloud.retail.v2alpha.Catalog] as the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig].
 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string facet_control_ids = 5;
        Returns:
        The count of facetControlIds.

      • getFacetControlIds

        String getFacetControlIds​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
 The ids refer to the ids of [Control][google.cloud.retail.v2alpha.Control]
 resources with only the Facet control set. These controls are assumed to be
 in the same [Catalog][google.cloud.retail.v2alpha.Catalog] as the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig].
 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string facet_control_ids = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The facetControlIds at the given index.

      • getFacetControlIdsBytes

        com.google.protobuf.ByteString getFacetControlIdsBytes​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
 The ids refer to the ids of [Control][google.cloud.retail.v2alpha.Control]
 resources with only the Facet control set. These controls are assumed to be
 in the same [Catalog][google.cloud.retail.v2alpha.Catalog] as the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig].
 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string facet_control_ids = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the facetControlIds at the given index.

      • hasDynamicFacetSpec

        boolean hasDynamicFacetSpec()
         The specification for dynamically generated facets. Notice that only
 textual facets can be dynamically generated.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        .google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;
        Returns:
        Whether the dynamicFacetSpec field is set.

      • getDynamicFacetSpec

        SearchRequest.DynamicFacetSpec getDynamicFacetSpec()
         The specification for dynamically generated facets. Notice that only
 textual facets can be dynamically generated.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        .google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;
        Returns:
        The dynamicFacetSpec.

      • getDynamicFacetSpecOrBuilder

        SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()
         The specification for dynamically generated facets. Notice that only
 textual facets can be dynamically generated.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        .google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

      • getBoostControlIdsList

        List<String> getBoostControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string boost_control_ids = 7;
        Returns:
        A list containing the boostControlIds.

      • getBoostControlIdsCount

        int getBoostControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string boost_control_ids = 7;
        Returns:
        The count of boostControlIds.

      • getBoostControlIds

        String getBoostControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string boost_control_ids = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The boostControlIds at the given index.

      • getBoostControlIdsBytes

        com.google.protobuf.ByteString getBoostControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string boost_control_ids = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the boostControlIds at the given index.

      • getFilterControlIdsList

        List<String> getFilterControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string filter_control_ids = 9;
        Returns:
        A list containing the filterControlIds.

      • getFilterControlIdsCount

        int getFilterControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string filter_control_ids = 9;
        Returns:
        The count of filterControlIds.

      • getFilterControlIds

        String getFilterControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string filter_control_ids = 9;
        Parameters:
        index - The index of the element to return.
        Returns:
        The filterControlIds at the given index.

      • getFilterControlIdsBytes

        com.google.protobuf.ByteString getFilterControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string filter_control_ids = 9;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the filterControlIds at the given index.

      • getRedirectControlIdsList

        List<String> getRedirectControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string redirect_control_ids = 10;
        Returns:
        A list containing the redirectControlIds.

      • getRedirectControlIdsCount

        int getRedirectControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string redirect_control_ids = 10;
        Returns:
        The count of redirectControlIds.

      • getRedirectControlIds

        String getRedirectControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string redirect_control_ids = 10;
        Parameters:
        index - The index of the element to return.
        Returns:
        The redirectControlIds at the given index.

      • getRedirectControlIdsBytes

        com.google.protobuf.ByteString getRedirectControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string redirect_control_ids = 10;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the redirectControlIds at the given index.

      • getTwowaySynonymsControlIdsList

        List<String> getTwowaySynonymsControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string twoway_synonyms_control_ids = 18;
        Returns:
        A list containing the twowaySynonymsControlIds.

      • getTwowaySynonymsControlIdsCount

        int getTwowaySynonymsControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string twoway_synonyms_control_ids = 18;
        Returns:
        The count of twowaySynonymsControlIds.

      • getTwowaySynonymsControlIds

        String getTwowaySynonymsControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string twoway_synonyms_control_ids = 18;
        Parameters:
        index - The index of the element to return.
        Returns:
        The twowaySynonymsControlIds at the given index.

      • getTwowaySynonymsControlIdsBytes

        com.google.protobuf.ByteString getTwowaySynonymsControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string twoway_synonyms_control_ids = 18;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the twowaySynonymsControlIds at the given index.

      • getOnewaySynonymsControlIdsList

        List<String> getOnewaySynonymsControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string oneway_synonyms_control_ids = 12;
        Returns:
        A list containing the onewaySynonymsControlIds.

      • getOnewaySynonymsControlIdsCount

        int getOnewaySynonymsControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string oneway_synonyms_control_ids = 12;
        Returns:
        The count of onewaySynonymsControlIds.

      • getOnewaySynonymsControlIds

        String getOnewaySynonymsControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string oneway_synonyms_control_ids = 12;
        Parameters:
        index - The index of the element to return.
        Returns:
        The onewaySynonymsControlIds at the given index.

      • getOnewaySynonymsControlIdsBytes

        com.google.protobuf.ByteString getOnewaySynonymsControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string oneway_synonyms_control_ids = 12;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the onewaySynonymsControlIds at the given index.

      • getDoNotAssociateControlIdsList

        List<String> getDoNotAssociateControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string do_not_associate_control_ids = 13;
        Returns:
        A list containing the doNotAssociateControlIds.

      • getDoNotAssociateControlIdsCount

        int getDoNotAssociateControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string do_not_associate_control_ids = 13;
        Returns:
        The count of doNotAssociateControlIds.

      • getDoNotAssociateControlIds

        String getDoNotAssociateControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string do_not_associate_control_ids = 13;
        Parameters:
        index - The index of the element to return.
        Returns:
        The doNotAssociateControlIds at the given index.

      • getDoNotAssociateControlIdsBytes

        com.google.protobuf.ByteString getDoNotAssociateControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string do_not_associate_control_ids = 13;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the doNotAssociateControlIds at the given index.

      • getReplacementControlIdsList

        List<String> getReplacementControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string replacement_control_ids = 14;
        Returns:
        A list containing the replacementControlIds.

      • getReplacementControlIdsCount

        int getReplacementControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string replacement_control_ids = 14;
        Returns:
        The count of replacementControlIds.

      • getReplacementControlIds

        String getReplacementControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string replacement_control_ids = 14;
        Parameters:
        index - The index of the element to return.
        Returns:
        The replacementControlIds at the given index.

      • getReplacementControlIdsBytes

        com.google.protobuf.ByteString getReplacementControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string replacement_control_ids = 14;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the replacementControlIds at the given index.

      • getIgnoreControlIdsList

        List<String> getIgnoreControlIdsList()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string ignore_control_ids = 15;
        Returns:
        A list containing the ignoreControlIds.

      • getIgnoreControlIdsCount

        int getIgnoreControlIdsCount()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string ignore_control_ids = 15;
        Returns:
        The count of ignoreControlIds.

      • getIgnoreControlIds

        String getIgnoreControlIds​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string ignore_control_ids = 15;
        Parameters:
        index - The index of the element to return.
        Returns:
        The ignoreControlIds at the given index.

      • getIgnoreControlIdsBytes

        com.google.protobuf.ByteString getIgnoreControlIdsBytes​(int index)
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
        repeated string ignore_control_ids = 15;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the ignoreControlIds at the given index.

      • getDiversityLevel

        String getDiversityLevel()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string diversity_level = 8;
        Returns:
        The diversityLevel.

      • getDiversityLevelBytes

        com.google.protobuf.ByteString getDiversityLevelBytes()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string diversity_level = 8;
        Returns:
        The bytes for diversityLevel.

      • getDiversityTypeValue

        int getDiversityTypeValue()
         What kind of diversity to use - data driven or rule based. If unset, the
 server behavior defaults to
 [RULE_BASED_DIVERSITY][google.cloud.retail.v2alpha.ServingConfig.DiversityType.RULE_BASED_DIVERSITY].
        .google.cloud.retail.v2alpha.ServingConfig.DiversityType diversity_type = 20;
        Returns:
        The enum numeric value on the wire for diversityType.

      • getDiversityType

        ServingConfig.DiversityType getDiversityType()
         What kind of diversity to use - data driven or rule based. If unset, the
 server behavior defaults to
 [RULE_BASED_DIVERSITY][google.cloud.retail.v2alpha.ServingConfig.DiversityType.RULE_BASED_DIVERSITY].
        .google.cloud.retail.v2alpha.ServingConfig.DiversityType diversity_type = 20;
        Returns:
        The diversityType.

      • getEnableCategoryFilterLevel

        String getEnableCategoryFilterLevel()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string enable_category_filter_level = 16;
        Returns:
        The enableCategoryFilterLevel.

      • getEnableCategoryFilterLevelBytes

        com.google.protobuf.ByteString getEnableCategoryFilterLevelBytes()
         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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
        string enable_category_filter_level = 16;
        Returns:
        The bytes for enableCategoryFilterLevel.

      • hasPersonalizationSpec

        boolean hasPersonalizationSpec()
         The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
        .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;
        Returns:
        Whether the personalizationSpec field is set.

      • getPersonalizationSpec

        SearchRequest.PersonalizationSpec getPersonalizationSpec()
         The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
        .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;
        Returns:
        The personalizationSpec.

      • getPersonalizationSpecOrBuilder

        SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()
         The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
        .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;

      • getSolutionTypesList

        List<SolutionType> getSolutionTypesList()
         Required. Immutable. Specifies the solution types that a serving config can
 be associated with. Currently we support setting only one type of solution.
        repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        A list containing the solutionTypes.

      • getSolutionTypesCount

        int getSolutionTypesCount()
         Required. Immutable. Specifies the solution types that a serving config can
 be associated with. Currently we support setting only one type of solution.
        repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The count of solutionTypes.

      • getSolutionTypes

        SolutionType getSolutionTypes​(int index)
         Required. Immutable. Specifies the solution types that a serving config can
 be associated with. Currently we support setting only one type of solution.
        repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        index - The index of the element to return.
        Returns:
        The solutionTypes at the given index.

      • getSolutionTypesValueList

        List<Integer> getSolutionTypesValueList()
         Required. Immutable. Specifies the solution types that a serving config can
 be associated with. Currently we support setting only one type of solution.
        repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        A list containing the enum numeric values on the wire for solutionTypes.

      • getSolutionTypesValue

        int getSolutionTypesValue​(int index)
         Required. Immutable. Specifies the solution types that a serving config can
 be associated with. Currently we support setting only one type of solution.
        repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of solutionTypes at the given index.