Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel

Interface NlpConfig

All Superinterfaces:

InferenceConfig, LenientlyParsedInferenceConfig, NamedWriteable, NamedXContentObject, StrictlyParsedInferenceConfig, ToXContent, ToXContentObject, VersionedNamedWriteable, Writeable

All Known Implementing Classes:

FillMaskConfig, NerConfig, PassThroughConfig, QuestionAnsweringConfig, TextClassificationConfig, TextEmbeddingConfig, TextExpansionConfig, TextSimilarityConfig, ZeroShotClassificationConfig

public interface NlpConfig
extends LenientlyParsedInferenceConfig, StrictlyParsedInferenceConfig

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	CLASSIFICATION_LABELS
static final MlConfigVersion	MINIMUM_NLP_SUPPORTED_VERSION
static final ParseField	NUM_TOP_CLASSES
static final ParseField	TOKENIZATION
static final ParseField	VOCABULARY

Fields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

DEFAULT_RESULTS_FIELD, DEFAULT_TOP_CLASSES_RESULTS_FIELD, RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
Tokenization	getTokenization()
VocabularyConfig	getVocabularyConfig()
default boolean	supportsIngestPipeline()
default boolean	supportsPipelineAggregation()
default boolean	supportsSearchRescorer()

Methods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

apply, getDefaultInput, getMinimalSupportedMlConfigVersion, getMinimalSupportedTransportVersion, getMinimalSupportedVersion, getMinLicenseSupported, getMinLicenseSupportedForAction, getResultsField, incompatibleUpdateException, isAllocateOnly, isTargetTypeSupported, requestingImportance, validateTrainedModelInput

Methods inherited from interface org.elasticsearch.xpack.core.ml.utils.NamedXContentObject

getName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

getWriteableName, supportsVersion

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Field Details

VOCABULARY

static final ParseField VOCABULARY

TOKENIZATION

static final ParseField TOKENIZATION

CLASSIFICATION_LABELS

static final ParseField CLASSIFICATION_LABELS

NUM_TOP_CLASSES

static final ParseField NUM_TOP_CLASSES

MINIMUM_NLP_SUPPORTED_VERSION

static final MlConfigVersion MINIMUM_NLP_SUPPORTED_VERSION

Method Details

getVocabularyConfig

VocabularyConfig getVocabularyConfig()

Returns:

the vocabulary configuration that allows retrieving it

getTokenization

Tokenization getTokenization()

Returns:

the model tokenization parameters

supportsIngestPipeline

default boolean supportsIngestPipeline()

Specified by:

supportsIngestPipeline in interface InferenceConfig

supportsPipelineAggregation

default boolean supportsPipelineAggregation()

Specified by:

supportsPipelineAggregation in interface InferenceConfig

supportsSearchRescorer

default boolean supportsSearchRescorer()

Specified by:

supportsSearchRescorer in interface InferenceConfig