Package com.google.genai.types

Class LogprobsResultTopCandidates

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.LogprobsResultTopCandidates

public abstract class LogprobsResultTopCandidates
extends JsonSerializable

A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LogprobsResultTopCandidates.Builder	Builder for LogprobsResultTopCandidates.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
LogprobsResultTopCandidates()

Method Summary

Modifier and Type	Method	Description
static LogprobsResultTopCandidates.Builder	builder()	Instantiates a builder for LogprobsResultTopCandidates.
abstract Optional<List<LogprobsResultCandidate>>	candidates()	The list of candidate tokens, sorted by log probability in descending order.
static LogprobsResultTopCandidates	fromJson(String jsonString)	Deserializes a JSON string to a LogprobsResultTopCandidates object.
abstract LogprobsResultTopCandidates.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

LogprobsResultTopCandidates

public LogprobsResultTopCandidates()

Method Details

candidates

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

The list of candidate tokens, sorted by log probability in descending order.

builder

public static LogprobsResultTopCandidates.Builder builder()

Instantiates a builder for LogprobsResultTopCandidates.

toBuilder

public abstract LogprobsResultTopCandidates.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static LogprobsResultTopCandidates fromJson(String jsonString)

Deserializes a JSON string to a LogprobsResultTopCandidates object.