Package com.google.genai.types

Class FunctionDeclaration

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.FunctionDeclaration

public abstract class FunctionDeclaration
extends JsonSerializable

Defines a function that the model can generate JSON inputs for.

The inputs are based on `OpenAPI 3.0 specifications <https://spec.openapis.org/oas/v3.0.3>`_.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

objectMapper

Constructor Summary

Constructors

Constructor	Description
FunctionDeclaration()

Method Summary

Modifier and Type	Method	Description
static FunctionDeclaration.Builder	builder()	Instantiates a builder for FunctionDeclaration.
abstract Optional<String>	description()	Optional.
static FunctionDeclaration	fromJson(String jsonString)	Deserializes a JSON string to a FunctionDeclaration object.
abstract Optional<String>	name()	Required.
abstract Optional<Schema>	parameters()	Optional.
abstract Optional<Schema>	response()	Describes the output from the function in the OpenAPI JSON Schema Object format.
abstract FunctionDeclaration.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FunctionDeclaration

public FunctionDeclaration()

Method Details

response

public abstract Optional<Schema> response()

Describes the output from the function in the OpenAPI JSON Schema Object format.

description

public abstract Optional<String> description()

Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.

name

public abstract Optional<String> name()

Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.

parameters

public abstract Optional<Schema> parameters()

Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1

builder

public static FunctionDeclaration.Builder builder()

Instantiates a builder for FunctionDeclaration.

toBuilder

public abstract FunctionDeclaration.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static FunctionDeclaration fromJson(String jsonString)

Deserializes a JSON string to a FunctionDeclaration object.