Package com.google.genai.types

Class FunctionResponse

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.FunctionResponse

public abstract class FunctionResponse
extends JsonSerializable

The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
FunctionResponse()

Method Summary

Modifier and Type	Method	Description
static FunctionResponse.Builder	builder()	Instantiates a builder for FunctionResponse.
static FunctionResponse	fromJson(String jsonString)	Deserializes a JSON string to a FunctionResponse object.
abstract Optional<String>	id()	Optional.
abstract Optional<String>	name()	Required.
abstract Optional<List<FunctionResponsePart>>	parts()	Optional.
abstract Optional<Map<String,Object>>	response()	Required.
abstract Optional<FunctionResponseScheduling>	scheduling()	Optional.
abstract FunctionResponse.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Boolean>	willContinue()	Optional.

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

FunctionResponse

public FunctionResponse()

Method Details

willContinue

public abstract Optional<Boolean> willContinue()

Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set `scheduling` to `SILENT`. This field is not supported in Vertex AI.

scheduling

public abstract Optional<FunctionResponseScheduling> scheduling()

Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.

parts

public abstract Optional<List<FunctionResponsePart>> parts()

Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.

id

public abstract Optional<String> id()

Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.

name

public abstract Optional<String> name()

Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.

response

public abstract Optional<Map<String,Object>> response()

Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

builder

public static FunctionResponse.Builder builder()

Instantiates a builder for FunctionResponse.

toBuilder

public abstract FunctionResponse.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static FunctionResponse fromJson(String jsonString)

Deserializes a JSON string to a FunctionResponse object.