Class OllamaObject.OllamaObjectBuilder

java.lang.Object

me.neurodock.ollama.OllamaObject.OllamaObjectBuilder

Enclosing class:

OllamaObject

public static class OllamaObject.OllamaObjectBuilder
extends Object

Represents a builder for OllamaObject.

Constructor Summary

Constructors

Constructor	Description
OllamaObjectBuilder()	Creates a new instance of OllamaObject.OllamaObjectBuilder.

Method Summary

Modifier and Type	Method	Description
OllamaObject.OllamaObjectBuilder	addFileTools(String baseDirectory)	Initializes the FileHandler singleton with the given base directory and adds its tools.
OllamaObject.OllamaObjectBuilder	addMessage(OllamaMessage messages)	Adds a message to the Ollama Object
OllamaObject.OllamaObjectBuilder	addMessages(OllamaMessage... messages)	Adds messages to the Ollama Object
OllamaObject.OllamaObjectBuilder	addTool(OllamaTool tool)	Adds a tool to the Ollama Object Assumes the tool is from an external source, see addTool(OllamaTool, String) to specify the source
OllamaObject.OllamaObjectBuilder	addTool(OllamaTool tool, String source)	Adds a tool to the Ollama Object This allows you to specify the source of the tool, see addTool(OllamaTool) to add a tool from an external source
OllamaObject.OllamaObjectBuilder	addTools(ArrayList<Pair<? extends OllamaTool, String>> tools)	Adds tools to the Ollama Object This allows you to specify the source of the tools, see addToolsExternal(ArrayList)} to add tools from an external source
final OllamaObject.OllamaObjectBuilder	addTools(Pair<OllamaTool, String>... tools)	Adds tools to the Ollama Object This allows you to specify the source of the tools, see addTools(OllamaTool[]) to add tools from an external source
OllamaObject.OllamaObjectBuilder	addTools(OllamaTool... tools)	Adds tools to the Ollama Object Assumes the tools are from an external source, see addTools(Pair[])} to specify the source
OllamaObject.OllamaObjectBuilder	addToolsExternal(ArrayList<? extends OllamaTool> tools)	Adds tools to the Ollama Object Assumes the tools are from an external source, see addTools(ArrayList)} to specify the source
OllamaObject	build()	Builds the OllamaObject
OllamaObject.OllamaObjectBuilder	format(String format)	Sets the format of the Ollama Object as a JSON schema.
OllamaObject.OllamaObjectBuilder	keep_alive(int minutes)	Sets the keep alive of the Ollama Object.
OllamaObject.OllamaObjectBuilder	keep_alive(String keep_alive)	Sets the keep alive of the Ollama Object. This is a string formated as "minutes"m or "hours"h or "days"d
OllamaObject.OllamaObjectBuilder	option(String key, String value)	Sets an option of the Ollama Object.
OllamaObject.OllamaObjectBuilder	options(Map<String,Object> options)	Sets the options of the Ollama Object.
OllamaObject.OllamaObjectBuilder	setModel(String model)	Sets the model of the Ollama Object
OllamaObject.OllamaObjectBuilder	stream(boolean stream)	Deprecated. This should be false due to being broken in the current version of this system

Methods inherited from class Object

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

Constructor Details

OllamaObjectBuilder

public OllamaObjectBuilder()

Creates a new instance of OllamaObject.OllamaObjectBuilder.

Method Details

format

public OllamaObject.OllamaObjectBuilder format(String format)

Sets the format of the Ollama Object as a JSON schema.

Parameters:

format - The format of the Ollama Object as a JSON schema

Returns:

The OllamaObject.OllamaObjectBuilder

options

public OllamaObject.OllamaObjectBuilder options(Map<String,Object> options)

Sets the options of the Ollama Object.

Parameters:

options - The options of the Ollama Object

Returns:

The OllamaObject.OllamaObjectBuilder

option

public OllamaObject.OllamaObjectBuilder option(String key,
 String value)

Sets an option of the Ollama Object.

Parameters:

key - The key of the option

value - The value of the option

Returns:

The OllamaObject.OllamaObjectBuilder

stream

@Deprecated
public OllamaObject.OllamaObjectBuilder stream(boolean stream)

Deprecated.

This should be false due to being broken in the current version of this system

Sets if the Ollama Object is streamed.

Parameters:

stream - If the Ollama Object is streamed

Returns:

The OllamaObject.OllamaObjectBuilder

keep_alive

public OllamaObject.OllamaObjectBuilder keep_alive(String keep_alive)

Sets the keep alive of the Ollama Object.
This is a string formated as "minutes"m or "hours"h or "days"d

Parameters:

keep_alive - The keep alive of the Ollama Object

Returns:

The OllamaObject.OllamaObjectBuilder

keep_alive

public OllamaObject.OllamaObjectBuilder keep_alive(int minutes)

Sets the keep alive of the Ollama Object.

Parameters:

minutes - The keep alive of the Ollama Object in minutes

Returns:

The OllamaObject.OllamaObjectBuilder

addTool

public OllamaObject.OllamaObjectBuilder addTool(OllamaTool tool)

Adds a tool to the Ollama Object Assumes the tool is from an external source, see addTool(OllamaTool, String) to specify the source

Parameters:

tool - The tool to add

Returns:

The OllamaObject.OllamaObjectBuilder

addTool

public OllamaObject.OllamaObjectBuilder addTool(OllamaTool tool,
 String source)

Adds a tool to the Ollama Object This allows you to specify the source of the tool, see addTool(OllamaTool) to add a tool from an external source

Parameters:

tool - The tool to add

Returns:

The OllamaObject.OllamaObjectBuilder

addToolsExternal

public OllamaObject.OllamaObjectBuilder addToolsExternal(ArrayList<? extends OllamaTool> tools)

Adds tools to the Ollama Object Assumes the tools are from an external source, see addTools(ArrayList)} to specify the source

Parameters:

tools - The tools to add

Returns:

The OllamaObject.OllamaObjectBuilder

addTools

public OllamaObject.OllamaObjectBuilder addTools(ArrayList<Pair<? extends OllamaTool, String>> tools)

Adds tools to the Ollama Object This allows you to specify the source of the tools, see addToolsExternal(ArrayList)} to add tools from an external source

Parameters:

tools - The tools to add

Returns:

The OllamaObject.OllamaObjectBuilder

addTools

public OllamaObject.OllamaObjectBuilder addTools(OllamaTool... tools)

Adds tools to the Ollama Object Assumes the tools are from an external source, see addTools(Pair[])} to specify the source

Parameters:

tools - The tools to add

Returns:

The OllamaObject.OllamaObjectBuilder

addTools

@SafeVarargs
public final OllamaObject.OllamaObjectBuilder addTools(Pair<OllamaTool, String>... tools)

Adds tools to the Ollama Object This allows you to specify the source of the tools, see addTools(OllamaTool[]) to add tools from an external source

Parameters:

tools - The tools to add

Returns:

The OllamaObject.OllamaObjectBuilder

addMessages

public OllamaObject.OllamaObjectBuilder addMessages(OllamaMessage... messages)

Adds messages to the Ollama Object

Parameters:

messages - The messages to add

Returns:

The OllamaObject.OllamaObjectBuilder

addMessage

public OllamaObject.OllamaObjectBuilder addMessage(OllamaMessage messages)

Adds a message to the Ollama Object

Parameters:

messages - The message to add

Returns:

The OllamaObject.OllamaObjectBuilder

setModel

public OllamaObject.OllamaObjectBuilder setModel(String model)

Sets the model of the Ollama Object

Parameters:

model - The model of the Ollama Object

Returns:

The OllamaObject.OllamaObjectBuilder

addFileTools

public OllamaObject.OllamaObjectBuilder addFileTools(String baseDirectory)

Initializes the FileHandler singleton with the given base directory and adds its tools.

The FileHandler is intentionally constructed here rather than eagerly, as file access tooling should only be initialized if explicitly requested during object construction. Calling this after build() is technically possible but not intended.

Parameters:

baseDirectory - the base directory for file access, see FileHandlerLocation

Returns:

The OllamaObject.OllamaObjectBuilder

build

public OllamaObject build()

Builds the OllamaObject

Returns:

The OllamaObject