co.elastic.clients.elasticsearch.inference.Message 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.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.Message
/**
* An object representing part of the conversation.
*
* @see API
* specification
*/
@JsonpDeserializable
public class Message implements JsonpSerializable {
@Nullable
private final MessageContent content;
private final String role;
@Nullable
private final String toolCallId;
private final List toolCalls;
// ---------------------------------------------------------------------------------------------
private Message(Builder builder) {
this.content = builder.content;
this.role = ApiTypeHelper.requireNonNull(builder.role, this, "role");
this.toolCallId = builder.toolCallId;
this.toolCalls = ApiTypeHelper.unmodifiable(builder.toolCalls);
}
public static Message of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The content of the message.
*
* String example:
*
*
* {
* "content": "Some string"
* }
*
*
*
* Object example:
*
*
* {
* "content": [
* {
* "text": "Some text",
* "type": "text"
* }
* ]
* }
*
*
*
* API name: {@code content}
*/
@Nullable
public final MessageContent content() {
return this.content;
}
/**
* Required - The role of the message author. Valid values are
* user, assistant, system, and
* tool.
*
* API name: {@code role}
*/
public final String role() {
return this.role;
}
/**
* Only for tool role messages. The tool call that this message is
* responding to.
*
* API name: {@code tool_call_id}
*/
@Nullable
public final String toolCallId() {
return this.toolCallId;
}
/**
* Only for assistant role messages. The tool calls generated by
* the model. If it's specified, the content field is optional.
* Example:
*
*
* {
* "tool_calls": [
* {
* "id": "call_KcAjWtAww20AihPHphUh46Gd",
* "type": "function",
* "function": {
* "name": "get_current_weather",
* "arguments": "{\"location\":\"Boston, MA\"}"
* }
* }
* ]
* }
*
*
*
* API name: {@code tool_calls}
*/
public final List toolCalls() {
return this.toolCalls;
}
/**
* 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.content != null) {
generator.writeKey("content");
this.content.serialize(generator, mapper);
}
generator.writeKey("role");
generator.write(this.role);
if (this.toolCallId != null) {
generator.writeKey("tool_call_id");
generator.write(this.toolCallId);
}
if (ApiTypeHelper.isDefined(this.toolCalls)) {
generator.writeKey("tool_calls");
generator.writeStartArray();
for (ToolCall item0 : this.toolCalls) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Message}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private MessageContent content;
private String role;
@Nullable
private String toolCallId;
@Nullable
private List toolCalls;
/**
* The content of the message.
*
* String example:
*
*
* {
* "content": "Some string"
* }
*
*
*
* Object example:
*
*
* {
* "content": [
* {
* "text": "Some text",
* "type": "text"
* }
* ]
* }
*
*
*
* API name: {@code content}
*/
public final Builder content(@Nullable MessageContent value) {
this.content = value;
return this;
}
/**
* The content of the message.
*
* String example:
*
*
* {
* "content": "Some string"
* }
*
*
*
* Object example:
*
*
* {
* "content": [
* {
* "text": "Some text",
* "type": "text"
* }
* ]
* }
*
*
*
* API name: {@code content}
*/
public final Builder content(Function> fn) {
return this.content(fn.apply(new MessageContent.Builder()).build());
}
/**
* Required - The role of the message author. Valid values are
* user, assistant, system, and
* tool.
*
* API name: {@code role}
*/
public final Builder role(String value) {
this.role = value;
return this;
}
/**
* Only for tool role messages. The tool call that this message is
* responding to.
*
* API name: {@code tool_call_id}
*/
public final Builder toolCallId(@Nullable String value) {
this.toolCallId = value;
return this;
}
/**
* Only for assistant role messages. The tool calls generated by
* the model. If it's specified, the content field is optional.
* Example:
*
*
* {
* "tool_calls": [
* {
* "id": "call_KcAjWtAww20AihPHphUh46Gd",
* "type": "function",
* "function": {
* "name": "get_current_weather",
* "arguments": "{\"location\":\"Boston, MA\"}"
* }
* }
* ]
* }
*
*
*
* API name: {@code tool_calls}
*
* Adds all elements of list to toolCalls.
*/
public final Builder toolCalls(List list) {
this.toolCalls = _listAddAll(this.toolCalls, list);
return this;
}
/**
* Only for assistant role messages. The tool calls generated by
* the model. If it's specified, the content field is optional.
* Example:
*
*
* {
* "tool_calls": [
* {
* "id": "call_KcAjWtAww20AihPHphUh46Gd",
* "type": "function",
* "function": {
* "name": "get_current_weather",
* "arguments": "{\"location\":\"Boston, MA\"}"
* }
* }
* ]
* }
*
*
*
* API name: {@code tool_calls}
*
* Adds one or more values to toolCalls.
*/
public final Builder toolCalls(ToolCall value, ToolCall... values) {
this.toolCalls = _listAdd(this.toolCalls, value, values);
return this;
}
/**
* Only for assistant role messages. The tool calls generated by
* the model. If it's specified, the content field is optional.
* Example:
*
*
* {
* "tool_calls": [
* {
* "id": "call_KcAjWtAww20AihPHphUh46Gd",
* "type": "function",
* "function": {
* "name": "get_current_weather",
* "arguments": "{\"location\":\"Boston, MA\"}"
* }
* }
* ]
* }
*
*
*
* API name: {@code tool_calls}
*
* Adds a value to toolCalls using a builder lambda.
*/
public final Builder toolCalls(Function> fn) {
return toolCalls(fn.apply(new ToolCall.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Message}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Message build() {
_checkSingleUse();
return new Message(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Message}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Message::setupMessageDeserializer);
protected static void setupMessageDeserializer(ObjectDeserializer op) {
op.add(Builder::content, MessageContent._DESERIALIZER, "content");
op.add(Builder::role, JsonpDeserializer.stringDeserializer(), "role");
op.add(Builder::toolCallId, JsonpDeserializer.stringDeserializer(), "tool_call_id");
op.add(Builder::toolCalls, JsonpDeserializer.arrayDeserializer(ToolCall._DESERIALIZER), "tool_calls");
}
}