Package co.elastic.clients.elasticsearch.ml

Class TextClassificationInferenceOptions

java.lang.Object

co.elastic.clients.elasticsearch.ml.TextClassificationInferenceOptions

All Implemented Interfaces:

InferenceConfigCreateVariant, JsonpSerializable

@JsonpDeserializable
public class TextClassificationInferenceOptions
extends Object
implements InferenceConfigCreateVariant, JsonpSerializable

Text classification configuration options

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
InferenceConfigCreate.Kind	_inferenceConfigCreateKind()	InferenceConfigCreate 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 TextClassificationInferenceOptions	of(Function<TextClassificationInferenceOptions.Builder,ObjectBuilder<TextClassificationInferenceOptions>> 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	setupTextClassificationInferenceOptionsDeserializer(ObjectDeserializer<TextClassificationInferenceOptions.Builder> op)
final TokenizationConfig	tokenization()	The tokenization options
String	toString()
final Vocabulary	vocabulary()	API name: vocabulary

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<TextClassificationInferenceOptions> _DESERIALIZER

Json deserializer for TextClassificationInferenceOptions

Method Details

of

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

_inferenceConfigCreateKind

public InferenceConfigCreate.Kind _inferenceConfigCreateKind()

InferenceConfigCreate variant kind.

Specified by:

_inferenceConfigCreateKind in interface InferenceConfigCreateVariant

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

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

API name: classification_labels

vocabulary

@Nullable
public final Vocabulary vocabulary()

API name: vocabulary

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

setupTextClassificationInferenceOptionsDeserializer

protected static void setupTextClassificationInferenceOptionsDeserializer(ObjectDeserializer<TextClassificationInferenceOptions.Builder> op)