Package com.google.cloud.retail.v2alpha
Class ServingConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.ServingConfig
- All Implemented Interfaces:
ServingConfigOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class ServingConfig
extends com.google.protobuf.GeneratedMessage
implements ServingConfigOrBuilder
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).Protobuf type
google.cloud.retail.v2alpha.ServingConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfigures metadata that is used to generate serving time results (e.g.static enumWhat type of diversity - data or rule based.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetBoostControlIds(int index) Condition boost specifications.com.google.protobuf.ByteStringgetBoostControlIdsBytes(int index) Condition boost specifications.intCondition boost specifications.com.google.protobuf.ProtocolStringListCondition boost specifications.static ServingConfigstatic final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.How much diversity to use in recommendation model results e.g.com.google.protobuf.ByteStringHow much diversity to use in recommendation model results e.g.What kind of diversity to use - data driven or rule based.intWhat kind of diversity to use - data driven or rule based.getDoNotAssociateControlIds(int index) Condition do not associate specifications.com.google.protobuf.ByteStringgetDoNotAssociateControlIdsBytes(int index) Condition do not associate specifications.intCondition do not associate specifications.com.google.protobuf.ProtocolStringListCondition do not associate specifications.The specification for dynamically generated facets.The specification for dynamically generated facets.Whether to add additional category filters on the `similar-items` model.com.google.protobuf.ByteStringWhether to add additional category filters on the `similar-items` model.getFacetControlIds(int index) Facet specifications for faceted search.com.google.protobuf.ByteStringgetFacetControlIdsBytes(int index) Facet specifications for faceted search.intFacet specifications for faceted search.com.google.protobuf.ProtocolStringListFacet specifications for faceted search.getFilterControlIds(int index) Condition filter specifications.com.google.protobuf.ByteStringgetFilterControlIdsBytes(int index) Condition filter specifications.intCondition filter specifications.com.google.protobuf.ProtocolStringListCondition filter specifications.getIgnoreControlIds(int index) Condition ignore specifications.com.google.protobuf.ByteStringgetIgnoreControlIdsBytes(int index) Condition ignore specifications.intCondition ignore specifications.com.google.protobuf.ProtocolStringListCondition ignore specifications.booleanWhen the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results.The id of the model in the same [Catalog][google.cloud.retail.v2alpha.Catalog] to use at serving time.com.google.protobuf.ByteStringThe id of the model in the same [Catalog][google.cloud.retail.v2alpha.Catalog] to use at serving time.getName()Immutable.com.google.protobuf.ByteStringImmutable.getOnewaySynonymsControlIds(int index) Condition oneway synonyms specifications.com.google.protobuf.ByteStringgetOnewaySynonymsControlIdsBytes(int index) Condition oneway synonyms specifications.intCondition oneway synonyms specifications.com.google.protobuf.ProtocolStringListCondition oneway synonyms specifications.com.google.protobuf.Parser<ServingConfig>The specification for personalization spec.The specification for personalization spec.How much price ranking we want in serving results.com.google.protobuf.ByteStringHow much price ranking we want in serving results.getRedirectControlIds(int index) Condition redirect specifications.com.google.protobuf.ByteStringgetRedirectControlIdsBytes(int index) Condition redirect specifications.intCondition redirect specifications.com.google.protobuf.ProtocolStringListCondition redirect specifications.getReplacementControlIds(int index) Condition replacement specificationscom.google.protobuf.ByteStringgetReplacementControlIdsBytes(int index) Condition replacement specificationsintCondition replacement specificationscom.google.protobuf.ProtocolStringListCondition replacement specificationsintgetSolutionTypes(int index) Required.intRequired.Required.intgetSolutionTypesValue(int index) Required.Required.getTwowaySynonymsControlIds(int index) Condition synonyms specifications.com.google.protobuf.ByteStringgetTwowaySynonymsControlIdsBytes(int index) Condition synonyms specifications.intCondition synonyms specifications.com.google.protobuf.ProtocolStringListCondition synonyms specifications.booleanThe specification for dynamically generated facets.inthashCode()booleanThe specification for personalization spec.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic ServingConfig.Builderstatic ServingConfig.BuildernewBuilder(ServingConfig prototype) protected ServingConfig.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ServingConfigparseDelimitedFrom(InputStream input) static ServingConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServingConfigparseFrom(byte[] data) static ServingConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServingConfigparseFrom(com.google.protobuf.ByteString data) static ServingConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServingConfigparseFrom(com.google.protobuf.CodedInputStream input) static ServingConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServingConfigparseFrom(InputStream input) static ServingConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServingConfigparseFrom(ByteBuffer data) static ServingConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ServingConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
MODEL_ID_FIELD_NUMBER
public static final int MODEL_ID_FIELD_NUMBER- See Also:
-
PRICE_RERANKING_LEVEL_FIELD_NUMBER
public static final int PRICE_RERANKING_LEVEL_FIELD_NUMBER- See Also:
-
FACET_CONTROL_IDS_FIELD_NUMBER
public static final int FACET_CONTROL_IDS_FIELD_NUMBER- See Also:
-
DYNAMIC_FACET_SPEC_FIELD_NUMBER
public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER- See Also:
-
BOOST_CONTROL_IDS_FIELD_NUMBER
public static final int BOOST_CONTROL_IDS_FIELD_NUMBER- See Also:
-
FILTER_CONTROL_IDS_FIELD_NUMBER
public static final int FILTER_CONTROL_IDS_FIELD_NUMBER- See Also:
-
REDIRECT_CONTROL_IDS_FIELD_NUMBER
public static final int REDIRECT_CONTROL_IDS_FIELD_NUMBER- See Also:
-
TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
public static final int TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER- See Also:
-
ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
public static final int ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER- See Also:
-
DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER
public static final int DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER- See Also:
-
REPLACEMENT_CONTROL_IDS_FIELD_NUMBER
public static final int REPLACEMENT_CONTROL_IDS_FIELD_NUMBER- See Also:
-
IGNORE_CONTROL_IDS_FIELD_NUMBER
public static final int IGNORE_CONTROL_IDS_FIELD_NUMBER- See Also:
-
DIVERSITY_LEVEL_FIELD_NUMBER
public static final int DIVERSITY_LEVEL_FIELD_NUMBER- See Also:
-
DIVERSITY_TYPE_FIELD_NUMBER
public static final int DIVERSITY_TYPE_FIELD_NUMBER- See Also:
-
ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER
public static final int ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER- See Also:
-
IGNORE_RECS_DENYLIST_FIELD_NUMBER
public static final int IGNORE_RECS_DENYLIST_FIELD_NUMBER- See Also:
-
PERSONALIZATION_SPEC_FIELD_NUMBER
public static final int PERSONALIZATION_SPEC_FIELD_NUMBER- See Also:
-
SOLUTION_TYPES_FIELD_NUMBER
public static final int SOLUTION_TYPES_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNamein interfaceServingConfigOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNameBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for name.
-
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];- Specified by:
getDisplayNamein interfaceServingConfigOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public 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];- Specified by:
getDisplayNameBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for displayName.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string model_id = 3;- Specified by:
getModelIdin interfaceServingConfigOrBuilder- Returns:
- The modelId.
-
getModelIdBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string model_id = 3;- Specified by:
getModelIdBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for modelId.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string price_reranking_level = 4;- Specified by:
getPriceRerankingLevelin interfaceServingConfigOrBuilder- Returns:
- The priceRerankingLevel.
-
getPriceRerankingLevelBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string price_reranking_level = 4;- Specified by:
getPriceRerankingLevelBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for priceRerankingLevel.
-
getFacetControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string facet_control_ids = 5;- Specified by:
getFacetControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the facetControlIds.
-
getFacetControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string facet_control_ids = 5;- Specified by:
getFacetControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of facetControlIds.
-
getFacetControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string facet_control_ids = 5;- Specified by:
getFacetControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The facetControlIds at the given index.
-
getFacetControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string facet_control_ids = 5;- Specified by:
getFacetControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the facetControlIds at the given index.
-
hasDynamicFacetSpec
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;- Specified by:
hasDynamicFacetSpecin interfaceServingConfigOrBuilder- Returns:
- Whether the dynamicFacetSpec field is set.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;- Specified by:
getDynamicFacetSpecin interfaceServingConfigOrBuilder- Returns:
- The dynamicFacetSpec.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;- Specified by:
getDynamicFacetSpecOrBuilderin interfaceServingConfigOrBuilder
-
getBoostControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string boost_control_ids = 7;- Specified by:
getBoostControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the boostControlIds.
-
getBoostControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string boost_control_ids = 7;- Specified by:
getBoostControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of boostControlIds.
-
getBoostControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string boost_control_ids = 7;- Specified by:
getBoostControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The boostControlIds at the given index.
-
getBoostControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string boost_control_ids = 7;- Specified by:
getBoostControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the boostControlIds at the given index.
-
getFilterControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string filter_control_ids = 9;- Specified by:
getFilterControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the filterControlIds.
-
getFilterControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string filter_control_ids = 9;- Specified by:
getFilterControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of filterControlIds.
-
getFilterControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string filter_control_ids = 9;- Specified by:
getFilterControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The filterControlIds at the given index.
-
getFilterControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string filter_control_ids = 9;- Specified by:
getFilterControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the filterControlIds at the given index.
-
getRedirectControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 10;- Specified by:
getRedirectControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the redirectControlIds.
-
getRedirectControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 10;- Specified by:
getRedirectControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of redirectControlIds.
-
getRedirectControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 10;- Specified by:
getRedirectControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The redirectControlIds at the given index.
-
getRedirectControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 10;- Specified by:
getRedirectControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the redirectControlIds at the given index.
-
getTwowaySynonymsControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string twoway_synonyms_control_ids = 18;- Specified by:
getTwowaySynonymsControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the twowaySynonymsControlIds.
-
getTwowaySynonymsControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string twoway_synonyms_control_ids = 18;- Specified by:
getTwowaySynonymsControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of twowaySynonymsControlIds.
-
getTwowaySynonymsControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string twoway_synonyms_control_ids = 18;- Specified by:
getTwowaySynonymsControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The twowaySynonymsControlIds at the given index.
-
getTwowaySynonymsControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string twoway_synonyms_control_ids = 18;- Specified by:
getTwowaySynonymsControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the twowaySynonymsControlIds at the given index.
-
getOnewaySynonymsControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 12;- Specified by:
getOnewaySynonymsControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the onewaySynonymsControlIds.
-
getOnewaySynonymsControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 12;- Specified by:
getOnewaySynonymsControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of onewaySynonymsControlIds.
-
getOnewaySynonymsControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 12;- Specified by:
getOnewaySynonymsControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The onewaySynonymsControlIds at the given index.
-
getOnewaySynonymsControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 12;- Specified by:
getOnewaySynonymsControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the onewaySynonymsControlIds at the given index.
-
getDoNotAssociateControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string do_not_associate_control_ids = 13;- Specified by:
getDoNotAssociateControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the doNotAssociateControlIds.
-
getDoNotAssociateControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string do_not_associate_control_ids = 13;- Specified by:
getDoNotAssociateControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of doNotAssociateControlIds.
-
getDoNotAssociateControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string do_not_associate_control_ids = 13;- Specified by:
getDoNotAssociateControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The doNotAssociateControlIds at the given index.
-
getDoNotAssociateControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string do_not_associate_control_ids = 13;- Specified by:
getDoNotAssociateControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the doNotAssociateControlIds at the given index.
-
getReplacementControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 14;- Specified by:
getReplacementControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the replacementControlIds.
-
getReplacementControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 14;- Specified by:
getReplacementControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of replacementControlIds.
-
getReplacementControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 14;- Specified by:
getReplacementControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The replacementControlIds at the given index.
-
getReplacementControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 14;- Specified by:
getReplacementControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the replacementControlIds at the given index.
-
getIgnoreControlIdsList
public com.google.protobuf.ProtocolStringList 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string ignore_control_ids = 15;- Specified by:
getIgnoreControlIdsListin interfaceServingConfigOrBuilder- Returns:
- A list containing the ignoreControlIds.
-
getIgnoreControlIdsCount
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string ignore_control_ids = 15;- Specified by:
getIgnoreControlIdsCountin interfaceServingConfigOrBuilder- Returns:
- The count of ignoreControlIds.
-
getIgnoreControlIds
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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string ignore_control_ids = 15;- Specified by:
getIgnoreControlIdsin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The ignoreControlIds at the given index.
-
getIgnoreControlIdsBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string ignore_control_ids = 15;- Specified by:
getIgnoreControlIdsBytesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the ignoreControlIds at the given index.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string diversity_level = 8;- Specified by:
getDiversityLevelin interfaceServingConfigOrBuilder- Returns:
- The diversityLevel.
-
getDiversityLevelBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string diversity_level = 8;- Specified by:
getDiversityLevelBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for diversityLevel.
-
getDiversityTypeValue
public 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;- Specified by:
getDiversityTypeValuein interfaceServingConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getDiversityTypein interfaceServingConfigOrBuilder- Returns:
- The diversityType.
-
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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string enable_category_filter_level = 16;- Specified by:
getEnableCategoryFilterLevelin interfaceServingConfigOrBuilder- Returns:
- The enableCategoryFilterLevel.
-
getEnableCategoryFilterLevelBytes
public 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.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string enable_category_filter_level = 16;- Specified by:
getEnableCategoryFilterLevelBytesin interfaceServingConfigOrBuilder- Returns:
- The bytes for enableCategoryFilterLevel.
-
getIgnoreRecsDenylist
public boolean getIgnoreRecsDenylist()When the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results.
bool ignore_recs_denylist = 24;- Specified by:
getIgnoreRecsDenylistin interfaceServingConfigOrBuilder- Returns:
- The ignoreRecsDenylist.
-
hasPersonalizationSpec
public 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.v2alpha.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;- Specified by:
hasPersonalizationSpecin interfaceServingConfigOrBuilder- Returns:
- Whether the personalizationSpec field is set.
-
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.v2alpha.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;- Specified by:
getPersonalizationSpecin interfaceServingConfigOrBuilder- Returns:
- The personalizationSpec.
-
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.v2alpha.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;- Specified by:
getPersonalizationSpecOrBuilderin interfaceServingConfigOrBuilder
-
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];- Specified by:
getSolutionTypesListin interfaceServingConfigOrBuilder- Returns:
- A list containing the solutionTypes.
-
getSolutionTypesCount
public 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];- Specified by:
getSolutionTypesCountin interfaceServingConfigOrBuilder- Returns:
- The count of solutionTypes.
-
getSolutionTypes
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];- Specified by:
getSolutionTypesin interfaceServingConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The solutionTypes at the given index.
-
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];- Specified by:
getSolutionTypesValueListin interfaceServingConfigOrBuilder- Returns:
- A list containing the enum numeric values on the wire for solutionTypes.
-
getSolutionTypesValue
public 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];- Specified by:
getSolutionTypesValuein interfaceServingConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of solutionTypes at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ServingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServingConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServingConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServingConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServingConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ServingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ServingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ServingConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-