Package org.machanism.machai.ai.openAI

Class OpenAIProvider

java.lang.Object

org.machanism.machai.ai.openAI.OpenAIProvider

All Implemented Interfaces:

GenAIProvider

public class OpenAIProvider
extends Object
implements GenAIProvider

The `OpenAIProvider` class integrates seamlessly with the OpenAI API, serving as a concrete implementation of the `GenAIProvider` interface. This provider enables a wide range of generative AI capabilities, including: - Sending prompts and receiving responses from OpenAI Chat models. - Managing files for use in various OpenAI workflows. - Performing advanced large language model (LLM) requests, such as text generation, summarization, and question answering. - Creating and utilizing vector embeddings for tasks like semantic search and similarity analysis. By abstracting the complexities of direct API interaction, `OpenAIProvider` allows developers to leverage OpenAI’s powerful models efficiently within their applications. It supports both synchronous and asynchronous operations, and can be easily extended or configured to accommodate different use cases and model parameters.

This class provides capabilities to send prompts, manage files, perform LLM requests, and create embeddings using OpenAI Chat models.

Usage example:

 GenAIProvider provider = GenAIProviderManager.getProvider("OpenAI:gpt-5.1");
 

Thread safety: This implementation is NOT thread-safe.

Since:

0.0.2

Author:

Viktor Tovstyi

Constructor Summary

Constructors

Constructor	Description
OpenAIProvider()

Method Summary

Modifier and Type	Method	Description
void	addFile(File file)	Uploads a file to OpenAI and adds its reference as input.
void	addFile(URL fileUrl)	Adds input from a file by URL.
void	addTool(String name, String description, Function<Object[],Object> function, String... paramsDesc)	Adds a tool to the current session, providing its function handler.
void	clear()	Clears all input items for the next request.
List<Float>	embedding(String text)	Requests embeddings for the given text using the current embedding model.
void	inputsLog(File inputsLog)	Set the file used for logging model inputs.
void	instructions(String instructions)	Sets instructions for the model to use in the session.
void	model(String chatModelName)	Initializes the chat model and OpenAI client.
String	perform()	Performs a request using current inputs and returns the response string.
void	prompt(String text)	Adds a text prompt to the current conversation.
void	promptBundle(ResourceBundle promptBundle)	Set the ResourceBundle for prompts.
void	promptFile(File file, String bundleMessageName)	Adds a prompt from a file, formatting the file content according to a ResourceBundle message.
void	setWorkingDir(File workingDir)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAIProvider

public OpenAIProvider()

Method Details

prompt

public void prompt(String text)

Adds a text prompt to the current conversation.

Specified by:

prompt in interface GenAIProvider

Parameters:

text - the prompt string

promptFile

public void promptFile(File file,
 String bundleMessageName)
                throws IOException

Adds a prompt from a file, formatting the file content according to a ResourceBundle message.

Specified by:

promptFile in interface GenAIProvider

Parameters:

file - the file containing prompt data

bundleMessageName - key for message in ResourceBundle, or null for raw file content

Throws:

IOException - if reading the file fails

addFile

public void addFile(File file)
             throws IOException,
FileNotFoundException

Uploads a file to OpenAI and adds its reference as input.

Specified by:

addFile in interface GenAIProvider

Parameters:

file - local file to upload

Throws:

IOException - if reading file fails

FileNotFoundException - if file is missing

addFile

public void addFile(URL fileUrl)
             throws IOException,
FileNotFoundException

Adds input from a file by URL.

Specified by:

addFile in interface GenAIProvider

Parameters:

fileUrl - the URL of the input file

Throws:

IOException - on network error

FileNotFoundException - if the file cannot be found

perform

public String perform()

Performs a request using current inputs and returns the response string.

Specified by:

perform in interface GenAIProvider

Returns:

the model response

embedding

public List<Float> embedding(String text)

Requests embeddings for the given text using the current embedding model.

Specified by:

embedding in interface GenAIProvider

Parameters:

text - input to embed

Returns:

embedding as a list of float values

clear

public void clear()

Clears all input items for the next request.

Specified by:

clear in interface GenAIProvider

addTool

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

Adds a tool to the current session, providing its function handler.

Specified by:

addTool in interface GenAIProvider

Parameters:

name - tool function name

description - tool description

function - handler callback for tool execution

paramsDesc - array of parameter descriptions in format name:type:required:description

instructions

public void instructions(String instructions)

Sets instructions for the model to use in the session.

Specified by:

instructions in interface GenAIProvider

Parameters:

instructions - text for model instructions

promptBundle

public void promptBundle(ResourceBundle promptBundle)

Set the ResourceBundle for prompts.

Parameters:

promptBundle - ResourceBundle instance

inputsLog

public void inputsLog(File inputsLog)

Set the file used for logging model inputs.

Specified by:

inputsLog in interface GenAIProvider

Parameters:

inputsLog - file for input logging

model

public void model(String chatModelName)

Initializes the chat model and OpenAI client. Requires OPENAI_API_KEY environment variable to be set.

Specified by:

model in interface GenAIProvider

Parameters:

chatModelName - the model name (e.g., "gpt-4")

Throws:

RuntimeException - if API key is missing

setWorkingDir

public void setWorkingDir(File workingDir)

Specified by:

setWorkingDir in interface GenAIProvider