Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.vectors

Class DenseVectorFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class DenseVectorFieldMapper
extends FieldMapper

A FieldMapper for indexing a dense vector of floats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DenseVectorFieldMapper.Builder
static final class	DenseVectorFieldMapper.DenseVectorFieldType
static enum	DenseVectorFieldMapper.ElementType
static interface	DenseVectorFieldMapper.IntBooleanConsumer	Interface for a function that takes a int and boolean
static enum	DenseVectorFieldMapper.VectorIndexType
static enum	DenseVectorFieldMapper.VectorSimilarity

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

FieldMapper.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.SourceKeepMode

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final NodeFeature	BBQ_FORMAT
static final int	BBQ_MIN_DIMS
static final NodeFeature	BIT_VECTORS
static final String	CONTENT_TYPE
static final String	COSINE_MAGNITUDE_FIELD_SUFFIX
static final IndexVersion	DEFAULT_TO_INT8
static final IndexVersion	INDEXED_BY_DEFAULT_INDEX_VERSION
static final NodeFeature	INT4_QUANTIZATION
static final IndexVersion	LITTLE_ENDIAN_FLOAT_STORED_INDEX_VERSION
static final int	MAGNITUDE_BYTES
static final IndexVersion	MAGNITUDE_STORED_INDEX_VERSION
static short	MAX_DIMS_COUNT
static int	MAX_DIMS_COUNT_BIT
static short	MIN_DIMS_FOR_DYNAMIC_FLOAT_MAPPING
static final Map<String,DenseVectorFieldMapper.ElementType>	namesToElementType
static final IndexVersion	NORMALIZE_COSINE
static final int	OVERSAMPLE_LIMIT
static final FieldMapper.TypeParser	PARSER

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

Fields inherited from class org.elasticsearch.index.mapper.Mapper

SYNTHETIC_SOURCE_KEEP_FEATURE, SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
DenseVectorFieldMapper.DenseVectorFieldType	fieldType()
org.apache.lucene.codecs.KnnVectorsFormat	getKnnVectorsFormatForField(org.apache.lucene.codecs.KnnVectorsFormat defaultFormat)
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
static boolean	isNotUnitVector(float magnitude)
void	parse(DocumentParserContext context)	Parse the field value using the provided DocumentParserContext.
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
boolean	parsesArrayValue()	Whether this mapper can handle an array value during document parsing.
protected FieldMapper.SyntheticSourceSupport	syntheticSourceSupport()	Returns implementation of synthetic source support for the mapper.

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, toXContent, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

freezeAndDeduplicateFieldType, internFieldName, leafName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

COSINE_MAGNITUDE_FIELD_SUFFIX

public static final String COSINE_MAGNITUDE_FIELD_SUFFIX

See Also:

• Constant Field Values

BBQ_MIN_DIMS

public static final int BBQ_MIN_DIMS

See Also:

• Constant Field Values

INT4_QUANTIZATION

public static final NodeFeature INT4_QUANTIZATION

BIT_VECTORS

public static final NodeFeature BIT_VECTORS

BBQ_FORMAT

public static final NodeFeature BBQ_FORMAT

MAGNITUDE_STORED_INDEX_VERSION

public static final IndexVersion MAGNITUDE_STORED_INDEX_VERSION

INDEXED_BY_DEFAULT_INDEX_VERSION

public static final IndexVersion INDEXED_BY_DEFAULT_INDEX_VERSION

NORMALIZE_COSINE

public static final IndexVersion NORMALIZE_COSINE

DEFAULT_TO_INT8

public static final IndexVersion DEFAULT_TO_INT8

LITTLE_ENDIAN_FLOAT_STORED_INDEX_VERSION

public static final IndexVersion LITTLE_ENDIAN_FLOAT_STORED_INDEX_VERSION

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

MAX_DIMS_COUNT

public static short MAX_DIMS_COUNT

MAX_DIMS_COUNT_BIT

public static int MAX_DIMS_COUNT_BIT

MIN_DIMS_FOR_DYNAMIC_FLOAT_MAPPING

public static short MIN_DIMS_FOR_DYNAMIC_FLOAT_MAPPING

MAGNITUDE_BYTES

public static final int MAGNITUDE_BYTES

See Also:

• Constant Field Values

OVERSAMPLE_LIMIT

public static final int OVERSAMPLE_LIMIT

See Also:

• Constant Field Values

namesToElementType

public static final Map<String,DenseVectorFieldMapper.ElementType> namesToElementType

PARSER

public static final FieldMapper.TypeParser PARSER

Method Details

isNotUnitVector

public static boolean isNotUnitVector(float magnitude)

fieldType

public DenseVectorFieldMapper.DenseVectorFieldType fieldType()

Overrides:

fieldType in class FieldMapper

parsesArrayValue

public boolean parsesArrayValue()

Description copied from class: FieldMapper

Whether this mapper can handle an array value during document parsing. If true, when an array is encountered during parsing, the document parser will pass the whole array to the mapper. If false, the array is split into individual values and each value is passed to the mapper for parsing.

Overrides:

parsesArrayValue in class FieldMapper

parse

public void parse(DocumentParserContext context)
           throws IOException

Description copied from class: FieldMapper

Parse the field value using the provided DocumentParserContext.

Overrides:

parse in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(DocumentParserContext context)

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

getKnnVectorsFormatForField

public org.apache.lucene.codecs.KnnVectorsFormat getKnnVectorsFormatForField(org.apache.lucene.codecs.KnnVectorsFormat defaultFormat)

Returns:

the custom kNN vectors format that is configured for this field or null if the default format should be used.

syntheticSourceSupport

protected FieldMapper.SyntheticSourceSupport syntheticSourceSupport()

Description copied from class: FieldMapper

Returns implementation of synthetic source support for the mapper.
By default (meaning FieldMapper.SyntheticSourceSupport.Fallback), an exact full copy of parsed field value is stored separately and used for synthetic source.

Field mappers must override this method if they provide a more efficient field-specific implementation of synthetic source.

Overrides:

syntheticSourceSupport in class FieldMapper

Returns:

FieldMapper.SyntheticSourceMode