co.elastic.clients.elasticsearch.inference.RequestChatCompletion 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.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.Float;
import java.lang.Long;
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: inference._types.RequestChatCompletion
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class RequestChatCompletion implements JsonpSerializable {
private final List messages;
@Nullable
private final String model;
@Nullable
private final Long maxCompletionTokens;
private final List stop;
@Nullable
private final Float temperature;
@Nullable
private final CompletionToolType toolChoice;
private final List tools;
@Nullable
private final Float topP;
// ---------------------------------------------------------------------------------------------
private RequestChatCompletion(Builder builder) {
this.messages = ApiTypeHelper.unmodifiableRequired(builder.messages, this, "messages");
this.model = builder.model;
this.maxCompletionTokens = builder.maxCompletionTokens;
this.stop = ApiTypeHelper.unmodifiable(builder.stop);
this.temperature = builder.temperature;
this.toolChoice = builder.toolChoice;
this.tools = ApiTypeHelper.unmodifiable(builder.tools);
this.topP = builder.topP;
}
public static RequestChatCompletion of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - A list of objects representing the conversation. Requests should
* generally only add new messages from the user (role user). The
* other message roles (assistant, system, or
* tool) should generally only be copied from the response to a
* previous completion request, such that the messages array is built up
* throughout a conversation.
*
* API name: {@code messages}
*/
public final List messages() {
return this.messages;
}
/**
* The ID of the model to use.
*
* API name: {@code model}
*/
@Nullable
public final String model() {
return this.model;
}
/**
* The upper bound limit for the number of tokens that can be generated for a
* completion request.
*
* API name: {@code max_completion_tokens}
*/
@Nullable
public final Long maxCompletionTokens() {
return this.maxCompletionTokens;
}
/**
* A sequence of strings to control when the model should stop generating
* additional tokens.
*
* API name: {@code stop}
*/
public final List stop() {
return this.stop;
}
/**
* The sampling temperature to use.
*
* API name: {@code temperature}
*/
@Nullable
public final Float temperature() {
return this.temperature;
}
/**
* Controls which tool is called by the model. String representation: One of
* auto, none, or requrired.
* auto allows the model to choose between calling tools and
* generating a message. none causes the model to not call any
* tools. required forces the model to call one or more tools.
* Example (object representation):
*
*
* {
* "tool_choice": {
* "type": "function",
* "function": {
* "name": "get_current_weather"
* }
* }
* }
*
*
*
* API name: {@code tool_choice}
*/
@Nullable
public final CompletionToolType toolChoice() {
return this.toolChoice;
}
/**
* A list of tools that the model can call. Example:
*
*
* {
* "tools": [
* {
* "type": "function",
* "function": {
* "name": "get_price_of_item",
* "description": "Get the current price of an item",
* "parameters": {
* "type": "object",
* "properties": {
* "item": {
* "id": "12345"
* },
* "unit": {
* "type": "currency"
* }
* }
* }
* }
* }
* ]
* }
*
*
*
* API name: {@code tools}
*/
public final List tools() {
return this.tools;
}
/**
* Nucleus sampling, an alternative to sampling with temperature.
*
* API name: {@code top_p}
*/
@Nullable
public final Float topP() {
return this.topP;
}
/**
* 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.messages)) {
generator.writeKey("messages");
generator.writeStartArray();
for (Message item0 : this.messages) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.model != null) {
generator.writeKey("model");
generator.write(this.model);
}
if (this.maxCompletionTokens != null) {
generator.writeKey("max_completion_tokens");
generator.write(this.maxCompletionTokens);
}
if (ApiTypeHelper.isDefined(this.stop)) {
generator.writeKey("stop");
generator.writeStartArray();
for (String item0 : this.stop) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.temperature != null) {
generator.writeKey("temperature");
generator.write(this.temperature);
}
if (this.toolChoice != null) {
generator.writeKey("tool_choice");
this.toolChoice.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.tools)) {
generator.writeKey("tools");
generator.writeStartArray();
for (CompletionTool item0 : this.tools) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.topP != null) {
generator.writeKey("top_p");
generator.write(this.topP);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link RequestChatCompletion}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private List messages;
@Nullable
private String model;
@Nullable
private Long maxCompletionTokens;
@Nullable
private List stop;
@Nullable
private Float temperature;
@Nullable
private CompletionToolType toolChoice;
@Nullable
private List tools;
@Nullable
private Float topP;
/**
* Required - A list of objects representing the conversation. Requests should
* generally only add new messages from the user (role user). The
* other message roles (assistant, system, or
* tool) should generally only be copied from the response to a
* previous completion request, such that the messages array is built up
* throughout a conversation.
*
* API name: {@code messages}
*
* Adds all elements of list to messages.
*/
public final Builder messages(List list) {
this.messages = _listAddAll(this.messages, list);
return this;
}
/**
* Required - A list of objects representing the conversation. Requests should
* generally only add new messages from the user (role user). The
* other message roles (assistant, system, or
* tool) should generally only be copied from the response to a
* previous completion request, such that the messages array is built up
* throughout a conversation.
*
* API name: {@code messages}
*
* Adds one or more values to messages.
*/
public final Builder messages(Message value, Message... values) {
this.messages = _listAdd(this.messages, value, values);
return this;
}
/**
* Required - A list of objects representing the conversation. Requests should
* generally only add new messages from the user (role user). The
* other message roles (assistant, system, or
* tool) should generally only be copied from the response to a
* previous completion request, such that the messages array is built up
* throughout a conversation.
*
* API name: {@code messages}
*
* Adds a value to messages using a builder lambda.
*/
public final Builder messages(Function> fn) {
return messages(fn.apply(new Message.Builder()).build());
}
/**
* The ID of the model to use.
*
* API name: {@code model}
*/
public final Builder model(@Nullable String value) {
this.model = value;
return this;
}
/**
* The upper bound limit for the number of tokens that can be generated for a
* completion request.
*
* API name: {@code max_completion_tokens}
*/
public final Builder maxCompletionTokens(@Nullable Long value) {
this.maxCompletionTokens = value;
return this;
}
/**
* A sequence of strings to control when the model should stop generating
* additional tokens.
*
* API name: {@code stop}
*
* Adds all elements of list to stop.
*/
public final Builder stop(List list) {
this.stop = _listAddAll(this.stop, list);
return this;
}
/**
* A sequence of strings to control when the model should stop generating
* additional tokens.
*
* API name: {@code stop}
*
* Adds one or more values to stop.
*/
public final Builder stop(String value, String... values) {
this.stop = _listAdd(this.stop, value, values);
return this;
}
/**
* The sampling temperature to use.
*
* API name: {@code temperature}
*/
public final Builder temperature(@Nullable Float value) {
this.temperature = value;
return this;
}
/**
* Controls which tool is called by the model. String representation: One of
* auto, none, or requrired.
* auto allows the model to choose between calling tools and
* generating a message. none causes the model to not call any
* tools. required forces the model to call one or more tools.
* Example (object representation):
*
*
* {
* "tool_choice": {
* "type": "function",
* "function": {
* "name": "get_current_weather"
* }
* }
* }
*
*
*
* API name: {@code tool_choice}
*/
public final Builder toolChoice(@Nullable CompletionToolType value) {
this.toolChoice = value;
return this;
}
/**
* Controls which tool is called by the model. String representation: One of
* auto, none, or requrired.
* auto allows the model to choose between calling tools and
* generating a message. none causes the model to not call any
* tools. required forces the model to call one or more tools.
* Example (object representation):
*
*
* {
* "tool_choice": {
* "type": "function",
* "function": {
* "name": "get_current_weather"
* }
* }
* }
*
*
*
* API name: {@code tool_choice}
*/
public final Builder toolChoice(Function> fn) {
return this.toolChoice(fn.apply(new CompletionToolType.Builder()).build());
}
/**
* A list of tools that the model can call. Example:
*
*
* {
* "tools": [
* {
* "type": "function",
* "function": {
* "name": "get_price_of_item",
* "description": "Get the current price of an item",
* "parameters": {
* "type": "object",
* "properties": {
* "item": {
* "id": "12345"
* },
* "unit": {
* "type": "currency"
* }
* }
* }
* }
* }
* ]
* }
*
*
*
* API name: {@code tools}
*
* Adds all elements of list to tools.
*/
public final Builder tools(List list) {
this.tools = _listAddAll(this.tools, list);
return this;
}
/**
* A list of tools that the model can call. Example:
*
*
* {
* "tools": [
* {
* "type": "function",
* "function": {
* "name": "get_price_of_item",
* "description": "Get the current price of an item",
* "parameters": {
* "type": "object",
* "properties": {
* "item": {
* "id": "12345"
* },
* "unit": {
* "type": "currency"
* }
* }
* }
* }
* }
* ]
* }
*
*
*
* API name: {@code tools}
*
* Adds one or more values to tools.
*/
public final Builder tools(CompletionTool value, CompletionTool... values) {
this.tools = _listAdd(this.tools, value, values);
return this;
}
/**
* A list of tools that the model can call. Example:
*
*
* {
* "tools": [
* {
* "type": "function",
* "function": {
* "name": "get_price_of_item",
* "description": "Get the current price of an item",
* "parameters": {
* "type": "object",
* "properties": {
* "item": {
* "id": "12345"
* },
* "unit": {
* "type": "currency"
* }
* }
* }
* }
* }
* ]
* }
*
*
*
* API name: {@code tools}
*
* Adds a value to tools using a builder lambda.
*/
public final Builder tools(Function> fn) {
return tools(fn.apply(new CompletionTool.Builder()).build());
}
/**
* Nucleus sampling, an alternative to sampling with temperature.
*
* API name: {@code top_p}
*/
public final Builder topP(@Nullable Float value) {
this.topP = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link RequestChatCompletion}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public RequestChatCompletion build() {
_checkSingleUse();
return new RequestChatCompletion(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link RequestChatCompletion}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, RequestChatCompletion::setupRequestChatCompletionDeserializer);
protected static void setupRequestChatCompletionDeserializer(ObjectDeserializer op) {
op.add(Builder::messages, JsonpDeserializer.arrayDeserializer(Message._DESERIALIZER), "messages");
op.add(Builder::model, JsonpDeserializer.stringDeserializer(), "model");
op.add(Builder::maxCompletionTokens, JsonpDeserializer.longDeserializer(), "max_completion_tokens");
op.add(Builder::stop, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "stop");
op.add(Builder::temperature, JsonpDeserializer.floatDeserializer(), "temperature");
op.add(Builder::toolChoice, CompletionToolType._DESERIALIZER, "tool_choice");
op.add(Builder::tools, JsonpDeserializer.arrayDeserializer(CompletionTool._DESERIALIZER), "tools");
op.add(Builder::topP, JsonpDeserializer.floatDeserializer(), "top_p");
}
}