Package co.elastic.clients.elasticsearch.inference

Class ChatCompletionUnifiedRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.inference.ChatCompletionUnifiedRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ChatCompletionUnifiedRequest
extends RequestBase
implements JsonpSerializable

Perform chat completion inference

The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the chat_completion task type for openai and elastic inference services.

NOTE: The chat_completion task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the openai, hugging_face or the elastic service, use the Chat completion inference API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatCompletionUnifiedRequest.Builder	Builder for ChatCompletionUnifiedRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ChatCompletionUnifiedRequest>	_DESERIALIZER
static final Endpoint<ChatCompletionUnifiedRequest,BinaryResponse,ErrorResponse>	_ENDPOINT	Endpoint "inference.chat_completion_unified".

Method Summary

Modifier and Type	Method	Description
final RequestChatCompletion	chatCompletionRequest()	Required - Request body.
protected static JsonpDeserializer<ChatCompletionUnifiedRequest>	createChatCompletionUnifiedRequestDeserializer()
final String	inferenceId()	Required - The inference Id
static ChatCompletionUnifiedRequest	of(Function<ChatCompletionUnifiedRequest.Builder,ObjectBuilder<ChatCompletionUnifiedRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final Time	timeout()	Specifies the amount of time to wait for the inference request to complete.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ChatCompletionUnifiedRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<ChatCompletionUnifiedRequest,BinaryResponse,ErrorResponse> _ENDPOINT

Endpoint "inference.chat_completion_unified".

Method Details

of

public static ChatCompletionUnifiedRequest of(Function<ChatCompletionUnifiedRequest.Builder,ObjectBuilder<ChatCompletionUnifiedRequest>> fn)

inferenceId

public final String inferenceId()

Required - The inference Id

API name: inference_id

timeout

@Nullable
public final Time timeout()

Specifies the amount of time to wait for the inference request to complete.

API name: timeout

chatCompletionRequest

public final RequestChatCompletion chatCompletionRequest()

Required - Request body.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createChatCompletionUnifiedRequestDeserializer

protected static JsonpDeserializer<ChatCompletionUnifiedRequest> createChatCompletionUnifiedRequestDeserializer()