Record Class AnthropicApi.Tool

java.lang.Object

java.lang.Record

org.springframework.ai.anthropic.api.AnthropicApi.Tool

Record Components:

type - The type of the tool (e.g., "code_execution_20250825" for code execution).

name - The name of the tool.

description - A description of the tool.

inputSchema - The input schema of the tool.

cacheControl - Optional cache control for this tool.

Enclosing class:

AnthropicApi

public static record AnthropicApi.Tool(String type, String name, String description, Map<String,Object> inputSchema, AnthropicApi.ChatCompletionRequest.CacheControl cacheControl)
extends Record

Tool description.

Since:

1.0.0

Author:

Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Jihoon Kim, Alexandros Pappas, Jonghoon Park, Claudio Silva Junior, Filip Hrisafov, Soby Chacko, Austin Dase

Constructor Summary

Constructors

Constructor	Description
Tool(String type, String name, String description, Map<String,Object> inputSchema)	Constructor for backward compatibility without cache control.
Tool(String type, String name, String description, Map<String,Object> inputSchema, AnthropicApi.ChatCompletionRequest.CacheControl cacheControl)	Creates an instance of a Tool record class.
Tool(String name, String description, Map<String,Object> inputSchema)	Constructor for backward compatibility without type or cache control.

Method Summary

Modifier and Type	Method	Description
AnthropicApi.ChatCompletionRequest.CacheControl	cacheControl()	Returns the value of the cacheControl record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String,Object>	inputSchema()	Returns the value of the inputSchema record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

Tool

public Tool(String name,
 String description,
 Map<String,Object> inputSchema)

Constructor for backward compatibility without type or cache control.

Tool

public Tool(String type,
 String name,
 String description,
 Map<String,Object> inputSchema)

Constructor for backward compatibility without cache control.

Tool

public Tool(String type,
 String name,
 String description,
 Map<String,Object> inputSchema,
 AnthropicApi.ChatCompletionRequest.CacheControl cacheControl)

Creates an instance of a Tool record class.

Parameters:

type - the value for the type record component

name - the value for the name record component

description - the value for the description record component

inputSchema - the value for the inputSchema record component

cacheControl - the value for the cacheControl record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

inputSchema

public Map<String,Object> inputSchema()

Returns the value of the inputSchema record component.

Returns:

the value of the inputSchema record component

cacheControl

public AnthropicApi.ChatCompletionRequest.CacheControl cacheControl()

Returns the value of the cacheControl record component.

Returns:

the value of the cacheControl record component