Package co.elastic.clients.elasticsearch.ml

Class ZeroShotClassificationInferenceOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.ZeroShotClassificationInferenceOptions.Builder

All Implemented Interfaces:

WithJson<ZeroShotClassificationInferenceOptions.Builder>, ObjectBuilder<ZeroShotClassificationInferenceOptions>

Enclosing class:

ZeroShotClassificationInferenceOptions

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

Builder for ZeroShotClassificationInferenceOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ZeroShotClassificationInferenceOptions	build()	Builds a ZeroShotClassificationInferenceOptions.
final ZeroShotClassificationInferenceOptions.Builder	classificationLabels(String value, String... values)	Required - The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
final ZeroShotClassificationInferenceOptions.Builder	classificationLabels(List<String> list)	Required - The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
final ZeroShotClassificationInferenceOptions.Builder	hypothesisTemplate(String value)	Hypothesis template used when tokenizing labels for prediction
final ZeroShotClassificationInferenceOptions.Builder	labels(String value, String... values)	The labels to predict.
final ZeroShotClassificationInferenceOptions.Builder	labels(List<String> list)	The labels to predict.
final ZeroShotClassificationInferenceOptions.Builder	multiLabel(Boolean value)	Indicates if more than one true label exists.
final ZeroShotClassificationInferenceOptions.Builder	resultsField(String value)	The field that is added to incoming documents to contain the inference prediction.
protected ZeroShotClassificationInferenceOptions.Builder	self()
final ZeroShotClassificationInferenceOptions.Builder	tokenization(TokenizationConfig value)	The tokenization options to update when inferring
final ZeroShotClassificationInferenceOptions.Builder	tokenization(Function<TokenizationConfig.Builder,ObjectBuilder<TokenizationConfig>> fn)	The tokenization options to update when inferring

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

tokenization

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

The tokenization options to update when inferring

API name: tokenization

tokenization

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

The tokenization options to update when inferring

API name: tokenization

hypothesisTemplate

public final ZeroShotClassificationInferenceOptions.Builder hypothesisTemplate(@Nullable
 String value)

Hypothesis template used when tokenizing labels for prediction

API name: hypothesis_template

classificationLabels

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

Required - The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction

API name: classification_labels

Adds all elements of list to classificationLabels.

classificationLabels

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

Required - The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction

API name: classification_labels

Adds one or more values to classificationLabels.

resultsField

public final ZeroShotClassificationInferenceOptions.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

multiLabel

public final ZeroShotClassificationInferenceOptions.Builder multiLabel(@Nullable
 Boolean value)

Indicates if more than one true label exists.

API name: multi_label

labels

public final ZeroShotClassificationInferenceOptions.Builder labels(List<String> list)

The labels to predict.

API name: labels

Adds all elements of list to labels.

labels

public final ZeroShotClassificationInferenceOptions.Builder labels(String value,
 String... values)

The labels to predict.

API name: labels

Adds one or more values to labels.

self

protected ZeroShotClassificationInferenceOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ZeroShotClassificationInferenceOptions.Builder>

build

public ZeroShotClassificationInferenceOptions build()

Builds a ZeroShotClassificationInferenceOptions.

Specified by:

build in interface ObjectBuilder<ZeroShotClassificationInferenceOptions>

Throws:

NullPointerException - if some of the required fields are null.