Package co.elastic.clients.elasticsearch.ml

Class TextClassificationInferenceOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TextClassificationInferenceOptions.Builder>

co.elastic.clients.elasticsearch.ml.TextClassificationInferenceOptions.Builder

All Implemented Interfaces:

WithJson<TextClassificationInferenceOptions.Builder>, ObjectBuilder<TextClassificationInferenceOptions>

Enclosing class:

TextClassificationInferenceOptions

public static class TextClassificationInferenceOptions.Builder
extends WithJsonObjectBuilderBase<TextClassificationInferenceOptions.Builder>
implements ObjectBuilder<TextClassificationInferenceOptions>

Builder for TextClassificationInferenceOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextClassificationInferenceOptions	build()	Builds a TextClassificationInferenceOptions.
final TextClassificationInferenceOptions.Builder	classificationLabels(String value, String... values)	Classification labels to apply other than the stored labels.
final TextClassificationInferenceOptions.Builder	classificationLabels(List<String> list)	Classification labels to apply other than the stored labels.
final TextClassificationInferenceOptions.Builder	numTopClasses(Integer value)	Specifies the number of top class predictions to return.
final TextClassificationInferenceOptions.Builder	resultsField(String value)	The field that is added to incoming documents to contain the inference prediction.
protected TextClassificationInferenceOptions.Builder	self()
final TextClassificationInferenceOptions.Builder	tokenization(TokenizationConfig value)	The tokenization options
final TextClassificationInferenceOptions.Builder	tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)	The tokenization options

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

numTopClasses

public final TextClassificationInferenceOptions.Builder numTopClasses(@Nullable
 Integer value)

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

API name: num_top_classes

tokenization

public final TextClassificationInferenceOptions.Builder tokenization(@Nullable
 TokenizationConfig value)

The tokenization options

API name: tokenization

tokenization

public final TextClassificationInferenceOptions.Builder tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)

The tokenization options

API name: tokenization

resultsField

public final TextClassificationInferenceOptions.Builder resultsField(@Nullable
 String value)

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

API name: results_field

classificationLabels

public final TextClassificationInferenceOptions.Builder classificationLabels(List<String> list)

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

API name: classification_labels

Adds all elements of list to classificationLabels.

classificationLabels

public final TextClassificationInferenceOptions.Builder classificationLabels(String value,
 String... values)

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

API name: classification_labels

Adds one or more values to classificationLabels.

self

protected TextClassificationInferenceOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TextClassificationInferenceOptions.Builder>

build

public TextClassificationInferenceOptions build()

Builds a TextClassificationInferenceOptions.

Specified by:

build in interface ObjectBuilder<TextClassificationInferenceOptions>

Throws:

NullPointerException - if some of the required fields are null.