Package dev.langchain4j.agent.tool

Class ToolSpecification

java.lang.Object

dev.langchain4j.agent.tool.ToolSpecification

public class ToolSpecification
extends Object

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
static final class	ToolSpecification.Builder	ToolSpecification builder static inner class.

Method Summary

Modifier and Type	Method	Description
static ToolSpecification.Builder	builder()	Creates builder to build ToolSpecification.
String	description()	Returns the description of the tool.
boolean	equals(Object another)
int	hashCode()
String	name()	Returns the name of the tool.
JsonObjectSchema	parameters()	Returns the parameters of the tool.
ToolParameters	toolParameters()	Deprecated, for removal: This API element is subject to removal in a future version. please use parameters() instead
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

name

public String name()

Returns the name of the tool.

Returns:

the name of the tool.

description

public String description()

Returns the description of the tool.

Returns:

the description of the tool.

parameters

public 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)
public ToolParameters toolParameters()

Deprecated, for removal: This API element is subject to removal in a future version.

please use parameters() instead

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ToolSpecification.Builder builder()

Creates builder to build ToolSpecification.

Returns:

created builder