Package org.apache.solr.schema

Class ScalarQuantizedDenseVectorField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.PrimitiveFieldType

org.apache.solr.schema.NumericFieldType

org.apache.solr.schema.PointField

org.apache.solr.schema.FloatPointField

org.apache.solr.schema.DenseVectorField

org.apache.solr.schema.ScalarQuantizedDenseVectorField

All Implemented Interfaces:

FloatValueFieldType, NumericValueFieldType

public class ScalarQuantizedDenseVectorField
extends DenseVectorField

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

FieldType.DefaultAnalyzer, FieldType.MultiValueSelector

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BITS_PARAM
static final String	COMPRESS_PARAM
static final String	CONFIDENCE_INTERVAL_PARAM
static final String	DYNAMIC_CONFIDENCE_INTERVAL_PARAM

Fields inherited from class org.apache.solr.schema.DenseVectorField

CAGRA_HNSW_ALGORITHM, DEFAULT_KNN_ALGORITHM, HNSW_ALGORITHM

Fields inherited from class org.apache.solr.schema.PointField

TEST_HACK_IGNORE_USELESS_TRIEFIELD_ARGS

Fields inherited from class org.apache.solr.schema.NumericFieldType

doubleOrFloat, type

Fields inherited from class org.apache.solr.schema.FieldType

ANALYZER, args, AUTO_GENERATE_PHRASE_QUERIES, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, ENABLE_GRAPH_QUERIES, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, SYNONYM_QUERY_STYLE, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName

Fields inherited from class org.apache.solr.schema.FieldProperties

BINARY, DOC_VALUES, INDEXED, LARGE_FIELD, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPAYLOADS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED, UNINVERTIBLE, USE_DOCVALUES_AS_STORED

Constructor Summary

Constructors

Constructor	Description
ScalarQuantizedDenseVectorField()
ScalarQuantizedDenseVectorField(int dimension, org.apache.lucene.index.VectorSimilarityFunction similarityFunction, org.apache.lucene.index.VectorEncoding vectorEncoding, int bits, Float confidenceInterval, boolean compress)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.codecs.KnnVectorsFormat	buildKnnVectorsFormat()
void	checkSchemaField(SchemaField field)	Check's SchemaField instances constructed using this field type to ensure that they are valid.
int	getBits()
Float	getConfidenceInterval()
void	init(IndexSchema schema, Map<String,String> args)	NOTE: This method can be removed completely when PointField.TEST_HACK_IGNORE_USELESS_TRIEFIELD_ARGS is removed
boolean	useCompression()

Methods inherited from class org.apache.solr.schema.DenseVectorField

createField, createFields, enableDocValuesByDefault, getCuvsGraphDegree, getCuvsHnswEfConstruction, getCuvsHnswLayers, getCuvsHnswMaxConn, getCuvsIntGraphDegree, getCuvsWriterThreads, getDimension, getFieldQuery, getHnswBeamWidth, getHnswEfConstruction, getHnswM, getHnswMaxConn, getKnnAlgorithm, getKnnVectorQuery, getRangeQuery, getSimilarityFunction, getSortField, getUninversionType, getValueSource, getVectorBuilder, getVectorEncoding, toObject

Methods inherited from class org.apache.solr.schema.FloatPointField

getExactQuery, getPointRangeQuery, getSetQuery, getSingleValueSource, getStoredField, indexedToReadable, readableToIndexed, toNativeType, toObject

Methods inherited from class org.apache.solr.schema.PointField

getPrefixQuery, getSingleValueSource, getSpecializedRangeQuery, indexedToReadable, indexedToReadable, isFieldUsed, isPointField, isTokenized, multiValuedFieldCache, storedToIndexed, storedToReadable, toInternal, toInternalByteRef, write

Methods inherited from class org.apache.solr.schema.NumericFieldType

getDocValuesRangeQuery, getNumberType, getRangeQueryForFloatDoubleDocValues, getRangeQueryForMultiValuedDoubleDocValues, getRangeQueryForMultiValuedFloatDocValues, getSpecializedExistenceQuery, numericDocValuesRangeQuery, treatUnboundedRangeAsExistence

Methods inherited from class org.apache.solr.schema.PrimitiveFieldType

checkSupportsDocValues, getDefaultMultiValueSelectorForSort

Methods inherited from class org.apache.solr.schema.FieldType

createField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getExistenceQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericSort, getPostingsFormat, getQueryAnalyzer, getRewriteMethod, getSimilarity, getSimilarityFactory, getSortedNumericSortField, getSortedSetSortField, getSortField, getStringSort, getTypeName, hasProperty, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPolyField, isUtf8Field, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, supportsAnalyzers, toExternal, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue, useDocValuesAsStored, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

BITS_PARAM

public static final String BITS_PARAM

See Also:

• Constant Field Values

CONFIDENCE_INTERVAL_PARAM

public static final String CONFIDENCE_INTERVAL_PARAM

See Also:

• Constant Field Values

DYNAMIC_CONFIDENCE_INTERVAL_PARAM

public static final String DYNAMIC_CONFIDENCE_INTERVAL_PARAM

See Also:

• Constant Field Values

COMPRESS_PARAM

public static final String COMPRESS_PARAM

See Also:

• Constant Field Values

Constructor Details

ScalarQuantizedDenseVectorField

public ScalarQuantizedDenseVectorField()

ScalarQuantizedDenseVectorField

public ScalarQuantizedDenseVectorField(int dimension,
 org.apache.lucene.index.VectorSimilarityFunction similarityFunction,
 org.apache.lucene.index.VectorEncoding vectorEncoding,
 int bits,
 Float confidenceInterval,
 boolean compress)

Method Details

init

public void init(IndexSchema schema,
 Map<String,String> args)

Description copied from class: PointField

NOTE: This method can be removed completely when PointField.TEST_HACK_IGNORE_USELESS_TRIEFIELD_ARGS is removed

Overrides:

init in class DenseVectorField

buildKnnVectorsFormat

public org.apache.lucene.codecs.KnnVectorsFormat buildKnnVectorsFormat()

Overrides:

buildKnnVectorsFormat in class DenseVectorField

checkSchemaField

public void checkSchemaField(SchemaField field)
                      throws org.apache.solr.common.SolrException

Description copied from class: FieldType

Check's SchemaField instances constructed using this field type to ensure that they are valid.

This method is called by the SchemaField constructor to check that its initialization does not violate any fundamental requirements of the FieldType. Subclasses may choose to throw a SolrException if invariants are violated by the SchemaField.

Overrides:

checkSchemaField in class DenseVectorField

Throws:

org.apache.solr.common.SolrException

getBits

public int getBits()

useCompression

public boolean useCompression()

getConfidenceInterval

public Float getConfidenceInterval()