Module org.elasticsearch.xcore

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

Class NerConfig

java.lang.Object

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

All Implemented Interfaces:

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

public class NerConfig
extends Object
implements NlpConfig

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 String	NAME

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.xpack.core.ml.inference.trainedmodel.NlpConfig

CLASSIFICATION_LABELS, MINIMUM_NLP_SUPPORTED_VERSION, NUM_TOP_CLASSES, TOKENIZATION, VOCABULARY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NerConfig(StreamInput in)
NerConfig(VocabularyConfig vocabularyConfig, Tokenization tokenization, List<String> classificationLabels, String resultsField)

Method Summary

Modifier and Type	Method	Description
InferenceConfig	apply(InferenceConfigUpdate update)	Return a copy of this with the settings updated by the values in update.
boolean	equals(Object o)
static NerConfig	fromXContentLenient(XContentParser parser)
static NerConfig	fromXContentStrict(XContentParser parser)
List<String>	getClassificationLabels()
MlConfigVersion	getMinimalSupportedMlConfigVersion()	All nodes in the cluster must have at least this MlConfigVersion attribute
TransportVersion	getMinimalSupportedTransportVersion()	All communication in the cluster must use at least this version
String	getName()
String	getResultsField()
Tokenization	getTokenization()
VocabularyConfig	getVocabularyConfig()
String	getWriteableName()
int	hashCode()
boolean	isAllocateOnly()
boolean	isTargetTypeSupported(TargetType targetType)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static boolean	validIOBTag(String label)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getDefaultInput, getMinimalSupportedVersion, getMinLicenseSupported, getMinLicenseSupportedForAction, incompatibleUpdateException, requestingImportance, validateTrainedModelInput

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

supportsIngestPipeline, supportsPipelineAggregation, supportsSearchRescorer

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

NerConfig

public NerConfig(@Nullable
 VocabularyConfig vocabularyConfig,
 @Nullable
 Tokenization tokenization,
 @Nullable
 List<String> classificationLabels,
 @Nullable
 String resultsField)

NerConfig

public NerConfig(StreamInput in)
          throws IOException

Throws:

IOException

Method Details

validIOBTag

public static boolean validIOBTag(String label)

fromXContentStrict

public static NerConfig fromXContentStrict(XContentParser parser)

fromXContentLenient

public static NerConfig fromXContentLenient(XContentParser parser)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

isTargetTypeSupported

public boolean isTargetTypeSupported(TargetType targetType)

Specified by:

isTargetTypeSupported in interface InferenceConfig

apply

public InferenceConfig apply(InferenceConfigUpdate update)

Description copied from interface: InferenceConfig

Return a copy of this with the settings updated by the values in update.

Specified by:

apply in interface InferenceConfig

Parameters:

update - The update to apply

Returns:

A new updated config

getMinimalSupportedMlConfigVersion

public MlConfigVersion getMinimalSupportedMlConfigVersion()

Description copied from interface: InferenceConfig

All nodes in the cluster must have at least this MlConfigVersion attribute

Specified by:

getMinimalSupportedMlConfigVersion in interface InferenceConfig

getMinimalSupportedTransportVersion

public TransportVersion getMinimalSupportedTransportVersion()

Description copied from interface: InferenceConfig

All communication in the cluster must use at least this version

Specified by:

getMinimalSupportedTransportVersion in interface InferenceConfig

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getVocabularyConfig

public VocabularyConfig getVocabularyConfig()

Specified by:

getVocabularyConfig in interface NlpConfig

Returns:

the vocabulary configuration that allows retrieving it

getTokenization

public Tokenization getTokenization()

Specified by:

getTokenization in interface NlpConfig

Returns:

the model tokenization parameters

getClassificationLabels

public List<String> getClassificationLabels()

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceConfig

isAllocateOnly

public boolean isAllocateOnly()

Specified by:

isAllocateOnly in interface InferenceConfig