Package com.developer.nefarious.zjoule.plugin.chat.openai

Class OpenAIClient

java.lang.Object

com.developer.nefarious.zjoule.plugin.chat.openai.OpenAIClient

All Implemented Interfaces:

IAIClient

public class OpenAIClient
extends Object
implements IAIClient

Implements the IAIClient interface for interacting with OpenAI-based models. The OpenAIClient handles chat completion requests, message creation, and management of chat message history.

Constructor Summary

Constructors

Constructor	Description
OpenAIClient(IAuthClient authClient, IMemoryMessageHistory memoryMessageHistory, IMemoryObject<String> memoryResourceGroup, IMemoryObject<Deployment> memoryDeployment, IOpenAIClientHelper openAIClientHelper)	Constructs a new OpenAIClient with the required dependencies.

Method Summary

Modifier and Type	Method	Description
IChatMessage	chatCompletion(List<IChatMessage> messages)	Sends a chat completion request to the OpenAI service and retrieves the AI-generated response.
OpenAIChatMessage	createMessage(Role role, String userPrompt)	Creates a chat message with the specified role and content.
List<IChatMessage>	getMessageHistory()	Retrieves the chat message history stored in memory.
void	setMessageHistory(List<IChatMessage> chatMessages)	Stores the chat message history in memory.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAIClient

public OpenAIClient(IAuthClient authClient,
 IMemoryMessageHistory memoryMessageHistory,
 IMemoryObject<String> memoryResourceGroup,
 IMemoryObject<Deployment> memoryDeployment,
 IOpenAIClientHelper openAIClientHelper)

Constructs a new OpenAIClient with the required dependencies.

Parameters:

authClient - the authentication client for retrieving tokens and service URLs.

memoryMessageHistory - the memory component for managing chat history.

memoryResourceGroup - the memory component for resource group information.

memoryDeployment - the memory component for deployment details.

openAIClientHelper - the helper for constructing requests and processing responses.

Method Details

chatCompletion

public IChatMessage chatCompletion(List<IChatMessage> messages)
                            throws IOException,
InterruptedException

Sends a chat completion request to the OpenAI service and retrieves the AI-generated response.

Specified by:

chatCompletion in interface IAIClient

Parameters:

messages - the list of IChatMessage objects representing the chat context.

Returns:

the AI-generated response as an IChatMessage.

Throws:

IOException - if an I/O error occurs during the request.

InterruptedException - if the operation is interrupted.

createMessage

public OpenAIChatMessage createMessage(Role role,
 String userPrompt)

Creates a chat message with the specified role and content.

Specified by:

createMessage in interface IAIClient

Parameters:

role - the role of the message (e.g., Role.USER, Role.SYSTEM).

userPrompt - the content of the message.

Returns:

a new OpenAIChatMessage instance.

getMessageHistory

public List<IChatMessage> getMessageHistory()

Retrieves the chat message history stored in memory.

Specified by:

getMessageHistory in interface IAIClient

Returns:

a list of IChatMessage objects representing the chat history.

setMessageHistory

public void setMessageHistory(List<IChatMessage> chatMessages)

Stores the chat message history in memory.

Specified by:

setMessageHistory in interface IAIClient

Parameters:

chatMessages - the list of IChatMessage objects to save as chat history.