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
A function response.

  • Constructor Details

    • FunctionResponse

      public FunctionResponse()

  • Method Details

    • willContinue

      public abstract Optional<Boolean> willContinue()
      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 (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. 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.

    • scheduling

      public abstract Optional<FunctionResponseScheduling> scheduling()
      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()
      List of parts that constitute a function response. Each part may have a different IANA MIME type.

    • 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.