Class CatalogAttribute.FacetConfig.RerankConfig (2.48.0)

Version 2.48.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class CatalogAttribute.FacetConfig.RerankConfig extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CatalogAttribute.FacetConfig.RerankConfig

Implements

CatalogAttribute.FacetConfig.RerankConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FACET_VALUES_FIELD_NUMBER

public static final int FACET_VALUES_FIELD_NUMBER

Field Value
Type	Description
int

RERANK_FACET_FIELD_NUMBER

public static final int RERANK_FACET_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CatalogAttribute.FacetConfig.RerankConfig getDefaultInstance()

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilder()

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

newBuilder(CatalogAttribute.FacetConfig.RerankConfig prototype)

public static CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilder(CatalogAttribute.FacetConfig.RerankConfig prototype)

Parameter
Name	Description
prototype	CatalogAttribute.FacetConfig.RerankConfig

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

parseDelimitedFrom(InputStream input)

public static CatalogAttribute.FacetConfig.RerankConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.RerankConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CatalogAttribute.FacetConfig.RerankConfig> parser()

Returns
Type	Description
Parser<RerankConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public CatalogAttribute.FacetConfig.RerankConfig getDefaultInstanceForType()

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig

getFacetValues(int index)

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

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

Returns
Type	Description
String	The facetValues at the given index.

getFacetValuesBytes(int index)

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

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

Returns
Type	Description
ByteString	The bytes of the facetValues at the given index.

getFacetValuesCount()

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

Returns
Type	Description
int	The count of facetValues.

getFacetValuesList()

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

Returns
Type	Description
ProtocolStringList	A list containing the facetValues.

getParserForType()

public Parser<CatalogAttribute.FacetConfig.RerankConfig> getParserForType()

Returns
Type	Description
Parser<RerankConfig>

Overrides

GeneratedMessageV3.getParserForType()

getRerankFacet()

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

Returns
Type	Description
boolean	The rerankFacet.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilderForType()

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CatalogAttribute.FacetConfig.RerankConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CatalogAttribute.FacetConfig.RerankConfig.Builder toBuilder()

Returns
Type	Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException