public static final class CatalogAttribute.FacetConfig.RerankConfig extends com.google.protobuf.GeneratedMessageV3 implements CatalogAttribute.FacetConfig.RerankConfigOrBuilder
Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).Protobuf type
google.cloud.retail.v2.CatalogAttribute.FacetConfig.RerankConfig| Modifier and Type | Class and Description |
|---|---|
static class |
CatalogAttribute.FacetConfig.RerankConfig.Builder
Options to rerank based on facet values engaged by the user for the
current key.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
FACET_VALUES_FIELD_NUMBER |
static int |
RERANK_FACET_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static CatalogAttribute.FacetConfig.RerankConfig |
getDefaultInstance() |
CatalogAttribute.FacetConfig.RerankConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFacetValues(int index)
If empty, rerank on all facet values for the current key.
|
com.google.protobuf.ByteString |
getFacetValuesBytes(int index)
If empty, rerank on all facet values for the current key.
|
int |
getFacetValuesCount()
If empty, rerank on all facet values for the current key.
|
com.google.protobuf.ProtocolStringList |
getFacetValuesList()
If empty, rerank on all facet values for the current key.
|
com.google.protobuf.Parser<CatalogAttribute.FacetConfig.RerankConfig> |
getParserForType() |
boolean |
getRerankFacet()
If set to true, then we also rerank the dynamic facets based on the
facet values engaged by the user for the current attribute key during
serving.
|
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static CatalogAttribute.FacetConfig.RerankConfig.Builder |
newBuilder() |
static CatalogAttribute.FacetConfig.RerankConfig.Builder |
newBuilder(CatalogAttribute.FacetConfig.RerankConfig prototype) |
CatalogAttribute.FacetConfig.RerankConfig.Builder |
newBuilderForType() |
protected CatalogAttribute.FacetConfig.RerankConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseDelimitedFrom(InputStream input) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(byte[] data) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(ByteBuffer data) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(com.google.protobuf.ByteString data) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(InputStream input) |
static CatalogAttribute.FacetConfig.RerankConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CatalogAttribute.FacetConfig.RerankConfig> |
parser() |
CatalogAttribute.FacetConfig.RerankConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int RERANK_FACET_FIELD_NUMBER
public static final int FACET_VALUES_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean getRerankFacet()
If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
bool rerank_facet = 1;getRerankFacet in interface CatalogAttribute.FacetConfig.RerankConfigOrBuilderpublic com.google.protobuf.ProtocolStringList getFacetValuesList()
If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
repeated string facet_values = 2;getFacetValuesList in interface CatalogAttribute.FacetConfig.RerankConfigOrBuilderpublic int getFacetValuesCount()
If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
repeated string facet_values = 2;getFacetValuesCount in interface CatalogAttribute.FacetConfig.RerankConfigOrBuilderpublic String getFacetValues(int index)
If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
repeated string facet_values = 2;getFacetValues in interface CatalogAttribute.FacetConfig.RerankConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getFacetValuesBytes(int index)
If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
repeated string facet_values = 2;getFacetValuesBytes in interface CatalogAttribute.FacetConfig.RerankConfigOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CatalogAttribute.FacetConfig.RerankConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilder()
public static CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilder(CatalogAttribute.FacetConfig.RerankConfig prototype)
public CatalogAttribute.FacetConfig.RerankConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CatalogAttribute.FacetConfig.RerankConfig getDefaultInstance()
public static com.google.protobuf.Parser<CatalogAttribute.FacetConfig.RerankConfig> parser()
public com.google.protobuf.Parser<CatalogAttribute.FacetConfig.RerankConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CatalogAttribute.FacetConfig.RerankConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.