co.elastic.clients.elasticsearch.ml.TextClassificationInferenceOptions Maven / Gradle / Ivy
/*
* 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.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.Integer;
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.TextClassificationInferenceOptions
/**
* Text classification configuration options
*
* @see API
* specification
*/
@JsonpDeserializable
public class TextClassificationInferenceOptions implements InferenceConfigCreateVariant, JsonpSerializable {
@Nullable
private final Integer numTopClasses;
@Nullable
private final TokenizationConfig tokenization;
@Nullable
private final String resultsField;
private final List classificationLabels;
// ---------------------------------------------------------------------------------------------
private TextClassificationInferenceOptions(Builder builder) {
this.numTopClasses = builder.numTopClasses;
this.tokenization = builder.tokenization;
this.resultsField = builder.resultsField;
this.classificationLabels = ApiTypeHelper.unmodifiable(builder.classificationLabels);
}
public static TextClassificationInferenceOptions of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* InferenceConfigCreate variant kind.
*/
@Override
public InferenceConfigCreate.Kind _inferenceConfigCreateKind() {
return InferenceConfigCreate.Kind.TextClassification;
}
/**
* Specifies the number of top class predictions to return. Defaults to 0.
*
* API name: {@code num_top_classes}
*/
@Nullable
public final Integer numTopClasses() {
return this.numTopClasses;
}
/**
* The tokenization options
*
* API name: {@code tokenization}
*/
@Nullable
public final TokenizationConfig tokenization() {
return this.tokenization;
}
/**
* The field that is added to incoming documents to contain the inference
* prediction. Defaults to predicted_value.
*
* API name: {@code results_field}
*/
@Nullable
public final String resultsField() {
return this.resultsField;
}
/**
* Classification labels to apply other than the stored labels. Must have the
* same deminsions as the default configured labels
*
* API name: {@code classification_labels}
*/
public final List classificationLabels() {
return this.classificationLabels;
}
/**
* 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 (this.numTopClasses != null) {
generator.writeKey("num_top_classes");
generator.write(this.numTopClasses);
}
if (this.tokenization != null) {
generator.writeKey("tokenization");
this.tokenization.serialize(generator, mapper);
}
if (this.resultsField != null) {
generator.writeKey("results_field");
generator.write(this.resultsField);
}
if (ApiTypeHelper.isDefined(this.classificationLabels)) {
generator.writeKey("classification_labels");
generator.writeStartArray();
for (String item0 : this.classificationLabels) {
generator.write(item0);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link TextClassificationInferenceOptions}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Integer numTopClasses;
@Nullable
private TokenizationConfig tokenization;
@Nullable
private String resultsField;
@Nullable
private List classificationLabels;
/**
* Specifies the number of top class predictions to return. Defaults to 0.
*
* API name: {@code num_top_classes}
*/
public final Builder numTopClasses(@Nullable Integer value) {
this.numTopClasses = value;
return this;
}
/**
* The tokenization options
*
* API name: {@code tokenization}
*/
public final Builder tokenization(@Nullable TokenizationConfig value) {
this.tokenization = value;
return this;
}
/**
* The tokenization options
*
* API name: {@code tokenization}
*/
public final Builder tokenization(Function> fn) {
return this.tokenization(fn.apply(new TokenizationConfig.Builder()).build());
}
/**
* The field that is added to incoming documents to contain the inference
* prediction. Defaults to predicted_value.
*
* API name: {@code results_field}
*/
public final Builder resultsField(@Nullable String value) {
this.resultsField = value;
return this;
}
/**
* Classification labels to apply other than the stored labels. Must have the
* same deminsions as the default configured labels
*
* API name: {@code classification_labels}
*
* Adds all elements of list to classificationLabels.
*/
public final Builder classificationLabels(List list) {
this.classificationLabels = _listAddAll(this.classificationLabels, list);
return this;
}
/**
* Classification labels to apply other than the stored labels. Must have the
* same deminsions as the default configured labels
*
* API name: {@code classification_labels}
*
* Adds one or more values to classificationLabels.
*/
public final Builder classificationLabels(String value, String... values) {
this.classificationLabels = _listAdd(this.classificationLabels, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link TextClassificationInferenceOptions}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public TextClassificationInferenceOptions build() {
_checkSingleUse();
return new TextClassificationInferenceOptions(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link TextClassificationInferenceOptions}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new,
TextClassificationInferenceOptions::setupTextClassificationInferenceOptionsDeserializer);
protected static void setupTextClassificationInferenceOptionsDeserializer(
ObjectDeserializer op) {
op.add(Builder::numTopClasses, JsonpDeserializer.integerDeserializer(), "num_top_classes");
op.add(Builder::tokenization, TokenizationConfig._DESERIALIZER, "tokenization");
op.add(Builder::resultsField, JsonpDeserializer.stringDeserializer(), "results_field");
op.add(Builder::classificationLabels,
JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "classification_labels");
}
}