All Implemented Interfaces:
```
public final class FunctionTool

                    
```
Defines a function in your own code the model can choose to call. Learn more about function calling.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FunctionTool.Builder`	A builder for FunctionTool.
`public final class`	`FunctionTool.Parameters`	A JSON schema object describing the parameters of the function.
`public final class`	`FunctionTool.AllowedCaller`
`public final class`	`FunctionTool.OutputSchema`	A JSON schema object describing the JSON value encoded in string outputs for this function.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`name()`	The name of the function to call.
`final Optional<FunctionTool.Parameters>`	`parameters()`	A JSON schema object describing the parameters of the function.
`final Optional<Boolean>`	`strict()`	Whether strict parameter validation is enforced for this function tool.
`final JsonValue`	`_type()`	The type of the function tool.
`final Optional<List<FunctionTool.AllowedCaller>>`	`allowedCallers()`	The tool invocation context(s).
`final Optional<Boolean>`	`deferLoading()`	Whether this function is deferred and loaded via tool search.
`final Optional<String>`	`description()`	A description of the function.
`final Optional<FunctionTool.OutputSchema>`	`outputSchema()`	A JSON schema object describing the JSON value encoded in string outputs for this function.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<FunctionTool.Parameters>`	`_parameters()`	Returns the raw JSON value of parameters.
`final JsonField<Boolean>`	`_strict()`	Returns the raw JSON value of strict.
`final JsonField<List<FunctionTool.AllowedCaller>>`	`_allowedCallers()`	Returns the raw JSON value of allowedCallers.
`final JsonField<Boolean>`	`_deferLoading()`	Returns the raw JSON value of deferLoading.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<FunctionTool.OutputSchema>`	`_outputSchema()`	Returns the raw JSON value of outputSchema.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final FunctionTool.Builder`	`toBuilder()`
`final FunctionTool`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FunctionTool.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FunctionTool.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - name
```
 final String name()
```
    The name of the function to call.
  - parameters
```
 final Optional<FunctionTool.Parameters> parameters()
```
    A JSON schema object describing the parameters of the function.
  - strict
```
 final Optional<Boolean> strict()
```
    Whether strict parameter validation is enforced for this function tool.
  - _type
```
 final JsonValue _type()
```
    The type of the function tool. Always function.
    Expected to always return the following:
    JsonValue.from("function")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - allowedCallers
```
 final Optional<List<FunctionTool.AllowedCaller>> allowedCallers()
```
    The tool invocation context(s).
  - deferLoading
```
 final Optional<Boolean> deferLoading()
```
    Whether this function is deferred and loaded via tool search.
  - description
```
 final Optional<String> description()
```
    A description of the function. Used by the model to determine whether or not to call the function.
  - outputSchema
```
 final Optional<FunctionTool.OutputSchema> outputSchema()
```
    A JSON schema object describing the JSON value encoded in string outputs for this function.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _parameters
```
 final JsonField<FunctionTool.Parameters> _parameters()
```
    Returns the raw JSON value of parameters.
    Unlike parameters, this method doesn't throw if the JSON field has an unexpected type.
  - _strict
```
 final JsonField<Boolean> _strict()
```
    Returns the raw JSON value of strict.
    Unlike strict, this method doesn't throw if the JSON field has an unexpected type.
  - _allowedCallers
```
 final JsonField<List<FunctionTool.AllowedCaller>> _allowedCallers()
```
    Returns the raw JSON value of allowedCallers.
    Unlike allowedCallers, this method doesn't throw if the JSON field has an unexpected type.
  - _deferLoading
```
 final JsonField<Boolean> _deferLoading()
```
    Returns the raw JSON value of deferLoading.
    Unlike deferLoading, this method doesn't throw if the JSON field has an unexpected type.
  - _description
```
 final JsonField<String> _description()
```
    Returns the raw JSON value of description.
    Unlike description, this method doesn't throw if the JSON field has an unexpected type.
  - _outputSchema
```
 final JsonField<FunctionTool.OutputSchema> _outputSchema()
```
    Returns the raw JSON value of outputSchema.
    Unlike outputSchema, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final FunctionTool.Builder toBuilder()
```
  - validate
```
 final FunctionTool validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FunctionTool.Builder builder()
```
    Returns a mutable builder for constructing an instance of FunctionTool.
    The following fields are required:
    .name() .parameters() .strict()

Class FunctionTool

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

name

parameters

strict

_type

allowedCallers

deferLoading

description

outputSchema

_name

_parameters

_strict

_allowedCallers

_deferLoading

_description

_outputSchema

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder