dev.ai4j.openai4j

Class OpenAiClient.Builder

java.lang.Object

dev.ai4j.openai4j.OpenAiClient.Builder

Enclosing class:

OpenAiClient

public static class OpenAiClient.Builder
extends Object

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

baseUrl

public OpenAiClient.Builder 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 OpenAiClient.Builder apiVersion(String apiVersion)

Parameters:

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

Returns:

builder

openAiApiKey

public OpenAiClient.Builder openAiApiKey(String openAiApiKey)

Parameters:

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

Returns:

builder

azureApiKey

public OpenAiClient.Builder azureApiKey(String azureApiKey)

Parameters:

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

Returns:

builder

callTimeout

public OpenAiClient.Builder callTimeout(Duration callTimeout)

connectTimeout

public OpenAiClient.Builder connectTimeout(Duration connectTimeout)

readTimeout

public OpenAiClient.Builder readTimeout(Duration readTimeout)

writeTimeout

public OpenAiClient.Builder writeTimeout(Duration writeTimeout)

proxy

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

proxy

public OpenAiClient.Builder proxy(Proxy proxy)

logRequests

public OpenAiClient.Builder logRequests()

logRequests

public OpenAiClient.Builder logRequests(Boolean logRequests)

logResponses

public OpenAiClient.Builder logResponses()

logResponses

public OpenAiClient.Builder logResponses(Boolean logResponses)

logStreamingResponses

public OpenAiClient.Builder logStreamingResponses()

logStreamingResponses

public OpenAiClient.Builder logStreamingResponses(Boolean logStreamingResponses)

build

public OpenAiClient build()