google-genai/com.google.genai.types/Candidate

Candidate

public abstract class Candidate extends JsonSerializable

A response candidate generated from the model.

Constructors

Link copied to clipboard
public void Candidate()

Types

Link copied to clipboard
public abstract class Builder
Builder for Candidate.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<Double> avgLogprobs()
Output only.
Link copied to clipboard
public static Candidate.Builder builder()
Instantiates a builder for Candidate.
Link copied to clipboard
public abstract Optional<CitationMetadata> citationMetadata()
Source attribution of the generated content.
Link copied to clipboard
public abstract Optional<Content> content()
Contains the multi-part content of the response.
Link copied to clipboard
public abstract Optional<String> finishMessage()
Describes the reason the model stopped generating tokens.
Link copied to clipboard
public abstract Optional<FinishReason> finishReason()
The reason why the model stopped generating tokens.
Link copied to clipboard
public static Candidate fromJson(String jsonString)
Deserializes a JSON string to a Candidate object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<GroundingMetadata> groundingMetadata()
Output only.
Link copied to clipboard
public abstract Optional<Integer> index()
Output only.
Link copied to clipboard
public abstract Optional<LogprobsResult> logprobsResult()
Output only.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<List<SafetyRating>> safetyRatings()
Output only.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract Candidate.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<Integer> tokenCount()
Number of tokens for this candidate.
Link copied to clipboard
public abstract Optional<UrlContextMetadata> urlContextMetadata()
Output only.