Class ToolParameters

java.lang.Object

me.neurodock.plugin.tool.ToolParameters

public class ToolParameters
extends Object

Represents the parameters of a tool. This is used by Ollama to determine the parameters of a tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolParameters.ToolParametersBuilder	Represents a builder for ToolParameters.

Method Summary

Modifier and Type	Method	Description
static ToolParameters.ToolParametersBuilder	builder()	Creates a new instance of ToolParameters.ToolParametersBuilder.
static ToolParameters	empty()	Creates an empty ToolParameters
org.json.JSONObject	getJSON()
org.json.JSONObject	getProperties()	Gets the properties of the ToolParameters
String[]	getRequired()	Gets the required parameters of the ToolParameters

Methods inherited from class Object

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

Method Details

getJSON

public org.json.JSONObject getJSON()

getProperties

public org.json.JSONObject getProperties()

Gets the properties of the ToolParameters

Returns:

The properties of the ToolParameters

getRequired

public String[] getRequired()

Gets the required parameters of the ToolParameters

Returns:

The required parameters of the ToolParameters

builder

public static ToolParameters.ToolParametersBuilder builder()

Creates a new instance of ToolParameters.ToolParametersBuilder.

Returns:

The ToolParameters.ToolParametersBuilder

empty

public static ToolParameters empty()

Creates an empty ToolParameters

Returns:

an empty ToolParameters