Class ApiChatCompletionsResponseChoiceLogProbsTokenInfo

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.client.json.ApiChatCompletionsResponseChoiceLogProbsTokenInfo

public final class ApiChatCompletionsResponseChoiceLogProbsTokenInfo
extends Object

Content tokens with log probability information.

Since:

8.5.0

Method Summary

Modifier and Type	Method	Description
byte[]	bytes()	A list of integers representing the UTF-8 bytes representation of the token.
Double	logProb()	The log probability of this token, if it is within the top 20 most likely tokens.
String	token()	The token.
List<ApiChatCompletionsResponseChoiceLogProbsContentTopLogProbs>	topLogProbs()	List of the most likely tokens and their log probability, at this token position.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

bytes

public byte[] bytes()

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.

Returns:

The bytes representation of the token.

logProb

public Double logProb()

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

Returns:

The log probability of the token.

token

public String token()

The token.

Returns:

The token.

topLogProbs

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

Returns:

The top log probabilities.