google-genai/com.google.genai.types/LogprobsResult

LogprobsResult

public abstract class LogprobsResult extends JsonSerializable

The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information.

Constructors

public void LogprobsResult()

Types

public abstract class Builder

Builder for LogprobsResult.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

public static LogprobsResult.Builder builder()

Instantiates a builder for LogprobsResult.

chosenCandidates

public abstract Optional<List<LogprobsResultCandidate>> chosenCandidates()

A list of the chosen candidate tokens at each decoding step.

public static LogprobsResult fromJson(String jsonString)

Deserializes a JSON string to a LogprobsResult object.

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

logProbabilitySum

public abstract Optional<Float> logProbabilitySum()

Sum of log probabilities for all tokens.

public static ObjectMapper objectMapper()

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

public abstract LogprobsResult.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.

public abstract Optional<List<LogprobsResultTopCandidates>> topCandidates()

A list of the top candidate tokens at each decoding step.