Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Record Class StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta

All Implemented Interfaces:

Writeable

Enclosing class:

StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice

public static record StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta(String content, String refusal, String role, List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall> toolCalls, String reasoning, List<ReasoningDetail> reasoningDetails)
extends Record
implements Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall

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

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

Constructor Summary

Constructors

Constructor	Description
Delta(String content, String refusal, String role, List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall> toolCalls)
Delta(String content, String refusal, String role, List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall> toolCalls, String reasoning, List<ReasoningDetail> reasoningDetails)	Creates an instance of a Delta record class.

Method Summary

Modifier and Type	Method	Description
String	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	refusal()	Returns the value of the refusal record component.
String	role()	Returns the value of the role record component.
List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall>	toolCalls()	Returns the value of the toolCalls record component.
final String	toString()	Returns a string representation of this record class.
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Details

Delta

public Delta(@Nullable
 String content,
 @Nullable
 String refusal,
 @Nullable
 String role,
 @Nullable
 List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall> toolCalls)

Delta

public Delta(@Nullable
 String content,
 @Nullable
 String refusal,
 @Nullable
 String role,
 @Nullable
 List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.ToolCall> toolCalls,
 @Nullable
 String reasoning,
 @Nullable
 List<ReasoningDetail> reasoningDetails)

Creates an instance of a Delta record class.

Parameters:

content - the value for the content record component

refusal - the value for the refusal record component

role - the value for the role 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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

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 String content()

Returns the value of the content record component.

Returns:

the value of the content record component

refusal

@Nullable
public String refusal()

Returns the value of the refusal record component.

Returns:

the value of the refusal record component

role

@Nullable
public String role()

Returns the value of the role record component.

Returns:

the value of the role record component

toolCalls

@Nullable
public List<StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta.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