Class CatalogAttribute.FacetConfig.RerankConfig.Builder (2.51.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFacetValues(Iterable<String> values)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addAllFacetValues(Iterable<String> values)

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
values Iterable<String>

The facetValues to add.

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

This builder for chaining.

addFacetValues(String value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addFacetValues(String value)

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
value String

The facetValues to add.

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

This builder for chaining.

addFacetValuesBytes(ByteString value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addFacetValuesBytes(ByteString value)

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
value ByteString

The bytes of the facetValues to add.

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

build()

public CatalogAttribute.FacetConfig.RerankConfig build()
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig

buildPartial()

public CatalogAttribute.FacetConfig.RerankConfig buildPartial()
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig

clear()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clear()
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

clearFacetValues()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearFacetValues()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

clearRerankFacet()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearRerankFacet()

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

This builder for chaining.

clone()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clone()
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

getDefaultInstanceForType()

public CatalogAttribute.FacetConfig.RerankConfig getDefaultInstanceForType()
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)
Parameter
Name Description
other CatalogAttribute.FacetConfig.RerankConfig
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.RerankConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

setFacetValues(int index, String value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setFacetValues(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The facetValues to set.

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides

setRerankFacet(boolean value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setRerankFacet(boolean value)

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;

Parameter
Name Description
value boolean

The rerankFacet to set.

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.RerankConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig.Builder
Overrides