Module org.elasticsearch.xcore
Record Class StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice
java.lang.Object
java.lang.Record
org.elasticsearch.xpack.core.inference.results.StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice
- All Implemented Interfaces:
Writeable,ChunkedToXContent,ChunkedToXContentObject
- Enclosing class:
StreamingUnifiedChatCompletionResults.ChatCompletionChunk
public static record StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice(StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta delta, String finishReason, int index)
extends Record
implements ChunkedToXContentObject, Writeable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
EMPTY -
Constructor Summary
ConstructorsConstructorDescriptionChoice(StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta delta, String finishReason, int index) Creates an instance of aChoicerecord class. -
Method Summary
Modifier and TypeMethodDescriptiondelta()Returns the value of thedeltarecord component.final booleanIndicates whether some other object is "equal to" this one.Returns the value of thefinishReasonrecord component.final inthashCode()Returns a hash code value for this object.intindex()Returns the value of theindexrecord component.final StringtoString()Returns a string representation of this record class.Iterator<? extends org.elasticsearch.xcontent.ToXContent> toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
toXContentChunkedV7Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragment
-
Constructor Details
-
Choice
public Choice(StreamingUnifiedChatCompletionResults.ChatCompletionChunk.Choice.Delta delta, String finishReason, int index) Creates an instance of aChoicerecord class.- Parameters:
delta- the value for thedeltarecord componentfinishReason- the value for thefinishReasonrecord componentindex- the value for theindexrecord component
-
-
Method Details
-
toXContentChunked
public Iterator<? extends org.elasticsearch.xcontent.ToXContent> toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params params) - Specified by:
toXContentChunkedin interfaceChunkedToXContent
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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. -
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. -
equals
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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with '=='. -
delta
Returns the value of thedeltarecord component.- Returns:
- the value of the
deltarecord component
-
finishReason
Returns the value of thefinishReasonrecord component.- Returns:
- the value of the
finishReasonrecord component
-
index
public int index()Returns the value of theindexrecord component.- Returns:
- the value of the
indexrecord component
-