Package com.google.genai.types

Class TokensInfo

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.TokensInfo

public abstract class TokensInfo
extends JsonSerializable

Tokens info with a list of tokens and the corresponding list of token ids.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TokensInfo()

Method Summary

Modifier and Type	Method	Description
static TokensInfo.Builder	builder()	Instantiates a builder for TokensInfo.
static TokensInfo	fromJson(String jsonString)	Deserializes a JSON string to a TokensInfo object.
abstract Optional<String>	role()	Optional fields for the role from the corresponding Content.
abstract TokensInfo.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<List<Long>>	tokenIds()	A list of token ids from the input.
abstract Optional<List<byte[]>>	tokens()	A list of tokens from the input.

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

TokensInfo

public TokensInfo()

Method Details

role

public abstract Optional<String> role()

Optional fields for the role from the corresponding Content.

tokenIds

public abstract Optional<List<Long>> tokenIds()

A list of token ids from the input.

tokens

public abstract Optional<List<byte[]>> tokens()

A list of tokens from the input.

builder

public static TokensInfo.Builder builder()

Instantiates a builder for TokensInfo.

toBuilder

public abstract TokensInfo.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static TokensInfo fromJson(String jsonString)

Deserializes a JSON string to a TokensInfo object.