com.aspose.slides

Class OpenAIWebClient

java.lang.Object

com.aspose.slides.OpenAIWebClient

All Implemented Interfaces:

IAIWebClient, java.io.Closeable, java.lang.AutoCloseable

public class OpenAIWebClient
extends java.lang.Object
implements IAIWebClient, java.io.Closeable

Build-in lightweight OpenAI web client

Constructor Summary

Constructors

Constructor and Description
OpenAIWebClient(java.lang.String model, java.lang.String apiKey, java.lang.String organizationId) Creates instance of OpenAI Web client.
OpenAIWebClient(java.lang.String model, java.lang.String apiKey, java.lang.String organizationId, java.net.HttpURLConnection httpClient) Creates instance of OpenAI Web client.

Method Summary

Modifier and Type	Method and Description
java.lang.String	callChat(java.lang.String instruction) Sends a chat instruction to the AI model using an externally managed instance and returns response message to the given instruction.
void	close() Releases resources used by this instance.
IAIConversation	createConversation() Creates a conversation instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAIWebClient

public OpenAIWebClient(java.lang.String model,
                       java.lang.String apiKey,
                       java.lang.String organizationId)

Creates instance of OpenAI Web client.

Parameters:

model - OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini

apiKey - OpenAI API key

organizationId - Organization ID (optional)

Throws:

com.aspose.ms.System.ArgumentException - API key value can't be null or empty

com.aspose.ms.System.ArgumentException - Text model value can't be null or empty

OpenAIWebClient

public OpenAIWebClient(java.lang.String model,
                       java.lang.String apiKey,
                       java.lang.String organizationId,
                       java.net.HttpURLConnection httpClient)

Creates instance of OpenAI Web client.

Parameters:

model - OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini

apiKey - OpenAI API key

organizationId - Organization ID (optional)

httpClient - An externally managed `HttpURLConnection` instance.

Throws:

com.aspose.ms.System.ArgumentException - API key value can't be null or empty

com.aspose.ms.System.ArgumentException - Text model value can't be null or empty

Method Detail

callChat

public java.lang.String callChat(java.lang.String instruction)

Sends a chat instruction to the AI model using an externally managed instance and returns response message to the given instruction.

Specified by:

callChat in interface IAIWebClient

Parameters:

instruction - The instruction or message to be processed by the AI model

Returns:

The message generated by the AI model in response to the given instruction.

Throws:

com.aspose.ms.System.ArgumentException - Open AI chat instruction can't be null or empty.

com.aspose.ms.System.OperationCanceledException - If the current thread was interrupted while waiting.

createConversation

public final IAIConversation createConversation()

Creates a conversation instance. Unlike regular AI calls, conversations retain the entire context.

Specified by:

createConversation in interface IAIWebClient

Returns:

An IAIConversation instance.

close

public final void close()

Releases resources used by this instance.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable