Package co.elastic.clients.elasticsearch.ml

Class NerInferenceOptions

java.lang.Object

co.elastic.clients.elasticsearch.ml.NerInferenceOptions

All Implemented Interfaces:

InferenceConfigCreateVariant, JsonpSerializable

@JsonpDeserializable
public class NerInferenceOptions
extends Object
implements InferenceConfigCreateVariant, JsonpSerializable

Named entity recognition options

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NerInferenceOptions.Builder	Builder for NerInferenceOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<NerInferenceOptions>	_DESERIALIZER	Json deserializer for NerInferenceOptions

Method Summary

Modifier and Type	Method	Description
InferenceConfigCreate.Kind	_inferenceConfigCreateKind()	InferenceConfigCreate variant kind.
final List<String>	classificationLabels()	The token classification labels.
static NerInferenceOptions	of(Function<NerInferenceOptions.Builder,ObjectBuilder<NerInferenceOptions>> fn)
final String	resultsField()	The field that is added to incoming documents to contain the inference prediction.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupNerInferenceOptionsDeserializer(ObjectDeserializer<NerInferenceOptions.Builder> op)
final TokenizationConfig	tokenization()	The tokenization options
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.ml.InferenceConfigCreateVariant

_toInferenceConfigCreate

Field Details

_DESERIALIZER

public static final JsonpDeserializer<NerInferenceOptions> _DESERIALIZER

Json deserializer for NerInferenceOptions

Method Details

of

public static NerInferenceOptions of(Function<NerInferenceOptions.Builder,ObjectBuilder<NerInferenceOptions>> fn)

_inferenceConfigCreateKind

public InferenceConfigCreate.Kind _inferenceConfigCreateKind()

InferenceConfigCreate variant kind.

Specified by:

_inferenceConfigCreateKind in interface InferenceConfigCreateVariant

tokenization

@Nullable
public final TokenizationConfig tokenization()

The tokenization options

API name: tokenization

resultsField

@Nullable
public final String resultsField()

The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

API name: results_field

classificationLabels

public final List<String> classificationLabels()

The token classification labels. Must be IOB formatted tags

API name: classification_labels

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupNerInferenceOptionsDeserializer

protected static void setupNerInferenceOptionsDeserializer(ObjectDeserializer<NerInferenceOptions.Builder> op)