google-genai/com.google.genai.types/FunctionDeclaration

FunctionDeclaration

public abstract class FunctionDeclaration extends JsonSerializable

Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.

Constructors

FunctionDeclaration

public void FunctionDeclaration()

Types

public abstract class Builder

Builder for FunctionDeclaration.

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

public abstract Optional<Behavior> behavior()

Optional.

public static FunctionDeclaration.Builder builder()

Instantiates a builder for FunctionDeclaration.

public abstract Optional<String> description()

Optional.

public static FunctionDeclaration fromJson(String jsonString)

Deserializes a JSON string to a FunctionDeclaration object.

@InternalApi()

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

Deserializes a JsonNode to an object of the given type.

@InternalApi()

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

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

public static FunctionDeclaration fromMethod(Method method, Array<String> orderedParameterNames)

public static FunctionDeclaration fromMethod(String functionDescription, Method method, Array<String> orderedParameterNames)

Creates a FunctionDeclaration instance from a Method instance.

public abstract Optional<String> name()

Required.

public static ObjectMapper objectMapper()

public abstract Optional<Schema> parameters()

Optional.

parametersJsonSchema

public abstract Optional<Object> parametersJsonSchema()

Optional.

public abstract Optional<Schema> response()

Optional.

responseJsonSchema

public abstract Optional<Object> responseJsonSchema()

Optional.

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.

public abstract FunctionDeclaration.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.