co.elastic.clients.elasticsearch.ml.InferTrainedModelRequest 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.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonData;
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.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.infer_trained_model.Request
/**
* Evaluate a trained model.
*
* @see API
* specification
*/
@JsonpDeserializable
public class InferTrainedModelRequest extends RequestBase implements JsonpSerializable {
private final List> docs;
@Nullable
private final InferenceConfigUpdate inferenceConfig;
private final String modelId;
@Nullable
private final Time timeout;
// ---------------------------------------------------------------------------------------------
private InferTrainedModelRequest(Builder builder) {
this.docs = ApiTypeHelper.unmodifiableRequired(builder.docs, this, "docs");
this.inferenceConfig = builder.inferenceConfig;
this.modelId = ApiTypeHelper.requireNonNull(builder.modelId, this, "modelId");
this.timeout = builder.timeout;
}
public static InferTrainedModelRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - An array of objects to pass to the model for inference. The
* objects should contain a fields matching your configured trained model input.
* Typically, for NLP models, the field name is text_field.
* Currently, for NLP models, only a single value is allowed.
*
* API name: {@code docs}
*/
public final List> docs() {
return this.docs;
}
/**
* The inference configuration updates to apply on the API call
*
* API name: {@code inference_config}
*/
@Nullable
public final InferenceConfigUpdate inferenceConfig() {
return this.inferenceConfig;
}
/**
* Required - The unique identifier of the trained model.
*
* API name: {@code model_id}
*/
public final String modelId() {
return this.modelId;
}
/**
* Controls the amount of time to wait for inference results.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* 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.docs)) {
generator.writeKey("docs");
generator.writeStartArray();
for (Map item0 : this.docs) {
generator.writeStartObject();
if (item0 != null) {
for (Map.Entry item1 : item0.entrySet()) {
generator.writeKey(item1.getKey());
item1.getValue().serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
if (this.inferenceConfig != null) {
generator.writeKey("inference_config");
this.inferenceConfig.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link InferTrainedModelRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
private List> docs;
@Nullable
private InferenceConfigUpdate inferenceConfig;
private String modelId;
@Nullable
private Time timeout;
/**
* Required - An array of objects to pass to the model for inference. The
* objects should contain a fields matching your configured trained model input.
* Typically, for NLP models, the field name is text_field.
* Currently, for NLP models, only a single value is allowed.
*
* API name: {@code docs}
*
* Adds all elements of list to docs.
*/
public final Builder docs(List> list) {
this.docs = _listAddAll(this.docs, list);
return this;
}
/**
* Required - An array of objects to pass to the model for inference. The
* objects should contain a fields matching your configured trained model input.
* Typically, for NLP models, the field name is text_field.
* Currently, for NLP models, only a single value is allowed.
*
* API name: {@code docs}
*
* Adds one or more values to docs.
*/
public final Builder docs(Map value, Map... values) {
this.docs = _listAdd(this.docs, value, values);
return this;
}
/**
* The inference configuration updates to apply on the API call
*
* API name: {@code inference_config}
*/
public final Builder inferenceConfig(@Nullable InferenceConfigUpdate value) {
this.inferenceConfig = value;
return this;
}
/**
* The inference configuration updates to apply on the API call
*
* API name: {@code inference_config}
*/
public final Builder inferenceConfig(
Function> fn) {
return this.inferenceConfig(fn.apply(new InferenceConfigUpdate.Builder()).build());
}
/**
* Required - The unique identifier of the trained model.
*
* API name: {@code model_id}
*/
public final Builder modelId(String value) {
this.modelId = value;
return this;
}
/**
* Controls the amount of time to wait for inference results.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Controls the amount of time to wait for inference results.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link InferTrainedModelRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public InferTrainedModelRequest build() {
_checkSingleUse();
return new InferTrainedModelRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link InferTrainedModelRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, InferTrainedModelRequest::setupInferTrainedModelRequestDeserializer);
protected static void setupInferTrainedModelRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::docs,
JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER)),
"docs");
op.add(Builder::inferenceConfig, InferenceConfigUpdate._DESERIALIZER, "inference_config");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.infer_trained_model}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.infer_trained_model",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _modelId = 1 << 0;
int propsSet = 0;
propsSet |= _modelId;
if (propsSet == (_modelId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/trained_models");
buf.append("/");
SimpleEndpoint.pathEncode(request.modelId, buf);
buf.append("/_infer");
return buf.toString();
}
if (propsSet == (_modelId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/trained_models");
buf.append("/");
SimpleEndpoint.pathEncode(request.modelId, buf);
buf.append("/deployment");
buf.append("/_infer");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _modelId = 1 << 0;
int propsSet = 0;
propsSet |= _modelId;
if (propsSet == (_modelId)) {
params.put("modelId", request.modelId);
}
if (propsSet == (_modelId)) {
params.put("modelId", request.modelId);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), true, InferTrainedModelResponse._DESERIALIZER);
}