Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class InferenceMetadataFieldsMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.InferenceMetadataFieldsMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public abstract class InferenceMetadataFieldsMapper
extends MetadataFieldMapper

An abstract MetadataFieldMapper used as a placeholder for implementation in the inference module. It is required by SourceFieldMapper to identify the field name for removal from _source.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceMetadataFieldsMapper.InferenceMetadataFieldType

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

MetadataFieldMapper.Builder, MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser

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

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 String	CONTENT_TYPE
static final String	NAME
static final Setting<Boolean>	USE_LEGACY_SEMANTIC_TEXT_FORMAT	Internal index setting to control the format used for semantic text fields.
static final IndexVersion	USE_NEW_SEMANTIC_TEXT_FORMAT_BY_DEFAULT

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_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InferenceMetadataFieldsMapper(MappedFieldType inferenceFieldType)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
InferenceMetadataFieldsMapper.InferenceMetadataFieldType	fieldType()
static boolean	isEnabled(Settings settings)	Checks if the InferenceMetadataFieldsMapper is enabled for the given Settings.
static boolean	isEnabled(MappingLookup mappingLookup)	Checks if the InferenceMetadataFieldsMapper is enabled based on the provided Mapping.

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

getMergeBuilder, parseCreateField, postParse, preParse, syntheticSourceSupport, toXContent, updateableBoolParam

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

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

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

freezeAndDeduplicateFieldType, getOffsetFieldName, internFieldName, leafName, supportStoringArrayOffsets, 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

USE_LEGACY_SEMANTIC_TEXT_FORMAT

public static final Setting<Boolean> USE_LEGACY_SEMANTIC_TEXT_FORMAT

Internal index setting to control the format used for semantic text fields. Determines whether to use the legacy format (default: true). This setting is immutable and can only be defined at index creation to ensure the internal format remains consistent throughout the index's lifecycle.

USE_NEW_SEMANTIC_TEXT_FORMAT_BY_DEFAULT

public static final IndexVersion USE_NEW_SEMANTIC_TEXT_FORMAT_BY_DEFAULT

NAME

public static final String NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

InferenceMetadataFieldsMapper

protected InferenceMetadataFieldsMapper(MappedFieldType inferenceFieldType)

Method Details

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

fieldType

public InferenceMetadataFieldsMapper.InferenceMetadataFieldType fieldType()

Overrides:

fieldType in class FieldMapper

isEnabled

public static boolean isEnabled(Settings settings)

Checks if the InferenceMetadataFieldsMapper is enabled for the given Settings. This indicates whether the new format for semantic text fields is active. The new format is enabled if: 1. The index version is on or after IndexVersions.INFERENCE_METADATA_FIELDS, and 2. The legacy semantic text format is disabled.

Parameters:

settings - the index settings to evaluate

Returns:

true if the new format is enabled; false otherwise

isEnabled

public static boolean isEnabled(MappingLookup mappingLookup)

Checks if the InferenceMetadataFieldsMapper is enabled based on the provided Mapping. This indicates whether the new format for semantic text fields is active by verifying the existence of the InferenceMetadataFieldsMapper in the mapping's metadata.

Parameters:

mappingLookup - the mapping to evaluate

Returns:

true if the InferenceMetadataFieldsMapper is present; false otherwise