Class AiServiceTool

java.lang.Object

dev.langchain4j.service.tool.AiServiceTool

public class AiServiceTool
extends Object

Represents a tool managed by an AI Service, combining:

• ToolSpecification — what is sent to the LLM
• ToolExecutor — what is called when the LLM invokes the tool
• Metadata that controls how the AI Service handles this tool (e.g., ReturnBehavior)

Since:

1.13.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AiServiceTool.Builder

Method Summary

Modifier and Type	Method	Description
static AiServiceTool.Builder	builder()
boolean	equals(Object o)
int	hashCode()
boolean	immediateReturn()	Deprecated. use returnBehavior() instead
String	name()
ReturnBehavior	returnBehavior()
AiServiceTool.Builder	toBuilder()
ToolExecutor	toolExecutor()
ToolSpecification	toolSpecification()
String	toString()

Methods inherited from class Object

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

Method Details

name

public String name()

toolSpecification

public ToolSpecification toolSpecification()

toolExecutor

public ToolExecutor toolExecutor()

returnBehavior

public ReturnBehavior returnBehavior()

Since:

1.14.0

immediateReturn

@Deprecated(since="1.14.0")
public boolean immediateReturn()

Deprecated.

use returnBehavior() instead

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public AiServiceTool.Builder toBuilder()

builder

public static AiServiceTool.Builder builder()