Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class UnifiedCompletionRequest

java.lang.Object

java.lang.Record

org.elasticsearch.inference.UnifiedCompletionRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public record UnifiedCompletionRequest(List<Message> messages, String model, Long maxCompletionTokens, List<String> stop, Float temperature, ToolChoice toolChoice, List<Tool> tools, Float topP, Reasoning reasoning)
extends Record
implements Writeable, ToXContentFragment

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_STREAM_OPTIONS_PARAM	Indicates whether to include the `stream_options` field in the JSON output.
static final ConstructingObjectParser<UnifiedCompletionRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UnifiedCompletionRequest(List<Message> messages, String model, Long maxCompletionTokens, List<String> stop, Float temperature, ToolChoice toolChoice, List<Tool> tools, Float top)
UnifiedCompletionRequest(List<Message> messages, String model, Long maxCompletionTokens, List<String> stop, Float temperature, ToolChoice toolChoice, List<Tool> tools, Float topP, Reasoning reasoning)	Creates an instance of a UnifiedCompletionRequest record class.
UnifiedCompletionRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	containsChatCompletionReasoning()
boolean	containsMultimodalContent()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static List<NamedWriteableRegistry.Entry>	getNamedWriteables()
final int	hashCode()	Returns a hash code value for this object.
Long	maxCompletionTokens()	Returns the value of the maxCompletionTokens record component.
List<Message>	messages()	Returns the value of the messages record component.
String	model()	Returns the value of the model record component.
static UnifiedCompletionRequest	of(List<Message> messages)
Reasoning	reasoning()	Returns the value of the reasoning record component.
List<String>	stop()	Returns the value of the stop record component.
Float	temperature()	Returns the value of the temperature record component.
ToolChoice	toolChoice()	Returns the value of the toolChoice record component.
List<Tool>	tools()	Returns the value of the tools record component.
Float	topP()	Returns the value of the topP record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static ToXContent.Params	withMaxCompletionTokens(String modelId, ToXContent.Params params)	Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId - Key: UnifiedCompletionUtils.MAX_COMPLETION_TOKENS_FIELD, Value: maxCompletionTokens()
static ToXContent.Params	withMaxCompletionTokens(ToXContent.Params params)	Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MAX_COMPLETION_TOKENS_FIELD, Value: maxCompletionTokens()
static ToXContent.Params	withMaxTokens(String modelId, ToXContent.Params params)	Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId, if modelId is not null - Key: UnifiedCompletionUtils.MAX_TOKENS_FIELD, Value: maxCompletionTokens()
static ToXContent.Params	withMaxTokensAndSkipStreamOptionsField(String modelId, ToXContent.Params params)	Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId, if modelId is not null - Key: UnifiedCompletionUtils.MAX_TOKENS_FIELD, Value: maxCompletionTokens() - Key: INCLUDE_STREAM_OPTIONS_PARAM, Value: "false"
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

INCLUDE_STREAM_OPTIONS_PARAM

public static final String INCLUDE_STREAM_OPTIONS_PARAM

Indicates whether to include the `stream_options` field in the JSON output. Some providers do not support this field. In such cases, this parameter should be set to "false", and the `stream_options` field will be excluded from the output. For providers that do support stream options, this parameter is left unset (default behavior), which implicitly includes the `stream_options` field in the output.

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<UnifiedCompletionRequest,Void> PARSER

Constructor Details

UnifiedCompletionRequest

public UnifiedCompletionRequest(List<Message> messages,
 @Nullable
 String model,
 @Nullable
 Long maxCompletionTokens,
 @Nullable
 List<String> stop,
 @Nullable
 Float temperature,
 @Nullable
 ToolChoice toolChoice,
 @Nullable
 List<Tool> tools,
 @Nullable
 Float top)

UnifiedCompletionRequest

public UnifiedCompletionRequest(StreamInput in)
                         throws IOException

Throws:

IOException

UnifiedCompletionRequest

public UnifiedCompletionRequest(List<Message> messages,
 @Nullable
 String model,
 @Nullable
 Long maxCompletionTokens,
 @Nullable
 List<String> stop,
 @Nullable
 Float temperature,
 @Nullable
 ToolChoice toolChoice,
 @Nullable
 List<Tool> tools,
 @Nullable
 Float topP,
 @Nullable
 Reasoning reasoning)

Creates an instance of a UnifiedCompletionRequest record class.

Parameters:

messages - the value for the messages record component

model - the value for the model record component

maxCompletionTokens - the value for the maxCompletionTokens record component

stop - the value for the stop record component

temperature - the value for the temperature record component

toolChoice - the value for the toolChoice record component

tools - the value for the tools record component

topP - the value for the topP record component

reasoning - the value for the reasoning record component

Method Details

withMaxTokens

public static ToXContent.Params withMaxTokens(@Nullable
 String modelId,
 ToXContent.Params params)

Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId, if modelId is not null - Key: UnifiedCompletionUtils.MAX_TOKENS_FIELD, Value: maxCompletionTokens()

withMaxTokensAndSkipStreamOptionsField

public static ToXContent.Params withMaxTokensAndSkipStreamOptionsField(@Nullable
 String modelId,
 ToXContent.Params params)

Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId, if modelId is not null - Key: UnifiedCompletionUtils.MAX_TOKENS_FIELD, Value: maxCompletionTokens() - Key: INCLUDE_STREAM_OPTIONS_PARAM, Value: "false"

withMaxCompletionTokens

public static ToXContent.Params withMaxCompletionTokens(String modelId,
 ToXContent.Params params)

Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MODEL_FIELD, Value: modelId - Key: UnifiedCompletionUtils.MAX_COMPLETION_TOKENS_FIELD, Value: maxCompletionTokens()

withMaxCompletionTokens

public static ToXContent.Params withMaxCompletionTokens(ToXContent.Params params)

Creates a ToXContent.Params that causes ToXContent to include the key values: - Key: UnifiedCompletionUtils.MAX_COMPLETION_TOKENS_FIELD, Value: maxCompletionTokens()

getNamedWriteables

public static List<NamedWriteableRegistry.Entry> getNamedWriteables()

of

public static UnifiedCompletionRequest of(List<Message> messages)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

containsMultimodalContent

public boolean containsMultimodalContent()

containsChatCompletionReasoning

public boolean containsChatCompletionReasoning()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

messages

public List<Message> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component

model

@Nullable
public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

maxCompletionTokens

@Nullable
public Long maxCompletionTokens()

Returns the value of the maxCompletionTokens record component.

Returns:

the value of the maxCompletionTokens record component

stop

@Nullable
public List<String> stop()

Returns the value of the stop record component.

Returns:

the value of the stop record component

temperature

@Nullable
public Float temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

toolChoice

@Nullable
public ToolChoice toolChoice()

Returns the value of the toolChoice record component.

Returns:

the value of the toolChoice record component

tools

@Nullable
public List<Tool> tools()

Returns the value of the tools record component.

Returns:

the value of the tools record component

topP

@Nullable
public Float topP()

Returns the value of the topP record component.

Returns:

the value of the topP record component

reasoning

@Nullable
public Reasoning reasoning()

Returns the value of the reasoning record component.

Returns:

the value of the reasoning record component