Module org.elasticsearch.xcore

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

Record Class StreamingUnifiedChatCompletionResults.Results

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.StreamingUnifiedChatCompletionResults.Results

All Implemented Interfaces:

NamedWriteable, Writeable, ChunkedToXContent, InferenceServiceResults.Result

Enclosing class:

StreamingUnifiedChatCompletionResults

public static record StreamingUnifiedChatCompletionResults.Results(Deque<StreamingUnifiedChatCompletionResults.ChatCompletionChunk> chunks)
extends Record
implements InferenceServiceResults.Result

Nested Class Summary

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 String	NAME

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
Results(Deque<StreamingUnifiedChatCompletionResults.ChatCompletionChunk> chunks)	Creates an instance of a Results record class.
Results(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Deque<StreamingUnifiedChatCompletionResults.ChatCompletionChunk>	chunks()	Returns the value of the chunks record component.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getWriteableName()
int	hashCode()	Returns a hash code value for this object.
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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunked, toXContentChunkedV8

Field Details

NAME

public static String NAME

Constructor Details

Results

public Results(StreamInput in)
        throws IOException

Throws:

IOException

Results

public Results(Deque<StreamingUnifiedChatCompletionResults.ChatCompletionChunk> chunks)

Creates an instance of a Results record class.

Parameters:

chunks - the value for the chunks record component

Method Details

toXContentChunked

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

Specified by:

toXContentChunked in interface ChunkedToXContent

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public 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.

hashCode

public 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

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

chunks

public Deque<StreamingUnifiedChatCompletionResults.ChatCompletionChunk> chunks()

Returns the value of the chunks record component.

Returns:

the value of the chunks record component