dev.ai4j.openai4j

Class OpenAiClient.Builder<T extends OpenAiClient,B extends OpenAiClient.Builder<T,B>>

java.lang.Object

dev.ai4j.openai4j.OpenAiClient.Builder<T,B>

Direct Known Subclasses:

DefaultOpenAiClient.Builder

Enclosing class:

OpenAiClient

public abstract static class OpenAiClient.Builder<T extends OpenAiClient,B extends OpenAiClient.Builder<T,B>>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	apiVersion
String	azureApiKey
String	baseUrl
Duration	callTimeout
Duration	connectTimeout
boolean	logRequests
boolean	logResponses
boolean	logStreamingResponses
String	openAiApiKey
Proxy	proxy
Duration	readTimeout
Duration	writeTimeout

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
B	apiVersion(String apiVersion)
B	azureApiKey(String azureApiKey)
B	baseUrl(String baseUrl)
abstract T	build()
B	callTimeout(Duration callTimeout)
B	connectTimeout(Duration connectTimeout)
B	logRequests()
B	logRequests(Boolean logRequests)
B	logResponses()
B	logResponses(Boolean logResponses)
B	logStreamingResponses()
B	logStreamingResponses(Boolean logStreamingResponses)
B	openAiApiKey(String openAiApiKey)
B	proxy(Proxy.Type type, String ip, int port)
B	proxy(Proxy proxy)
B	readTimeout(Duration readTimeout)
B	writeTimeout(Duration writeTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

public String baseUrl

apiVersion

public String apiVersion

openAiApiKey

public String openAiApiKey

azureApiKey

public String azureApiKey

callTimeout

public Duration callTimeout

connectTimeout

public Duration connectTimeout

readTimeout

public Duration readTimeout

writeTimeout

public Duration writeTimeout

proxy

public Proxy proxy

logRequests

public boolean logRequests

logResponses

public boolean logResponses

logStreamingResponses

public boolean logStreamingResponses

Constructor Detail

Builder

public Builder()

Method Detail

build

public abstract T build()

baseUrl

public B baseUrl(String baseUrl)

Parameters:

baseUrl - Base URL of OpenAI API. For OpenAI (default): "https://api.openai.com/v1/" For Azure OpenAI: "https://{resource-name}.openai.azure.com/openai/deployments/{deployment-id}/"

Returns:

builder

apiVersion

public B apiVersion(String apiVersion)

Parameters:

apiVersion - Version of the API in the YYYY-MM-DD format. Applicable only for Azure OpenAI.

Returns:

builder

openAiApiKey

public B openAiApiKey(String openAiApiKey)

Parameters:

openAiApiKey - OpenAI API key. Will be injected in HTTP headers like this: "Authorization: Bearer ${openAiApiKey}"

Returns:

builder

azureApiKey

public B azureApiKey(String azureApiKey)

Parameters:

azureApiKey - Azure API key. Will be injected in HTTP headers like this: "api-key: ${azureApiKey}"

Returns:

builder

callTimeout

public B callTimeout(Duration callTimeout)

connectTimeout

public B connectTimeout(Duration connectTimeout)

readTimeout

public B readTimeout(Duration readTimeout)

writeTimeout

public B writeTimeout(Duration writeTimeout)

proxy

public B proxy(Proxy.Type type,
               String ip,
               int port)

proxy

public B proxy(Proxy proxy)

logRequests

public B logRequests()

logRequests

public B logRequests(Boolean logRequests)

logResponses

public B logResponses()

logResponses

public B logResponses(Boolean logResponses)

logStreamingResponses

public B logStreamingResponses()

logStreamingResponses

public B logStreamingResponses(Boolean logStreamingResponses)