Interface ServingConfigOrBuilder (2.14.0)

public interface ServingConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoostControlIds(int index)

public abstract 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 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.

repeated string boost_control_ids = 7;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The boostControlIds at the given index.

getBoostControlIdsBytes(int index)

public abstract ByteString getBoostControlIdsBytes(int index)

repeated string boost_control_ids = 7;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the boostControlIds at the given index.

getBoostControlIdsCount()

public abstract int getBoostControlIdsCount()

repeated string boost_control_ids = 7;

Returns

Type	Description
`int`	The count of boostControlIds.

getBoostControlIdsList()

public abstract List<String> getBoostControlIdsList()

repeated string boost_control_ids = 7;

Returns

Type	Description
`List<String>`	A list containing the boostControlIds.

getDisplayName()

public abstract 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

Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`ByteString`	The bytes for displayName.

getDiversityLevel()

public abstract 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 is SOLUTION_TYPE_RECOMMENDATION.

string diversity_level = 8;

Returns

Type	Description
`String`	The diversityLevel.

getDiversityLevelBytes()

public abstract 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 is SOLUTION_TYPE_RECOMMENDATION.

string diversity_level = 8;

Returns

Type	Description
`ByteString`	The bytes for diversityLevel.

getDiversityType()

public abstract 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.v2.ServingConfig.DiversityType diversity_type = 20;

Returns

Type	Description
`ServingConfig.DiversityType`	The diversityType.

getDiversityTypeValue()

public abstract 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.v2.ServingConfig.DiversityType diversity_type = 20;

Returns

Type	Description
`int`	The enum numeric value on the wire for diversityType.

getDoNotAssociateControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The doNotAssociateControlIds at the given index.

getDoNotAssociateControlIdsBytes(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the doNotAssociateControlIds at the given index.

getDoNotAssociateControlIdsCount()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Returns

Type	Description
`int`	The count of doNotAssociateControlIds.

getDoNotAssociateControlIdsList()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Returns

Type	Description
`List<String>`	A list containing the doNotAssociateControlIds.

getDynamicFacetSpec()

public abstract 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 is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns

Type	Description
`SearchRequest.DynamicFacetSpec`	The dynamicFacetSpec.

getDynamicFacetSpecOrBuilder()

public abstract 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 is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns

Type	Description
`SearchRequest.DynamicFacetSpecOrBuilder`

getEnableCategoryFilterLevel()

public abstract 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 is SOLUTION_TYPE_RECOMMENDATION.

string enable_category_filter_level = 16;

Returns

Type	Description
`String`	The enableCategoryFilterLevel.

getEnableCategoryFilterLevelBytes()

public abstract 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 is SOLUTION_TYPE_RECOMMENDATION.

string enable_category_filter_level = 16;

Returns

Type	Description
`ByteString`	The bytes for enableCategoryFilterLevel.

getFacetControlIds(int index)

public abstract String getFacetControlIds(int index)

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.

repeated string facet_control_ids = 5;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The facetControlIds at the given index.

getFacetControlIdsBytes(int index)

public abstract ByteString getFacetControlIdsBytes(int index)

repeated string facet_control_ids = 5;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the facetControlIds at the given index.

getFacetControlIdsCount()

public abstract int getFacetControlIdsCount()

repeated string facet_control_ids = 5;

Returns

Type	Description
`int`	The count of facetControlIds.

getFacetControlIdsList()

public abstract List<String> getFacetControlIdsList()

repeated string facet_control_ids = 5;

Returns

Type	Description
`List<String>`	A list containing the facetControlIds.

getFilterControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string filter_control_ids = 9;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The filterControlIds at the given index.

getFilterControlIdsBytes(int index)

public abstract ByteString getFilterControlIdsBytes(int index)

repeated string filter_control_ids = 9;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the filterControlIds at the given index.

getFilterControlIdsCount()

public abstract int getFilterControlIdsCount()

repeated string filter_control_ids = 9;

Returns

Type	Description
`int`	The count of filterControlIds.

getFilterControlIdsList()

public abstract List<String> getFilterControlIdsList()

repeated string filter_control_ids = 9;

Returns

Type	Description
`List<String>`	A list containing the filterControlIds.

getIgnoreControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The ignoreControlIds at the given index.

getIgnoreControlIdsBytes(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the ignoreControlIds at the given index.

getIgnoreControlIdsCount()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Returns

Type	Description
`int`	The count of ignoreControlIds.

getIgnoreControlIdsList()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Returns

Type	Description
`List<String>`	A list containing the ignoreControlIds.

getModelId()

public abstract String getModelId()

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.

string model_id = 3;

Returns

Type	Description
`String`	The modelId.

getModelIdBytes()

public abstract ByteString getModelIdBytes()

string model_id = 3;

Returns

Type	Description
`ByteString`	The bytes for modelId.

getName()

public abstract String getName()

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`ByteString`	The bytes for name.

getOnewaySynonymsControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string oneway_synonyms_control_ids = 12;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The onewaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsBytes(int index)

public abstract ByteString getOnewaySynonymsControlIdsBytes(int index)

repeated string oneway_synonyms_control_ids = 12;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the onewaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsCount()

public abstract int getOnewaySynonymsControlIdsCount()

repeated string oneway_synonyms_control_ids = 12;

Returns

Type	Description
`int`	The count of onewaySynonymsControlIds.

getOnewaySynonymsControlIdsList()

public abstract List<String> getOnewaySynonymsControlIdsList()

repeated string oneway_synonyms_control_ids = 12;

Returns

Type	Description
`List<String>`	A list containing the onewaySynonymsControlIds.

getPersonalizationSpec()

public abstract SearchRequest.PersonalizationSpec getPersonalizationSpec()

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.

.google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns

Type	Description
`SearchRequest.PersonalizationSpec`	The personalizationSpec.

getPersonalizationSpecOrBuilder()

public abstract SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

.google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns

Type	Description
`SearchRequest.PersonalizationSpecOrBuilder`

getPriceRerankingLevel()

public abstract 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-raranking
medium-price-reranking
high-price-reranking If not specified, we choose default based on model type. Default value: no-price-reranking. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string price_reranking_level = 4;

Returns

Type	Description
`String`	The priceRerankingLevel.

getPriceRerankingLevelBytes()

public abstract ByteString getPriceRerankingLevelBytes()

no-price-reranking
low-price-raranking
medium-price-reranking
high-price-reranking If not specified, we choose default based on model type. Default value: no-price-reranking. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string price_reranking_level = 4;

Returns

Type	Description
`ByteString`	The bytes for priceRerankingLevel.

getRedirectControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string redirect_control_ids = 10;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The redirectControlIds at the given index.

getRedirectControlIdsBytes(int index)

public abstract ByteString getRedirectControlIdsBytes(int index)

repeated string redirect_control_ids = 10;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the redirectControlIds at the given index.

getRedirectControlIdsCount()

public abstract int getRedirectControlIdsCount()

repeated string redirect_control_ids = 10;

Returns

Type	Description
`int`	The count of redirectControlIds.

getRedirectControlIdsList()

public abstract List<String> getRedirectControlIdsList()

repeated string redirect_control_ids = 10;

Returns

Type	Description
`List<String>`	A list containing the redirectControlIds.

getReplacementControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The replacementControlIds at the given index.

getReplacementControlIdsBytes(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the replacementControlIds at the given index.

getReplacementControlIdsCount()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Returns

Type	Description
`int`	The count of replacementControlIds.

getReplacementControlIdsList()

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Returns

Type	Description
`List<String>`	A list containing the replacementControlIds.

getSolutionTypes(int index)

public abstract 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.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`SolutionType`	The solutionTypes at the given index.

getSolutionTypesCount()

public abstract 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.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`int`	The count of solutionTypes.

getSolutionTypesList()

public abstract 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.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`List<SolutionType>`	A list containing the solutionTypes.

getSolutionTypesValue(int index)

public abstract 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.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`int`	The enum numeric value on the wire of solutionTypes at the given index.

getSolutionTypesValueList()

public abstract 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.v2.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
`List<Integer>`	A list containing the enum numeric values on the wire for solutionTypes.

getTwowaySynonymsControlIds(int index)

public abstract 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 is SOLUTION_TYPE_SEARCH.

repeated string twoway_synonyms_control_ids = 18;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The twowaySynonymsControlIds at the given index.

getTwowaySynonymsControlIdsBytes(int index)

public abstract ByteString getTwowaySynonymsControlIdsBytes(int index)

repeated string twoway_synonyms_control_ids = 18;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the twowaySynonymsControlIds at the given index.

getTwowaySynonymsControlIdsCount()

public abstract int getTwowaySynonymsControlIdsCount()

repeated string twoway_synonyms_control_ids = 18;

Returns

Type	Description
`int`	The count of twowaySynonymsControlIds.

getTwowaySynonymsControlIdsList()

public abstract List<String> getTwowaySynonymsControlIdsList()

repeated string twoway_synonyms_control_ids = 18;

Returns

Type	Description
`List<String>`	A list containing the twowaySynonymsControlIds.

hasDynamicFacetSpec()

public abstract boolean hasDynamicFacetSpec()

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns

Type	Description
`boolean`	Whether the dynamicFacetSpec field is set.

hasPersonalizationSpec()

public abstract boolean hasPersonalizationSpec()

.google.cloud.retail.v2.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns

Type	Description
`boolean`	Whether the personalizationSpec field is set.