Package org.springframework.ai.mistralai.api

Record Class MistralAiApi.LogProbs.Content

java.lang.Object

java.lang.Record

org.springframework.ai.mistralai.api.MistralAiApi.LogProbs.Content

Record Components:

token - The token.

logprob - The log probability of the token.

probBytes - A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

topLogprobs - List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.

Enclosing class:

MistralAiApi.LogProbs

public static record MistralAiApi.LogProbs.Content(String token, Float logprob, List<Integer> probBytes, List<MistralAiApi.LogProbs.Content.TopLogProbs> topLogprobs)
extends Record

Message content tokens with log probability information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MistralAiApi.LogProbs.Content.TopLogProbs	The most likely tokens and their log probability, at this token position.

Constructor Summary

Constructors

Constructor	Description
Content(String token, Float logprob, List<Integer> probBytes, List<MistralAiApi.LogProbs.Content.TopLogProbs> topLogprobs)	Creates an instance of a Content record class.

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.
Float	logprob()	Returns the value of the logprob record component.
List<Integer>	probBytes()	Returns the value of the probBytes record component.
String	token()	Returns the value of the token record component.
List<MistralAiApi.LogProbs.Content.TopLogProbs>	topLogprobs()	Returns the value of the topLogprobs record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Content

public Content(String token,
 Float logprob,
 List<Integer> probBytes,
 List<MistralAiApi.LogProbs.Content.TopLogProbs> topLogprobs)

Creates an instance of a Content record class.

Parameters:

token - the value for the token record component

logprob - the value for the logprob record component

probBytes - the value for the probBytes record component

topLogprobs - the value for the topLogprobs record component

Method Details

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.

token

public String token()

Returns the value of the token record component.

Returns:

the value of the token record component

logprob

public Float logprob()

Returns the value of the logprob record component.

Returns:

the value of the logprob record component

probBytes

public List<Integer> probBytes()

Returns the value of the probBytes record component.

Returns:

the value of the probBytes record component

topLogprobs

public List<MistralAiApi.LogProbs.Content.TopLogProbs> topLogprobs()

Returns the value of the topLogprobs record component.

Returns:

the value of the topLogprobs record component