Module org.elasticsearch.server
Class DenseVectorFieldMapper.DenseVectorFieldType
java.lang.Object
org.elasticsearch.index.mapper.MappedFieldType
org.elasticsearch.index.mapper.SimpleMappedFieldType
org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorFieldType
- Enclosing class:
DenseVectorFieldMapper
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType
MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation -
Constructor Summary
ConstructorsConstructorDescriptionDenseVectorFieldType(String name, IndexVersion indexVersionCreated, DenseVectorFieldMapper.ElementType elementType, Integer dims, boolean indexed, DenseVectorFieldMapper.VectorSimilarity similarity, DenseVectorFieldMapper.DenseVectorIndexOptions indexOptions, Map<String, String> meta, boolean isSyntheticSource) -
Method Summary
Modifier and TypeMethodDescriptionblockLoader(MappedFieldType.BlockLoaderContext blContext) Returns a loader for ESQL ornullif the field doesn't support ESQL.org.apache.lucene.search.QuerycreateExactKnnQuery(VectorData queryVector, Float vectorSimilarity) org.apache.lucene.search.QuerycreateKnnQuery(VectorData queryVector, int k, int numCands, Float oversample, org.apache.lucene.search.Query filter, Float similarityThreshold, org.apache.lucene.search.join.BitSetProducer parentFilter, DenseVectorFieldMapper.FilterHeuristic heuristic) docValueFormat(String format, ZoneId timeZone) Pick aDocValueFormatthat can be used to display and parse values of fields of this type.org.apache.lucene.search.QueryexistsQuery(SearchExecutionContext context) fielddataBuilder(FieldDataContext fieldDataContext) Return a fielddata builder for this fieldbooleanReturns true if the field is aggregatable.booleanVector embeddings are typically large and not intended for human consumption, so such fields may be excluded from responses.org.apache.lucene.search.QuerytermQuery(Object value, SearchExecutionContext context) Generates a query that will only match documents that contain the given value.typeName()Returns the name of this type, as would be specified in mapping propertiesvalueFetcher(SearchExecutionContext context, String format) Create a helper class to fetch field values during theFetchFieldsPhase.Methods inherited from class org.elasticsearch.index.mapper.SimpleMappedFieldType
rangeQuery, rangeQueryMethods inherited from class org.elasticsearch.index.mapper.MappedFieldType
automatonQuery, checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, eagerGlobalOrdinals, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fieldHasValue, fuzzyIntervals, fuzzyQuery, fuzzyQuery, getDefaultHighlighter, getMetricType, getTerms, getTextSearchInfo, hasDocValues, hasScriptValues, isDimension, isFieldWithinQuery, isIndexed, isSearchable, isStored, mayExistInIndex, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, prefixQuery, rangeIntervals, regexpIntervals, regexpQuery, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, validateMatchedRoutingPath, valueForDisplay, wildcardIntervals, wildcardLikeQuery, wildcardQuery, wildcardQuery
-
Constructor Details
-
DenseVectorFieldType
public DenseVectorFieldType(String name, IndexVersion indexVersionCreated, DenseVectorFieldMapper.ElementType elementType, Integer dims, boolean indexed, DenseVectorFieldMapper.VectorSimilarity similarity, DenseVectorFieldMapper.DenseVectorIndexOptions indexOptions, Map<String, String> meta, boolean isSyntheticSource)
-
-
Method Details
-
typeName
Description copied from class:MappedFieldTypeReturns the name of this type, as would be specified in mapping properties- Specified by:
typeNamein classMappedFieldType
-
valueFetcher
Description copied from class:MappedFieldTypeCreate a helper class to fetch field values during theFetchFieldsPhase. New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throwUnsupportedOperationExceptionsince this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.- Specified by:
valueFetcherin classMappedFieldType
-
docValueFormat
Description copied from class:MappedFieldTypePick aDocValueFormatthat can be used to display and parse values of fields of this type.- Overrides:
docValueFormatin classMappedFieldType
-
isAggregatable
public boolean isAggregatable()Description copied from class:MappedFieldTypeReturns true if the field is aggregatable.- Overrides:
isAggregatablein classMappedFieldType
-
isVectorEmbedding
public boolean isVectorEmbedding()Description copied from class:MappedFieldTypeVector embeddings are typically large and not intended for human consumption, so such fields may be excluded from responses.- Overrides:
isVectorEmbeddingin classMappedFieldType- Returns:
- true if this field contains vector embeddings.
-
fielddataBuilder
Description copied from class:MappedFieldTypeReturn a fielddata builder for this field- Overrides:
fielddataBuilderin classMappedFieldType- Parameters:
fieldDataContext- the context for the fielddata
-
existsQuery
- Overrides:
existsQueryin classMappedFieldType
-
termQuery
Description copied from class:MappedFieldTypeGenerates a query that will only match documents that contain the given value. The default implementation returns aTermQueryover the value bytes- Specified by:
termQueryin classMappedFieldType
-
createExactKnnQuery
public org.apache.lucene.search.Query createExactKnnQuery(VectorData queryVector, Float vectorSimilarity) -
createKnnQuery
public org.apache.lucene.search.Query createKnnQuery(VectorData queryVector, int k, int numCands, Float oversample, org.apache.lucene.search.Query filter, Float similarityThreshold, org.apache.lucene.search.join.BitSetProducer parentFilter, DenseVectorFieldMapper.FilterHeuristic heuristic) -
getIndexOptions
-
blockLoader
Description copied from class:MappedFieldTypeReturns a loader for ESQL ornullif the field doesn't support ESQL.- Overrides:
blockLoaderin classMappedFieldType
-