Class ToolSpecifications

java.lang.Object

dev.langchain4j.agent.tool.ToolSpecifications

public class ToolSpecifications
extends Object

Utility methods for ToolSpecifications.

Method Summary

Modifier and Type	Method	Description
static ToolSpecification	toolSpecificationFrom(Method method)	Returns the ToolSpecification for the given method annotated with @Tool.
static List<ToolSpecification>	toolSpecificationsFrom(Class<?> classWithTools)	Returns ToolSpecifications for all methods annotated with @Tool within the specified class.
static List<ToolSpecification>	toolSpecificationsFrom(Object objectWithTools)	Returns ToolSpecifications for all methods annotated with @Tool within the class of the specified object.
static void	validateSpecifications(List<ToolSpecification> toolSpecifications)	Validates all the ToolSpecifications.

Methods inherited from class Object

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

Method Details

toolSpecificationsFrom

public static List<ToolSpecification> toolSpecificationsFrom(Class<?> classWithTools)

Returns ToolSpecifications for all methods annotated with @Tool within the specified class.

Parameters:

classWithTools - the class.

Returns:

the ToolSpecifications.

toolSpecificationsFrom

public static List<ToolSpecification> toolSpecificationsFrom(Object objectWithTools)

Returns ToolSpecifications for all methods annotated with @Tool within the class of the specified object.

Parameters:

objectWithTools - the object.

Returns:

the ToolSpecifications.

validateSpecifications

public static void validateSpecifications(List<ToolSpecification> toolSpecifications)
                                   throws IllegalArgumentException

Validates all the ToolSpecifications. The validation checks for duplicate method names. Throws IllegalArgumentException if validation fails

Parameters:

toolSpecifications - list of ToolSpecification to be validated.

Throws:

IllegalArgumentException

toolSpecificationFrom

public static ToolSpecification toolSpecificationFrom(Method method)

Returns the ToolSpecification for the given method annotated with @Tool.

Parameters:

method - the method.

Returns:

the ToolSpecification.