co.elastic.clients.elasticsearch.inference.StreamCompletionRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.inference;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
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.BinaryEndpoint;
import co.elastic.clients.transport.endpoints.BinaryResponse;
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.Collections;
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: inference.stream_completion.Request
/**
* Perform streaming inference. Get real-time responses for completion tasks by
* delivering answers incrementally, reducing response times during computation.
* This API works only with the completion task type.
*
* IMPORTANT: The inference APIs enable you to use certain services, such as
* built-in machine learning models (ELSER, E5), models uploaded through Eland,
* Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic,
* Watsonx.ai, or Hugging Face. For built-in models and models uploaded through
* Eland, the inference APIs offer an alternative way to use and manage trained
* models. However, if you do not plan to use the inference APIs to use these
* models or if you want to use non-NLP models, use the machine learning trained
* model APIs.
*
* This API requires the monitor_inference cluster privilege (the
* built-in inference_admin and inference_user roles
* grant this privilege). You must use a client that supports streaming.
*
* @see API
* specification
*/
@JsonpDeserializable
public class StreamCompletionRequest extends RequestBase implements JsonpSerializable {
private final String inferenceId;
private final List input;
@Nullable
private final JsonData taskSettings;
// ---------------------------------------------------------------------------------------------
private StreamCompletionRequest(Builder builder) {
this.inferenceId = ApiTypeHelper.requireNonNull(builder.inferenceId, this, "inferenceId");
this.input = ApiTypeHelper.unmodifiableRequired(builder.input, this, "input");
this.taskSettings = builder.taskSettings;
}
public static StreamCompletionRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The unique identifier for the inference endpoint.
*
* API name: {@code inference_id}
*/
public final String inferenceId() {
return this.inferenceId;
}
/**
* Required - The text on which you want to perform the inference task. It can
* be a single string or an array.
*
* NOTE: Inference endpoints for the completion task type currently only support
* a single string as input.
*
* API name: {@code input}
*/
public final List input() {
return this.input;
}
/**
* Optional task settings
*
* API name: {@code task_settings}
*/
@Nullable
public final JsonData taskSettings() {
return this.taskSettings;
}
/**
* 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.input)) {
generator.writeKey("input");
generator.writeStartArray();
for (String item0 : this.input) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.taskSettings != null) {
generator.writeKey("task_settings");
this.taskSettings.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link StreamCompletionRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
private String inferenceId;
private List input;
@Nullable
private JsonData taskSettings;
/**
* Required - The unique identifier for the inference endpoint.
*
* API name: {@code inference_id}
*/
public final Builder inferenceId(String value) {
this.inferenceId = value;
return this;
}
/**
* Required - The text on which you want to perform the inference task. It can
* be a single string or an array.
*
* NOTE: Inference endpoints for the completion task type currently only support
* a single string as input.
*
* API name: {@code input}
*
* Adds all elements of list to input.
*/
public final Builder input(List list) {
this.input = _listAddAll(this.input, list);
return this;
}
/**
* Required - The text on which you want to perform the inference task. It can
* be a single string or an array.
*
* NOTE: Inference endpoints for the completion task type currently only support
* a single string as input.
*
* API name: {@code input}
*
* Adds one or more values to input.
*/
public final Builder input(String value, String... values) {
this.input = _listAdd(this.input, value, values);
return this;
}
/**
* Optional task settings
*
* API name: {@code task_settings}
*/
public final Builder taskSettings(@Nullable JsonData value) {
this.taskSettings = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link StreamCompletionRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public StreamCompletionRequest build() {
_checkSingleUse();
return new StreamCompletionRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link StreamCompletionRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, StreamCompletionRequest::setupStreamCompletionRequestDeserializer);
protected static void setupStreamCompletionRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::input, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "input");
op.add(Builder::taskSettings, JsonData._DESERIALIZER, "task_settings");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code inference.stream_completion}".
*/
public static final Endpoint _ENDPOINT = new BinaryEndpoint<>(
"es/inference.stream_completion",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _inferenceId = 1 << 0;
int propsSet = 0;
propsSet |= _inferenceId;
if (propsSet == (_inferenceId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_inference");
buf.append("/completion");
buf.append("/");
SimpleEndpoint.pathEncode(request.inferenceId, buf);
buf.append("/_stream");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _inferenceId = 1 << 0;
int propsSet = 0;
propsSet |= _inferenceId;
if (propsSet == (_inferenceId)) {
params.put("inferenceId", request.inferenceId);
}
return params;
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, null);
}