Package org.machanism.machai.ai.manager

Interface GenAIProvider

All Known Implementing Classes:

NoneProvider, OpenAIProvider, WebProvider

public interface GenAIProvider

Interface for generic AI providers (GenAIProvider) supporting prompts, file operations, and tool augmentation.

Implementations should provide concrete behavior for each method, supporting model-specific logic, resource/file handling, embeddings, and extensibility through function tools.

Usage example:

 provider.prompt("Hello!");
 provider.addFile(new File("some.txt"));
 List<Float> emb = provider.embedding("any text");
 

Author:

Viktor Tovstyi

Method Summary

Modifier and Type	Method	Description
void	addFile(File file)	Adds a file for processing.
void	addFile(URL fileUrl)	Adds a file via a URL (downloads/uses remote file).
void	addTool(String name, String description, Function<Object[],Object> function, String... paramsDesc)	Adds a custom function tool to the provider for runtime invocation.
void	clear()	Clears all internal state and stored files for this provider instance.
List<Float>	embedding(String text)	Returns the embedding vector for the supplied string using the underlying model.
void	inputsLog(File bindexTempDir)	Logs input events, optionally into a temporary directory.
void	instructions(String instructions)	Sets or updates instruction text for the provider session.
void	model(String chatModelName)	Selects the model name for this provider instance.
String	perform()	Performs the main action, typically runs or triggers model output.
void	prompt(String text)	Sends a prompt string to the provider.
void	promptFile(File file, String bundleMessageName)	Sends a prompt using the contents of a file.
void	setWorkingDir(File workingDir)

Method Details

prompt

void prompt(String text)

Sends a prompt string to the provider.

Parameters:

text - The input prompt string

promptFile

void promptFile(File file,
 String bundleMessageName)
         throws IOException

Sends a prompt using the contents of a file.

Parameters:

file - The input file

bundleMessageName - The message identifier or bundle

Throws:

IOException - If file cannot be read

addFile

void addFile(File file)
      throws IOException,
FileNotFoundException

Adds a file for processing.

Parameters:

file - File to be added

Throws:

IOException - For IO/file errors

FileNotFoundException - If file cannot be found

addFile

void addFile(URL fileUrl)
      throws IOException,
FileNotFoundException

Adds a file via a URL (downloads/uses remote file).

Parameters:

fileUrl - URL for file

Throws:

IOException - For IO/file errors

FileNotFoundException - If remote file cannot be found

embedding

List<Float> embedding(String text)

Returns the embedding vector for the supplied string using the underlying model.

Parameters:

text - Input string to embed

Returns:

List of floats representing the embedding

clear

void clear()

Clears all internal state and stored files for this provider instance.

addTool

void addTool(String name,
 String description,
 Function<Object[],Object> function,
 String... paramsDesc)

Adds a custom function tool to the provider for runtime invocation.

Parameters:

name - Tool/function name

description - Description of function/tool

function - The function accepting a JsonNode and returning an Object

paramsDesc - Parameter descriptions

instructions

void instructions(String instructions)

Sets or updates instruction text for the provider session.

Parameters:

instructions - Usage/setup instructions

perform

String perform()

Performs the main action, typically runs or triggers model output.

Returns:

Output result or response

inputsLog

void inputsLog(File bindexTempDir)

Logs input events, optionally into a temporary directory.

Parameters:

bindexTempDir - Directory for writing logs

model

void model(String chatModelName)

Selects the model name for this provider instance.

Parameters:

chatModelName - The name of the model in use

setWorkingDir

void setWorkingDir(File workingDir)