Class OpenAiOfficialChatModel.Builder

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialChatModel.Builder

Enclosing class:

OpenAiOfficialChatModel

public static class OpenAiOfficialChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialChatModel.Builder	apiKey(String apiKey)
OpenAiOfficialChatModel.Builder	azureDeploymentName(String azureDeploymentName)	Deprecated. Use microsoftFoundryDeploymentName(String) instead
OpenAiOfficialChatModel.Builder	azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
OpenAiOfficialChatModel.Builder	baseUrl(String baseUrl)
OpenAiOfficialChatModel	build()
OpenAiOfficialChatModel.Builder	credential(com.openai.credential.Credential credential)
OpenAiOfficialChatModel.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiOfficialChatModel.Builder	defaultRequestParameters(ChatRequestParameters parameters)	Sets default common ChatRequestParameters or OpenAI-specific OpenAiOfficialChatRequestParameters.
OpenAiOfficialChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
OpenAiOfficialChatModel.Builder	isAzure(boolean isAzure)	Deprecated. Use isMicrosoftFoundry(boolean) instead
OpenAiOfficialChatModel.Builder	isGitHubModels(boolean isGitHubModels)
OpenAiOfficialChatModel.Builder	isMicrosoftFoundry(boolean isMicrosoftFoundry)
OpenAiOfficialChatModel.Builder	listeners(List<ChatModelListener> listeners)
OpenAiOfficialChatModel.Builder	logitBias(Map<String,Integer> logitBias)
OpenAiOfficialChatModel.Builder	maxCompletionTokens(Integer maxCompletionTokens)
OpenAiOfficialChatModel.Builder	maxRetries(Integer maxRetries)
OpenAiOfficialChatModel.Builder	metadata(Map<String,String> metadata)
OpenAiOfficialChatModel.Builder	microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)
OpenAiOfficialChatModel.Builder	modelName(com.openai.models.ChatModel modelName)
OpenAiOfficialChatModel.Builder	modelName(String modelName)
OpenAiOfficialChatModel.Builder	openAIClient(com.openai.client.OpenAIClient openAIClient)
OpenAiOfficialChatModel.Builder	organizationId(String organizationId)
OpenAiOfficialChatModel.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiOfficialChatModel.Builder	presencePenalty(Double presencePenalty)
OpenAiOfficialChatModel.Builder	proxy(Proxy proxy)
OpenAiOfficialChatModel.Builder	responseFormat(String responseFormat)
OpenAiOfficialChatModel.Builder	seed(Integer seed)
OpenAiOfficialChatModel.Builder	serviceTier(String serviceTier)
OpenAiOfficialChatModel.Builder	stop(List<String> stop)
OpenAiOfficialChatModel.Builder	store(Boolean store)
OpenAiOfficialChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)
OpenAiOfficialChatModel.Builder	strictTools(Boolean strictTools)
OpenAiOfficialChatModel.Builder	supportedCapabilities(Set<Capability> capabilities)
OpenAiOfficialChatModel.Builder	temperature(Double temperature)
OpenAiOfficialChatModel.Builder	timeout(Duration timeout)
OpenAiOfficialChatModel.Builder	tokenCountEstimator(TokenCountEstimator tokenCountEstimator)
OpenAiOfficialChatModel.Builder	topP(Double topP)
OpenAiOfficialChatModel.Builder	user(String user)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

defaultRequestParameters

public OpenAiOfficialChatModel.Builder defaultRequestParameters(ChatRequestParameters parameters)

Sets default common ChatRequestParameters or OpenAI-specific OpenAiOfficialChatRequestParameters.
When a parameter is set via an individual builder method (e.g., modelName(String)), its value takes precedence over the same parameter set via ChatRequestParameters.

modelName

public OpenAiOfficialChatModel.Builder modelName(String modelName)

modelName

public OpenAiOfficialChatModel.Builder modelName(com.openai.models.ChatModel modelName)

baseUrl

public OpenAiOfficialChatModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiOfficialChatModel.Builder apiKey(String apiKey)

credential

public OpenAiOfficialChatModel.Builder credential(com.openai.credential.Credential credential)

azureDeploymentName

@Deprecated
public OpenAiOfficialChatModel.Builder azureDeploymentName(String azureDeploymentName)

Deprecated.

Use microsoftFoundryDeploymentName(String) instead

microsoftFoundryDeploymentName

public OpenAiOfficialChatModel.Builder microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)

azureOpenAIServiceVersion

public OpenAiOfficialChatModel.Builder azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)

organizationId

public OpenAiOfficialChatModel.Builder organizationId(String organizationId)

isGitHubModels

public OpenAiOfficialChatModel.Builder isGitHubModels(boolean isGitHubModels)

isAzure

@Deprecated
public OpenAiOfficialChatModel.Builder isAzure(boolean isAzure)

Deprecated.

Use isMicrosoftFoundry(boolean) instead

isMicrosoftFoundry

public OpenAiOfficialChatModel.Builder isMicrosoftFoundry(boolean isMicrosoftFoundry)

openAIClient

public OpenAiOfficialChatModel.Builder openAIClient(com.openai.client.OpenAIClient openAIClient)

temperature

public OpenAiOfficialChatModel.Builder temperature(Double temperature)

topP

public OpenAiOfficialChatModel.Builder topP(Double topP)

stop

public OpenAiOfficialChatModel.Builder stop(List<String> stop)

maxCompletionTokens

public OpenAiOfficialChatModel.Builder maxCompletionTokens(Integer maxCompletionTokens)

presencePenalty

public OpenAiOfficialChatModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public OpenAiOfficialChatModel.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

public OpenAiOfficialChatModel.Builder logitBias(Map<String,Integer> logitBias)

responseFormat

public OpenAiOfficialChatModel.Builder responseFormat(String responseFormat)

strictJsonSchema

public OpenAiOfficialChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

seed

public OpenAiOfficialChatModel.Builder seed(Integer seed)

user

public OpenAiOfficialChatModel.Builder user(String user)

strictTools

public OpenAiOfficialChatModel.Builder strictTools(Boolean strictTools)

parallelToolCalls

public OpenAiOfficialChatModel.Builder parallelToolCalls(Boolean parallelToolCalls)

store

public OpenAiOfficialChatModel.Builder store(Boolean store)

metadata

public OpenAiOfficialChatModel.Builder metadata(Map<String,String> metadata)

serviceTier

public OpenAiOfficialChatModel.Builder serviceTier(String serviceTier)

timeout

public OpenAiOfficialChatModel.Builder timeout(Duration timeout)

maxRetries

public OpenAiOfficialChatModel.Builder maxRetries(Integer maxRetries)

proxy

public OpenAiOfficialChatModel.Builder proxy(Proxy proxy)

tokenCountEstimator

public OpenAiOfficialChatModel.Builder tokenCountEstimator(TokenCountEstimator tokenCountEstimator)

customHeaders

public OpenAiOfficialChatModel.Builder customHeaders(Map<String,String> customHeaders)

listeners

public OpenAiOfficialChatModel.Builder listeners(List<ChatModelListener> listeners)

supportedCapabilities

public OpenAiOfficialChatModel.Builder supportedCapabilities(Set<Capability> capabilities)

build

public OpenAiOfficialChatModel build()