co.elastic.clients.elasticsearch.ml.InferenceResponseResult Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.FieldValue;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ml._types.InferenceResponseResult
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class InferenceResponseResult implements JsonpSerializable {
private final List entities;
@Nullable
private final Boolean isTruncated;
private final List> predictedValue;
@Nullable
private final String predictedValueSequence;
@Nullable
private final Double predictionProbability;
@Nullable
private final Double predictionScore;
private final List topClasses;
@Nullable
private final String warning;
private final List featureImportance;
// ---------------------------------------------------------------------------------------------
private InferenceResponseResult(Builder builder) {
this.entities = ApiTypeHelper.unmodifiable(builder.entities);
this.isTruncated = builder.isTruncated;
this.predictedValue = ApiTypeHelper.unmodifiable(builder.predictedValue);
this.predictedValueSequence = builder.predictedValueSequence;
this.predictionProbability = builder.predictionProbability;
this.predictionScore = builder.predictionScore;
this.topClasses = ApiTypeHelper.unmodifiable(builder.topClasses);
this.warning = builder.warning;
this.featureImportance = ApiTypeHelper.unmodifiable(builder.featureImportance);
}
public static InferenceResponseResult of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If the model is trained for named entity recognition (NER) tasks, the
* response contains the recognized entities.
*
* API name: {@code entities}
*/
public final List entities() {
return this.entities;
}
/**
* Indicates whether the input text was truncated to meet the model's maximum
* sequence length limit. This property is present only when it is true.
*
* API name: {@code is_truncated}
*/
@Nullable
public final Boolean isTruncated() {
return this.isTruncated;
}
/**
* If the model is trained for a text classification or zero shot classification
* task, the response is the predicted class. For named entity recognition (NER)
* tasks, it contains the annotated text output. For fill mask tasks, it
* contains the top prediction for replacing the mask token. For text embedding
* tasks, it contains the raw numerical text embedding values. For regression
* models, its a numerical value For classification models, it may be an
* integer, double, boolean or string depending on prediction type
*
* API name: {@code predicted_value}
*/
public final List> predictedValue() {
return this.predictedValue;
}
/**
* For fill mask tasks, the response contains the input text sequence with the
* mask token replaced by the predicted value. Additionally
*
* API name: {@code predicted_value_sequence}
*/
@Nullable
public final String predictedValueSequence() {
return this.predictedValueSequence;
}
/**
* Specifies a probability for the predicted value.
*
* API name: {@code prediction_probability}
*/
@Nullable
public final Double predictionProbability() {
return this.predictionProbability;
}
/**
* Specifies a confidence score for the predicted value.
*
* API name: {@code prediction_score}
*/
@Nullable
public final Double predictionScore() {
return this.predictionScore;
}
/**
* For fill mask, text classification, and zero shot classification tasks, the
* response contains a list of top class entries.
*
* API name: {@code top_classes}
*/
public final List topClasses() {
return this.topClasses;
}
/**
* If the request failed, the response contains the reason for the failure.
*
* API name: {@code warning}
*/
@Nullable
public final String warning() {
return this.warning;
}
/**
* The feature importance for the inference results. Relevant only for
* classification or regression models
*
* API name: {@code feature_importance}
*/
public final List featureImportance() {
return this.featureImportance;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (ApiTypeHelper.isDefined(this.entities)) {
generator.writeKey("entities");
generator.writeStartArray();
for (TrainedModelEntities item0 : this.entities) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.isTruncated != null) {
generator.writeKey("is_truncated");
generator.write(this.isTruncated);
}
if (ApiTypeHelper.isDefined(this.predictedValue)) {
generator.writeKey("predicted_value");
generator.writeStartArray();
for (List item0 : this.predictedValue) {
generator.writeStartArray();
if (item0 != null) {
for (FieldValue item1 : item0) {
item1.serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
if (this.predictedValueSequence != null) {
generator.writeKey("predicted_value_sequence");
generator.write(this.predictedValueSequence);
}
if (this.predictionProbability != null) {
generator.writeKey("prediction_probability");
generator.write(this.predictionProbability);
}
if (this.predictionScore != null) {
generator.writeKey("prediction_score");
generator.write(this.predictionScore);
}
if (ApiTypeHelper.isDefined(this.topClasses)) {
generator.writeKey("top_classes");
generator.writeStartArray();
for (TopClassEntry item0 : this.topClasses) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.warning != null) {
generator.writeKey("warning");
generator.write(this.warning);
}
if (ApiTypeHelper.isDefined(this.featureImportance)) {
generator.writeKey("feature_importance");
generator.writeStartArray();
for (TrainedModelInferenceFeatureImportance item0 : this.featureImportance) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link InferenceResponseResult}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private List entities;
@Nullable
private Boolean isTruncated;
@Nullable
private List> predictedValue;
@Nullable
private String predictedValueSequence;
@Nullable
private Double predictionProbability;
@Nullable
private Double predictionScore;
@Nullable
private List topClasses;
@Nullable
private String warning;
@Nullable
private List featureImportance;
/**
* If the model is trained for named entity recognition (NER) tasks, the
* response contains the recognized entities.
*
* API name: {@code entities}
*
* Adds all elements of list to entities.
*/
public final Builder entities(List list) {
this.entities = _listAddAll(this.entities, list);
return this;
}
/**
* If the model is trained for named entity recognition (NER) tasks, the
* response contains the recognized entities.
*
* API name: {@code entities}
*
* Adds one or more values to entities.
*/
public final Builder entities(TrainedModelEntities value, TrainedModelEntities... values) {
this.entities = _listAdd(this.entities, value, values);
return this;
}
/**
* If the model is trained for named entity recognition (NER) tasks, the
* response contains the recognized entities.
*
* API name: {@code entities}
*
* Adds a value to entities using a builder lambda.
*/
public final Builder entities(Function> fn) {
return entities(fn.apply(new TrainedModelEntities.Builder()).build());
}
/**
* Indicates whether the input text was truncated to meet the model's maximum
* sequence length limit. This property is present only when it is true.
*
* API name: {@code is_truncated}
*/
public final Builder isTruncated(@Nullable Boolean value) {
this.isTruncated = value;
return this;
}
/**
* If the model is trained for a text classification or zero shot classification
* task, the response is the predicted class. For named entity recognition (NER)
* tasks, it contains the annotated text output. For fill mask tasks, it
* contains the top prediction for replacing the mask token. For text embedding
* tasks, it contains the raw numerical text embedding values. For regression
* models, its a numerical value For classification models, it may be an
* integer, double, boolean or string depending on prediction type
*
* API name: {@code predicted_value}
*
* Adds all elements of list to predictedValue.
*/
public final Builder predictedValue(List> list) {
this.predictedValue = _listAddAll(this.predictedValue, list);
return this;
}
/**
* If the model is trained for a text classification or zero shot classification
* task, the response is the predicted class. For named entity recognition (NER)
* tasks, it contains the annotated text output. For fill mask tasks, it
* contains the top prediction for replacing the mask token. For text embedding
* tasks, it contains the raw numerical text embedding values. For regression
* models, its a numerical value For classification models, it may be an
* integer, double, boolean or string depending on prediction type
*
* API name: {@code predicted_value}
*
* Adds one or more values to predictedValue.
*/
public final Builder predictedValue(List value, List... values) {
this.predictedValue = _listAdd(this.predictedValue, value, values);
return this;
}
/**
* For fill mask tasks, the response contains the input text sequence with the
* mask token replaced by the predicted value. Additionally
*
* API name: {@code predicted_value_sequence}
*/
public final Builder predictedValueSequence(@Nullable String value) {
this.predictedValueSequence = value;
return this;
}
/**
* Specifies a probability for the predicted value.
*
* API name: {@code prediction_probability}
*/
public final Builder predictionProbability(@Nullable Double value) {
this.predictionProbability = value;
return this;
}
/**
* Specifies a confidence score for the predicted value.
*
* API name: {@code prediction_score}
*/
public final Builder predictionScore(@Nullable Double value) {
this.predictionScore = value;
return this;
}
/**
* For fill mask, text classification, and zero shot classification tasks, the
* response contains a list of top class entries.
*
* API name: {@code top_classes}
*
* Adds all elements of list to topClasses.
*/
public final Builder topClasses(List list) {
this.topClasses = _listAddAll(this.topClasses, list);
return this;
}
/**
* For fill mask, text classification, and zero shot classification tasks, the
* response contains a list of top class entries.
*
* API name: {@code top_classes}
*
* Adds one or more values to topClasses.
*/
public final Builder topClasses(TopClassEntry value, TopClassEntry... values) {
this.topClasses = _listAdd(this.topClasses, value, values);
return this;
}
/**
* For fill mask, text classification, and zero shot classification tasks, the
* response contains a list of top class entries.
*
* API name: {@code top_classes}
*
* Adds a value to topClasses using a builder lambda.
*/
public final Builder topClasses(Function> fn) {
return topClasses(fn.apply(new TopClassEntry.Builder()).build());
}
/**
* If the request failed, the response contains the reason for the failure.
*
* API name: {@code warning}
*/
public final Builder warning(@Nullable String value) {
this.warning = value;
return this;
}
/**
* The feature importance for the inference results. Relevant only for
* classification or regression models
*
* API name: {@code feature_importance}
*
* Adds all elements of list to featureImportance.
*/
public final Builder featureImportance(List list) {
this.featureImportance = _listAddAll(this.featureImportance, list);
return this;
}
/**
* The feature importance for the inference results. Relevant only for
* classification or regression models
*
* API name: {@code feature_importance}
*
* Adds one or more values to featureImportance.
*/
public final Builder featureImportance(TrainedModelInferenceFeatureImportance value,
TrainedModelInferenceFeatureImportance... values) {
this.featureImportance = _listAdd(this.featureImportance, value, values);
return this;
}
/**
* The feature importance for the inference results. Relevant only for
* classification or regression models
*
* API name: {@code feature_importance}
*
* Adds a value to featureImportance using a builder lambda.
*/
public final Builder featureImportance(
Function> fn) {
return featureImportance(fn.apply(new TrainedModelInferenceFeatureImportance.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link InferenceResponseResult}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public InferenceResponseResult build() {
_checkSingleUse();
return new InferenceResponseResult(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link InferenceResponseResult}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, InferenceResponseResult::setupInferenceResponseResultDeserializer);
protected static void setupInferenceResponseResultDeserializer(
ObjectDeserializer op) {
op.add(Builder::entities, JsonpDeserializer.arrayDeserializer(TrainedModelEntities._DESERIALIZER), "entities");
op.add(Builder::isTruncated, JsonpDeserializer.booleanDeserializer(), "is_truncated");
op.add(Builder::predictedValue,
JsonpDeserializer.arrayDeserializer(JsonpDeserializer.arrayDeserializer(FieldValue._DESERIALIZER)),
"predicted_value");
op.add(Builder::predictedValueSequence, JsonpDeserializer.stringDeserializer(), "predicted_value_sequence");
op.add(Builder::predictionProbability, JsonpDeserializer.doubleDeserializer(), "prediction_probability");
op.add(Builder::predictionScore, JsonpDeserializer.doubleDeserializer(), "prediction_score");
op.add(Builder::topClasses, JsonpDeserializer.arrayDeserializer(TopClassEntry._DESERIALIZER), "top_classes");
op.add(Builder::warning, JsonpDeserializer.stringDeserializer(), "warning");
op.add(Builder::featureImportance,
JsonpDeserializer.arrayDeserializer(TrainedModelInferenceFeatureImportance._DESERIALIZER),
"feature_importance");
}
}