Package co.elastic.clients.elasticsearch.ml

Class ZeroShotClassificationInferenceOptions

java.lang.Object

co.elastic.clients.elasticsearch.ml.ZeroShotClassificationInferenceOptions

All Implemented Interfaces:

InferenceConfigCreateVariant, JsonpSerializable

@JsonpDeserializable
public class ZeroShotClassificationInferenceOptions
extends Object
implements InferenceConfigCreateVariant, JsonpSerializable

Zero shot classification configuration options

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
InferenceConfigCreate.Kind	_inferenceConfigCreateKind()	InferenceConfigCreate variant kind.
final List<String>	classificationLabels()	Required - The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
final String	hypothesisTemplate()	Hypothesis template used when tokenizing labels for prediction
final List<String>	labels()	The labels to predict.
final Boolean	multiLabel()	Indicates if more than one true label exists.
static ZeroShotClassificationInferenceOptions	of(Function<ZeroShotClassificationInferenceOptions.Builder,ObjectBuilder<ZeroShotClassificationInferenceOptions>> 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	setupZeroShotClassificationInferenceOptionsDeserializer(ObjectDeserializer<ZeroShotClassificationInferenceOptions.Builder> op)
final TokenizationConfig	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.InferenceConfigCreateVariant

_toInferenceConfigCreate

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ZeroShotClassificationInferenceOptions> _DESERIALIZER

Json deserializer for ZeroShotClassificationInferenceOptions

Method Details

of

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

_inferenceConfigCreateKind

public InferenceConfigCreate.Kind _inferenceConfigCreateKind()

InferenceConfigCreate variant kind.

Specified by:

_inferenceConfigCreateKind in interface InferenceConfigCreateVariant

tokenization

@Nullable
public final TokenizationConfig tokenization()

The tokenization options to update when inferring

API name: tokenization

hypothesisTemplate

@Nullable
public final String hypothesisTemplate()

Hypothesis template used when tokenizing labels for prediction

API name: hypothesis_template

classificationLabels

public final List<String> classificationLabels()

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

API name: classification_labels

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

multiLabel

@Nullable
public final Boolean multiLabel()

Indicates if more than one true label exists.

API name: multi_label

labels

public final List<String> labels()

The labels to predict.

API name: 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

setupZeroShotClassificationInferenceOptionsDeserializer

protected static void setupZeroShotClassificationInferenceOptionsDeserializer(ObjectDeserializer<ZeroShotClassificationInferenceOptions.Builder> op)