Share via

ChatTokenLogProbabilityResult Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.ChatTokenLogProbabilityResult

Implements

JsonSerializable<ChatTokenLogProbabilityResult>

public final class ChatTokenLogProbabilityResult
implements JsonSerializable<ChatTokenLogProbabilityResult>

A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.

Method Summary

Modifier and Type Method and Description
static ChatTokenLogProbabilityResult fromJson(JsonReader jsonReader)

Reads an instance of ChatTokenLogProbabilityResult from the JsonReader.
List<Integer> getBytes()

Get the bytes property: A list of integers representing the UTF-8 bytes representation of the token.
double getLogprob()

Get the logprob property: The log probability of the message content token.
String getToken()

Get the token property: The message content token.
List<ChatTokenLogProbabilityInfo> getTopLogprobs()

Get the topLogprobs property: The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static ChatTokenLogProbabilityResult fromJson(JsonReader jsonReader)

Reads an instance of ChatTokenLogProbabilityResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ChatTokenLogProbabilityResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getBytes

public List getBytes()

Get the bytes property: 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 value.

getLogprob

public double getLogprob()

Get the logprob property: The log probability of the message content token.

Returns:

the logprob value.

getToken

public String getToken()

Get the token property: The message content token.

Returns:

the token value.

getTopLogprobs

public List getTopLogprobs()

Get the topLogprobs property: The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.

Returns:

the topLogprobs value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to