Package co.elastic.clients.elasticsearch.inference

Class RequestChatCompletion.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<RequestChatCompletion.Builder>

co.elastic.clients.elasticsearch.inference.RequestChatCompletion.Builder

All Implemented Interfaces:

WithJson<RequestChatCompletion.Builder>, ObjectBuilder<RequestChatCompletion>

Enclosing class:

RequestChatCompletion

public static class RequestChatCompletion.Builder
extends WithJsonObjectBuilderBase<RequestChatCompletion.Builder>
implements ObjectBuilder<RequestChatCompletion>

Builder for RequestChatCompletion.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RequestChatCompletion	build()	Builds a RequestChatCompletion.
final RequestChatCompletion.Builder	maxCompletionTokens(Long value)	The upper bound limit for the number of tokens that can be generated for a completion request.
final RequestChatCompletion.Builder	messages(Message value, Message... values)	Required - A list of objects representing the conversation.
final RequestChatCompletion.Builder	messages(Function<Message.Builder,ObjectBuilder<Message>> fn)	Required - A list of objects representing the conversation.
final RequestChatCompletion.Builder	messages(List<Message> list)	Required - A list of objects representing the conversation.
final RequestChatCompletion.Builder	model(String value)	The ID of the model to use.
protected RequestChatCompletion.Builder	self()
final RequestChatCompletion.Builder	stop(String value, String... values)	A sequence of strings to control when the model should stop generating additional tokens.
final RequestChatCompletion.Builder	stop(List<String> list)	A sequence of strings to control when the model should stop generating additional tokens.
final RequestChatCompletion.Builder	temperature(Float value)	The sampling temperature to use.
final RequestChatCompletion.Builder	toolChoice(CompletionToolType value)	Controls which tool is called by the model.
final RequestChatCompletion.Builder	toolChoice(Function<CompletionToolType.Builder,ObjectBuilder<CompletionToolType>> fn)	Controls which tool is called by the model.
final RequestChatCompletion.Builder	tools(CompletionTool value, CompletionTool... values)	A list of tools that the model can call.
final RequestChatCompletion.Builder	tools(Function<CompletionTool.Builder,ObjectBuilder<CompletionTool>> fn)	A list of tools that the model can call.
final RequestChatCompletion.Builder	tools(List<CompletionTool> list)	A list of tools that the model can call.
final RequestChatCompletion.Builder	topP(Float value)	Nucleus sampling, an alternative to sampling with temperature.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

messages

public final RequestChatCompletion.Builder messages(List<Message> list)

Required - A list of objects representing the conversation.

API name: messages

Adds all elements of list to messages.

messages

public final RequestChatCompletion.Builder messages(Message value,
 Message... values)

Required - A list of objects representing the conversation.

API name: messages

Adds one or more values to messages.

messages

public final RequestChatCompletion.Builder messages(Function<Message.Builder,ObjectBuilder<Message>> fn)

Required - A list of objects representing the conversation.

API name: messages

Adds a value to messages using a builder lambda.

model

public final RequestChatCompletion.Builder model(@Nullable
 String value)

The ID of the model to use.

API name: model

maxCompletionTokens

public final RequestChatCompletion.Builder maxCompletionTokens(@Nullable
 Long value)

The upper bound limit for the number of tokens that can be generated for a completion request.

API name: max_completion_tokens

stop

public final RequestChatCompletion.Builder stop(List<String> list)

A sequence of strings to control when the model should stop generating additional tokens.

API name: stop

Adds all elements of list to stop.

stop

public final RequestChatCompletion.Builder stop(String value,
 String... values)

A sequence of strings to control when the model should stop generating additional tokens.

API name: stop

Adds one or more values to stop.

temperature

public final RequestChatCompletion.Builder temperature(@Nullable
 Float value)

The sampling temperature to use.

API name: temperature

toolChoice

public final RequestChatCompletion.Builder toolChoice(@Nullable
 CompletionToolType value)

Controls which tool is called by the model.

API name: tool_choice

toolChoice

public final RequestChatCompletion.Builder toolChoice(Function<CompletionToolType.Builder,ObjectBuilder<CompletionToolType>> fn)

Controls which tool is called by the model.

API name: tool_choice

tools

public final RequestChatCompletion.Builder tools(List<CompletionTool> list)

A list of tools that the model can call.

API name: tools

Adds all elements of list to tools.

tools

public final RequestChatCompletion.Builder tools(CompletionTool value,
 CompletionTool... values)

A list of tools that the model can call.

API name: tools

Adds one or more values to tools.

tools

public final RequestChatCompletion.Builder tools(Function<CompletionTool.Builder,ObjectBuilder<CompletionTool>> fn)

A list of tools that the model can call.

API name: tools

Adds a value to tools using a builder lambda.

topP

public final RequestChatCompletion.Builder topP(@Nullable
 Float value)

Nucleus sampling, an alternative to sampling with temperature.

API name: top_p

self

protected RequestChatCompletion.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<RequestChatCompletion.Builder>

build

public RequestChatCompletion build()

Builds a RequestChatCompletion.

Specified by:

build in interface ObjectBuilder<RequestChatCompletion>

Throws:

NullPointerException - if some of the required fields are null.