io.github.ollama4j.tools.annotations.ToolProperty Interface Reference

Public Member Functions
String	name ()
String	desc ()
boolean	required () default true

Detailed Description

Annotates a Method Parameter in a ToolSpec annotated Method. A parameter annotated with this annotation will be part of the tool description that is sent to the llm for tool-calling.

Definition at line 14 of file ToolProperty.java.

Member Function Documentation

desc()

String io.github.ollama4j.tools.annotations.ToolProperty.desc

(

)

Returns

a detailed description of the parameter. This is used by the llm called to specify, which property has to be set by the llm and how this should be filled.

name()

String io.github.ollama4j.tools.annotations.ToolProperty.name

(

)

Returns

name of the parameter that is used for the tool description. Has to be set as depending on the caller, method name backtracking is not possible with reflection.

required()

boolean io.github.ollama4j.tools.annotations.ToolProperty.required

(

)

Returns

tells the llm that it has to set a value for this property.

---

The documentation for this interface was generated from the following file:

• src/main/java/io/github/ollama4j/tools/annotations/ToolProperty.java