OpenAIWebClient

OpenAIWebClient class

Build-in lightweight OpenAI web client

OpenAIWebClient

Name	Description
OpenAIWebClient(String, String, String)	Creates instance of OpenAI Web client.

Parameters:

Name	Type	Description
model	String	OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini
apiKey	String	OpenAI API key
organizationId	String	Organization ID (optional)

Returns: OpenAIWebClient

Error

Error	Condition
ArgumentException	Text model value can’t be null or empty

---

OpenAIWebClient

Name	Description
OpenAIWebClient(String, String, String, HttpURLConnection)	Creates instance of OpenAI Web client.

Parameters:

Name	Type	Description
model	String	OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini
apiKey	String	OpenAI API key
organizationId	String	Organization ID (optional)
httpClient	HttpURLConnection	An externally managed HttpURLConnection instance.

Returns: OpenAIWebClient

Error

Error	Condition
ArgumentException	Text model value can’t be null or empty

---

callChat

Name	Description
callChat (String)	Sends a chat instruction to the AI model using an externally managed instance and returns response message to the given instruction.

Parameters:

Name	Type	Description
instruction	String	The instruction or message to be processed by the AI model

Returns: String

Exception

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

---

close

Name	Description
close ()	Releases resources used by this instance.

Returns: void

---

createConversation

Name	Description
createConversation ()	Creates a conversation instance. Unlike regular AI calls, conversations retain the entire context.

Returns: OpenAIConversation

---