ToolSpecification

All Implemented Interfaces:
```
public class ToolSpecification

                    
```
Describes a tool that language model can execute.
Can be generated automatically from methods annotated with Tool using ToolSpecifications helper.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ToolSpecification.Builder`	`ToolSpecification` builder static inner class.

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
`String`	`name()`	Returns the name of the tool.
`String`	`description()`	Returns the description of the tool.
`JsonObjectSchema`	`parameters()`	Returns the parameters of the tool.
`ToolParameters`	`toolParameters()`
`boolean`	`equals(Object another)`
`int`	`hashCode()`
`String`	`toString()`
`static ToolSpecification.Builder`	`builder()`	Creates builder to build ToolSpecification.

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

- Constructor Detail
- Method Detail
  - name
```
 String name()
```
    Returns the name of the tool.
    
    Returns:
    
    the name of the tool.
  - description
```
 String description()
```
    Returns the description of the tool.
    
    Returns:
    
    the description of the tool.
  - parameters
```
 JsonObjectSchema parameters()
```
    Returns the parameters of the tool.
    The old method that returns the deprecated ToolParameters has been renamed to toolParameters.
  - toolParameters
```
@Deprecated(forRemoval = true) ToolParameters toolParameters()
```
  - equals
```
 boolean equals(Object another)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 static ToolSpecification.Builder builder()
```
    Creates builder to build ToolSpecification.
    
    Returns:
    
    created builder