Module org.elasticsearch.xcore

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

Record Class StreamingUnifiedChatCompletionResults

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

NamedWriteable, Writeable, ChunkedToXContent, InferenceServiceResults

public record StreamingUnifiedChatCompletionResults(Flow.Publisher<StreamingUnifiedChatCompletionResults.Results> publisher)
extends Record
implements InferenceServiceResults

Chat Completion results that only contain a Flow.Publisher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StreamingUnifiedChatCompletionResults.ChatCompletionChunk
static final record	StreamingUnifiedChatCompletionResults.Results

Nested classes/interfaces inherited from interface org.elasticsearch.inference.InferenceServiceResults

InferenceServiceResults.Result

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	NAME

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
StreamingUnifiedChatCompletionResults(Flow.Publisher<StreamingUnifiedChatCompletionResults.Results> publisher)	OpenAI Spec only returns one result at a time, and Chat Completion adheres to that spec as much as possible.

Method Summary

Modifier and Type	Method	Description
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.
boolean	isStreaming()
Flow.Publisher<StreamingUnifiedChatCompletionResults.Results>	publisher()	Returns the value of the publisher record component.
final String	toString()	Returns a string representation of this record class.
Iterator<? extends org.elasticsearch.xcontent.ToXContent>	toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params params)

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

Methods inherited from interface org.elasticsearch.inference.InferenceServiceResults

asMap, getWriteableName, transformToCoordinationFormat, writeTo

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

StreamingUnifiedChatCompletionResults

public StreamingUnifiedChatCompletionResults(Flow.Publisher<StreamingUnifiedChatCompletionResults.Results> publisher)

OpenAI Spec only returns one result at a time, and Chat Completion adheres to that spec as much as possible. So we will insert a buffer in between the upstream data and the downstream client so that we only send one request at a time.

Method Details

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface InferenceServiceResults

toXContentChunked

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

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface InferenceServiceResults

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.

publisher

public Flow.Publisher<StreamingUnifiedChatCompletionResults.Results> publisher()

Returns the value of the publisher record component.

Specified by:

publisher in interface InferenceServiceResults

Returns:

the value of the publisher record component