Module org.elasticsearch.server

Package org.elasticsearch.inference.completion

Record Class Message

java.lang.Object

java.lang.Record

org.elasticsearch.inference.completion.Message

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public record Message(Content content, String role, String toolCallId, List<ToolCall> toolCalls, String reasoning, List<ReasoningDetail> reasoningDetails)
extends Record
implements Writeable, ToXContentObject

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 ConstructingObjectParser<Message,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Message(StreamInput in)
Message(Content content, String role, String toolCallId, List<ToolCall> toolCalls)
Message(Content content, String role, String toolCallId, List<ToolCall> toolCalls, String reasoning, List<ReasoningDetail> reasoningDetails)	Creates an instance of a Message record class.

Method Summary

Modifier and Type	Method	Description
Content	content()	Returns the value of the content record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	reasoning()	Returns the value of the reasoning record component.
List<ReasoningDetail>	reasoningDetails()	Returns the value of the reasoningDetails record component.
String	role()	Returns the value of the role record component.
String	toolCallId()	Returns the value of the toolCallId record component.
List<ToolCall>	toolCalls()	Returns the value of the toolCalls record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<Message,Void> PARSER

Constructor Details

Message

public Message(Content content,
 String role,
 @Nullable
 String toolCallId,
 @Nullable
 List<ToolCall> toolCalls)

Message

public Message(StreamInput in)
        throws IOException

Throws:

IOException

Message

public Message(@Nullable
 Content content,
 String role,
 @Nullable
 String toolCallId,
 @Nullable
 List<ToolCall> toolCalls,
 @Nullable
 String reasoning,
 @Nullable
 List<ReasoningDetail> reasoningDetails)

Creates an instance of a Message record class.

Parameters:

content - the value for the content record component

role - the value for the role record component

toolCallId - the value for the toolCallId record component

toolCalls - the value for the toolCalls record component

reasoning - the value for the reasoning record component

reasoningDetails - the value for the reasoningDetails record component

Method Details

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

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.

content

@Nullable
public Content content()

Returns the value of the content record component.

Returns:

the value of the content record component

role

public String role()

Returns the value of the role record component.

Returns:

the value of the role record component

toolCallId

@Nullable
public String toolCallId()

Returns the value of the toolCallId record component.

Returns:

the value of the toolCallId record component

toolCalls

@Nullable
public List<ToolCall> toolCalls()

Returns the value of the toolCalls record component.

Returns:

the value of the toolCalls record component

reasoning

@Nullable
public String reasoning()

Returns the value of the reasoning record component.

Returns:

the value of the reasoning record component

reasoningDetails

@Nullable
public List<ReasoningDetail> reasoningDetails()

Returns the value of the reasoningDetails record component.

Returns:

the value of the reasoningDetails record component