Class ReadFileTool

java.lang.Object

me.neurodock.ollama.OllamaFunctionTool

me.neurodock.core.files.tools.ReadFileTool

All Implemented Interfaces:

OllamaTool

public class ReadFileTool
extends OllamaFunctionTool

Field Summary

Fields inherited from class OllamaFunctionTool

source

Modifier and Type	Field	Description
protected String	source	This field is set via Reflection injection from OllamaObject.addTool(OllamaTool, String).

Constructor Summary

Constructors

Constructor	Description
ReadFileTool()

Method Summary

Modifier and Type	Method	Description
String	description()	The description of the tool This is used by Ollama to know what the tool does
@NotNull OllamaToolResponse	function(OllamaFunctionArgument... args)	The function of the tool. This is used by Ollama to call the tool. Throw OllamaToolErrorException if the tool encounters an error instead of normal exceptions.
@NotNull String	name()	The name of the tool This is used by Ollama to know what the tool is
@NotNull OllamaPerameter	parameters()	The parameters of the tool This is used by Ollama to know what parameters the tool takes If null, the tool does not take any parameters

Methods inherited from class OllamaFunctionTool

renderCalling, toString

Modifier and Type	Method	Description
ToolCallingRender	renderCalling(org.json.JSONObject calling)	Generates a string representation of this tool calling for rendering.
String	toString()

Methods inherited from class Object

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

Constructor Details

ReadFileTool

public ReadFileTool()

Method Details

name

@NotNull
public @NotNull String name()

Description copied from class: OllamaFunctionTool

The name of the tool This is used by Ollama to know what the tool is

Specified by:

name in class OllamaFunctionTool

Returns:

The name of the tool

description

public String description()

Description copied from class: OllamaFunctionTool

The description of the tool This is used by Ollama to know what the tool does

Overrides:

description in class OllamaFunctionTool

Returns:

The description of the tool

parameters

@NotNull
public @NotNull OllamaPerameter parameters()

Description copied from class: OllamaFunctionTool

The parameters of the tool This is used by Ollama to know what parameters the tool takes If null, the tool does not take any parameters

Specified by:

parameters in class OllamaFunctionTool

Returns:

The parameters of the tool or null if the tool does not take any parameters

function

@NotNull
public @NotNull OllamaToolResponse function(OllamaFunctionArgument... args)

Description copied from class: OllamaFunctionTool

The function of the tool.
This is used by Ollama to call the tool.
Throw OllamaToolErrorException if the tool encounters an error instead of normal exceptions. The OllamaToolErrorException gets handled more gracefully by Core.handleResponse(JSONObject)

Specified by:

function in class OllamaFunctionTool

Parameters:

args - The arguments to pass to the tool, if any

Returns:

The response from the tool, if null return OllamaToolResponse