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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
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.
|
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.
|
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.
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.FacetConfig.RerankConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CatalogAttribute.FacetConfig.RerankConfig build()
buildPartial()
public CatalogAttribute.FacetConfig.RerankConfig buildPartial()
clear()
public CatalogAttribute.FacetConfig.RerankConfig.Builder clear()
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;
clearField(Descriptors.FieldDescriptor field)
public CatalogAttribute.FacetConfig.RerankConfig.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CatalogAttribute.FacetConfig.RerankConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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;
clone()
public CatalogAttribute.FacetConfig.RerankConfig.Builder clone()
Overrides
getDefaultInstanceForType()
public CatalogAttribute.FacetConfig.RerankConfig getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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;
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()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)
public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)
public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.FacetConfig.RerankConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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.
|
setField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.FacetConfig.RerankConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CatalogAttribute.FacetConfig.RerankConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.FacetConfig.RerankConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
