Record Class MistralAiApi.ChatCompletionChunk.ChunkChoice
java.lang.Object
java.lang.Record
org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionChunk.ChunkChoice
- Record Components:
index- The index of the choice in the list of choices.delta- A chat completion delta generated by streamed model responses.finishReason- The reason the model stopped generating tokens.logprobs- Log probability information for the choice.
- Enclosing class:
- MistralAiApi.ChatCompletionChunk
public static record MistralAiApi.ChatCompletionChunk.ChunkChoice(Integer index, MistralAiApi.ChatCompletionMessage delta, MistralAiApi.FinishReason finishReason, @Nullable MistralAiApi.LogProbs logprobs)
extends Record
Chat completion choice.
-
Constructor Summary
ConstructorsConstructorDescriptionChunkChoice(Integer index, MistralAiApi.ChatCompletionMessage delta, MistralAiApi.FinishReason finishReason, @Nullable MistralAiApi.LogProbs logprobs) Creates an instance of aChunkChoicerecord 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.index()Returns the value of theindexrecord component.@Nullable MistralAiApi.LogProbslogprobs()Returns the value of thelogprobsrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ChunkChoice
public ChunkChoice(Integer index, MistralAiApi.ChatCompletionMessage delta, MistralAiApi.FinishReason finishReason, @Nullable MistralAiApi.LogProbs logprobs) Creates an instance of aChunkChoicerecord class.- Parameters:
index- the value for theindexrecord componentdelta- the value for thedeltarecord componentfinishReason- the value for thefinishReasonrecord componentlogprobs- the value for thelogprobsrecord component
-
-
Method Details
-
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. All components in this record class are compared withObjects::equals(Object,Object). -
index
Returns the value of theindexrecord component.- Returns:
- the value of the
indexrecord component
-
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
-
logprobs
Returns the value of thelogprobsrecord component.- Returns:
- the value of the
logprobsrecord component
-