Package co.elastic.clients.elasticsearch.ml

Class TextClassificationInferenceUpdateOptions

java.lang.Object

co.elastic.clients.elasticsearch.ml.TextClassificationInferenceUpdateOptions

All Implemented Interfaces:

InferenceConfigUpdateVariant, JsonpSerializable

@JsonpDeserializable
public class TextClassificationInferenceUpdateOptions
extends Object
implements InferenceConfigUpdateVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
InferenceConfigUpdate.Kind	_inferenceConfigUpdateKind()	InferenceConfigUpdate variant kind.
final List<String>	classificationLabels()	Classification labels to apply other than the stored labels.
final Integer	numTopClasses()	Specifies the number of top class predictions to return.
static TextClassificationInferenceUpdateOptions	of(Function<TextClassificationInferenceUpdateOptions.Builder,ObjectBuilder<TextClassificationInferenceUpdateOptions>> 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	setupTextClassificationInferenceUpdateOptionsDeserializer(ObjectDeserializer<TextClassificationInferenceUpdateOptions.Builder> op)
final NlpTokenizationUpdateOptions	tokenization()	The tokenization options to update when inferring
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.InferenceConfigUpdateVariant

_toInferenceConfigUpdate

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TextClassificationInferenceUpdateOptions> _DESERIALIZER

Json deserializer for TextClassificationInferenceUpdateOptions

Method Details

of

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

_inferenceConfigUpdateKind

public InferenceConfigUpdate.Kind _inferenceConfigUpdateKind()

InferenceConfigUpdate variant kind.

Specified by:

_inferenceConfigUpdateKind in interface InferenceConfigUpdateVariant

numTopClasses

@Nullable
public final Integer numTopClasses()

Specifies the number of top class predictions to return. Defaults to 0.

API name: num_top_classes

tokenization

@Nullable
public final NlpTokenizationUpdateOptions tokenization()

The tokenization options to update when inferring

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()

Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels

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

setupTextClassificationInferenceUpdateOptionsDeserializer

protected static void setupTextClassificationInferenceUpdateOptionsDeserializer(ObjectDeserializer<TextClassificationInferenceUpdateOptions.Builder> op)