co.elastic.clients.elasticsearch.inference.PutHuggingFaceRequest 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.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.Collections;
import java.util.HashMap;
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.put_hugging_face.Request
/**
* Create a Hugging Face inference endpoint.
*
* Create an inference endpoint to perform an inference task with the
* hugging_face service.
*
* You must first create an inference endpoint on the Hugging Face endpoint page
* to get an endpoint URL. Select the model you want to use on the new endpoint
* creation page (for example intfloat/e5-small-v2), then select
* the sentence embeddings task under the advanced configuration section. Create
* the endpoint and copy the URL after the endpoint initialization has been
* finished.
*
* The following models are recommended for the Hugging Face service:
*
* all-MiniLM-L6-v2all-MiniLM-L12-v2all-mpnet-base-v2e5-base-v2e5-small-v2multilingual-e5-basemultilingual-e5-small
*
* @see API
* specification
*/
@JsonpDeserializable
public class PutHuggingFaceRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final InferenceChunkingSettings chunkingSettings;
private final String huggingfaceInferenceId;
private final HuggingFaceServiceType service;
private final HuggingFaceServiceSettings serviceSettings;
private final HuggingFaceTaskType taskType;
// ---------------------------------------------------------------------------------------------
private PutHuggingFaceRequest(Builder builder) {
this.chunkingSettings = builder.chunkingSettings;
this.huggingfaceInferenceId = ApiTypeHelper.requireNonNull(builder.huggingfaceInferenceId, this,
"huggingfaceInferenceId");
this.service = ApiTypeHelper.requireNonNull(builder.service, this, "service");
this.serviceSettings = ApiTypeHelper.requireNonNull(builder.serviceSettings, this, "serviceSettings");
this.taskType = ApiTypeHelper.requireNonNull(builder.taskType, this, "taskType");
}
public static PutHuggingFaceRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The chunking configuration object.
*
* API name: {@code chunking_settings}
*/
@Nullable
public final InferenceChunkingSettings chunkingSettings() {
return this.chunkingSettings;
}
/**
* Required - The unique identifier of the inference endpoint.
*
* API name: {@code huggingface_inference_id}
*/
public final String huggingfaceInferenceId() {
return this.huggingfaceInferenceId;
}
/**
* Required - The type of service supported for the specified task type. In this
* case, hugging_face.
*
* API name: {@code service}
*/
public final HuggingFaceServiceType service() {
return this.service;
}
/**
* Required - Settings used to install the inference model. These settings are
* specific to the hugging_face service.
*
* API name: {@code service_settings}
*/
public final HuggingFaceServiceSettings serviceSettings() {
return this.serviceSettings;
}
/**
* Required - The type of the inference task that the model will perform.
*
* API name: {@code task_type}
*/
public final HuggingFaceTaskType taskType() {
return this.taskType;
}
/**
* 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.chunkingSettings != null) {
generator.writeKey("chunking_settings");
this.chunkingSettings.serialize(generator, mapper);
}
generator.writeKey("service");
this.service.serialize(generator, mapper);
generator.writeKey("service_settings");
this.serviceSettings.serialize(generator, mapper);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PutHuggingFaceRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private InferenceChunkingSettings chunkingSettings;
private String huggingfaceInferenceId;
private HuggingFaceServiceType service;
private HuggingFaceServiceSettings serviceSettings;
private HuggingFaceTaskType taskType;
/**
* The chunking configuration object.
*
* API name: {@code chunking_settings}
*/
public final Builder chunkingSettings(@Nullable InferenceChunkingSettings value) {
this.chunkingSettings = value;
return this;
}
/**
* The chunking configuration object.
*
* API name: {@code chunking_settings}
*/
public final Builder chunkingSettings(
Function> fn) {
return this.chunkingSettings(fn.apply(new InferenceChunkingSettings.Builder()).build());
}
/**
* Required - The unique identifier of the inference endpoint.
*
* API name: {@code huggingface_inference_id}
*/
public final Builder huggingfaceInferenceId(String value) {
this.huggingfaceInferenceId = value;
return this;
}
/**
* Required - The type of service supported for the specified task type. In this
* case, hugging_face.
*
* API name: {@code service}
*/
public final Builder service(HuggingFaceServiceType value) {
this.service = value;
return this;
}
/**
* Required - Settings used to install the inference model. These settings are
* specific to the hugging_face service.
*
* API name: {@code service_settings}
*/
public final Builder serviceSettings(HuggingFaceServiceSettings value) {
this.serviceSettings = value;
return this;
}
/**
* Required - Settings used to install the inference model. These settings are
* specific to the hugging_face service.
*
* API name: {@code service_settings}
*/
public final Builder serviceSettings(
Function> fn) {
return this.serviceSettings(fn.apply(new HuggingFaceServiceSettings.Builder()).build());
}
/**
* Required - The type of the inference task that the model will perform.
*
* API name: {@code task_type}
*/
public final Builder taskType(HuggingFaceTaskType value) {
this.taskType = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PutHuggingFaceRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PutHuggingFaceRequest build() {
_checkSingleUse();
return new PutHuggingFaceRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link PutHuggingFaceRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, PutHuggingFaceRequest::setupPutHuggingFaceRequestDeserializer);
protected static void setupPutHuggingFaceRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::chunkingSettings, InferenceChunkingSettings._DESERIALIZER, "chunking_settings");
op.add(Builder::service, HuggingFaceServiceType._DESERIALIZER, "service");
op.add(Builder::serviceSettings, HuggingFaceServiceSettings._DESERIALIZER, "service_settings");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code inference.put_hugging_face}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/inference.put_hugging_face",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _taskType = 1 << 0;
final int _huggingfaceInferenceId = 1 << 1;
int propsSet = 0;
propsSet |= _taskType;
propsSet |= _huggingfaceInferenceId;
if (propsSet == (_taskType | _huggingfaceInferenceId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_inference");
buf.append("/");
SimpleEndpoint.pathEncode(request.taskType.jsonValue(), buf);
buf.append("/");
SimpleEndpoint.pathEncode(request.huggingfaceInferenceId, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _taskType = 1 << 0;
final int _huggingfaceInferenceId = 1 << 1;
int propsSet = 0;
propsSet |= _taskType;
propsSet |= _huggingfaceInferenceId;
if (propsSet == (_taskType | _huggingfaceInferenceId)) {
params.put("taskType", request.taskType.jsonValue());
params.put("huggingfaceInferenceId", request.huggingfaceInferenceId);
}
return params;
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, PutHuggingFaceResponse._DESERIALIZER);
}