Class CatalogAttribute.FacetConfig.RerankConfig (2.55.0) 

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.v2alpha.CatalogAttribute.FacetConfig.RerankConfig

Inheritance

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

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

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

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException