google-genai/com.google.genai.types/GenerateContentResponse

GenerateContentResponse

public abstract class GenerateContentResponse extends JsonSerializable

Response message for PredictionService.GenerateContent.

Constructors

public void GenerateContentResponse()

Types

Builder

public abstract class Builder

Builder for GenerateContentResponse.

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

automaticFunctionCallingHistory

public abstract Optional<List<Content>> automaticFunctionCallingHistory()

The history of automatic function calling.

builder

public static GenerateContentResponse.Builder builder()

Instantiates a builder for GenerateContentResponse.

candidates

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

Response variations returned by the model.

checkFinishReason

@InternalApi()

public void checkFinishReason()

Throws an exception if the response finishes unexpectedly.

codeExecutionResult

@Nullable()

public @Nullable() String codeExecutionResult()

Returns the code execution result in the response.

createTime

public abstract Optional<Instant> createTime()

Timestamp when the request is made to the server.

executableCode

@Nullable()

public @Nullable() String executableCode()

Returns the executable code in the response.

finishReason

public FinishReason finishReason()

Gets the finish reason in a GenerateContentResponse.

fromJson

public static GenerateContentResponse fromJson(String jsonString)

Deserializes a JSON string to a GenerateContentResponse object.

fromJsonNode

@InternalApi()

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

Deserializes a JsonNode to an object of the given type.

fromJsonString

@InternalApi()

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

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

functionCalls

@Nullable()

public @Nullable() ImmutableList<FunctionCall> functionCalls()

Returns the list of function calls in the response.

modelStatus

public abstract Optional<ModelStatus> modelStatus()

Output only.

modelVersion

public abstract Optional<String> modelVersion()

Output only.

objectMapper

public static ObjectMapper objectMapper()

parts

@Nullable()

public @Nullable() ImmutableList<Part> parts()

Returns the list of parts in the first candidate of the response.

promptFeedback

public abstract Optional<GenerateContentResponsePromptFeedback> promptFeedback()

Output only.

responseId

public abstract Optional<String> responseId()

Output only.

sdkHttpResponse

public abstract Optional<HttpResponse> sdkHttpResponse()

Used to retain the full HTTP response.

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.

text

@Nullable()

public @Nullable() String text()

Returns the concatenation of all text parts in the first candidate of the response.

toBuilder

public abstract GenerateContentResponse.Builder toBuilder()

Creates a builder with the same values as this instance.

toJson

public String toJson()

Serializes the instance to a Json string.

toJsonNode

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

toJsonString

public static String toJsonString(Object object)

Serializes an object to a Json string.

usageMetadata

public abstract Optional<GenerateContentResponseUsageMetadata> usageMetadata()

Usage metadata about the response(s).