Class OpenAiOfficialBatchChatModel.Builder

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialBatchChatModel.Builder

Enclosing class:

OpenAiOfficialBatchChatModel

public static class OpenAiOfficialBatchChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialBatchChatModel.Builder	apiKey(String apiKey)
OpenAiOfficialBatchChatModel.Builder	azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
OpenAiOfficialBatchChatModel.Builder	baseUrl(String baseUrl)
OpenAiOfficialBatchChatModel.Builder	batchMetadata(Map<String,String> batchMetadata)	Sets the metadata attached to the batch itself, which OpenAI returns when the batch is retrieved or listed.
OpenAiOfficialBatchChatModel	build()
OpenAiOfficialBatchChatModel.Builder	completionWindow(String completionWindow)	Sets the time frame within which the batch should be processed.
OpenAiOfficialBatchChatModel.Builder	credential(com.openai.credential.Credential credential)
OpenAiOfficialBatchChatModel.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiOfficialBatchChatModel.Builder	defaultRequestParameters(ChatRequestParameters parameters)	Sets default common ChatRequestParameters or OpenAI-specific OpenAiOfficialChatRequestParameters.
OpenAiOfficialBatchChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
OpenAiOfficialBatchChatModel.Builder	inputFileExpiresAfter(Duration inputFileExpiresAfter)	Sets how long after upload the JSONL input file expires.
OpenAiOfficialBatchChatModel.Builder	isGitHubModels(boolean isGitHubModels)
OpenAiOfficialBatchChatModel.Builder	isMicrosoftFoundry(boolean isMicrosoftFoundry)
OpenAiOfficialBatchChatModel.Builder	logitBias(Map<String,Integer> logitBias)
OpenAiOfficialBatchChatModel.Builder	maxCompletionTokens(Integer maxCompletionTokens)
OpenAiOfficialBatchChatModel.Builder	maxRetries(Integer maxRetries)
OpenAiOfficialBatchChatModel.Builder	metadata(Map<String,String> metadata)	Sets the metadata sent with every chat request in the batch.
OpenAiOfficialBatchChatModel.Builder	microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)
OpenAiOfficialBatchChatModel.Builder	modelName(com.openai.models.ChatModel modelName)
OpenAiOfficialBatchChatModel.Builder	modelName(String modelName)
OpenAiOfficialBatchChatModel.Builder	openAIClient(com.openai.client.OpenAIClient openAIClient)
OpenAiOfficialBatchChatModel.Builder	organizationId(String organizationId)
OpenAiOfficialBatchChatModel.Builder	outputExpiresAfter(Duration outputExpiresAfter)	Sets how long after the output file is created it, and the error file, expire.
OpenAiOfficialBatchChatModel.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiOfficialBatchChatModel.Builder	presencePenalty(Double presencePenalty)
OpenAiOfficialBatchChatModel.Builder	proxy(Proxy proxy)
OpenAiOfficialBatchChatModel.Builder	responseFormat(String responseFormat)
OpenAiOfficialBatchChatModel.Builder	seed(Integer seed)
OpenAiOfficialBatchChatModel.Builder	serviceTier(String serviceTier)
OpenAiOfficialBatchChatModel.Builder	stop(List<String> stop)
OpenAiOfficialBatchChatModel.Builder	store(Boolean store)
OpenAiOfficialBatchChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)
OpenAiOfficialBatchChatModel.Builder	strictTools(Boolean strictTools)
OpenAiOfficialBatchChatModel.Builder	temperature(Double temperature)
OpenAiOfficialBatchChatModel.Builder	timeout(Duration timeout)
OpenAiOfficialBatchChatModel.Builder	topP(Double topP)
OpenAiOfficialBatchChatModel.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 OpenAiOfficialBatchChatModel.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 OpenAiOfficialBatchChatModel.Builder modelName(String modelName)

modelName

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

baseUrl

public OpenAiOfficialBatchChatModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiOfficialBatchChatModel.Builder apiKey(String apiKey)

credential

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

microsoftFoundryDeploymentName

public OpenAiOfficialBatchChatModel.Builder microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)

azureOpenAIServiceVersion

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

organizationId

public OpenAiOfficialBatchChatModel.Builder organizationId(String organizationId)

isGitHubModels

public OpenAiOfficialBatchChatModel.Builder isGitHubModels(boolean isGitHubModels)

isMicrosoftFoundry

public OpenAiOfficialBatchChatModel.Builder isMicrosoftFoundry(boolean isMicrosoftFoundry)

openAIClient

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

temperature

public OpenAiOfficialBatchChatModel.Builder temperature(Double temperature)

topP

public OpenAiOfficialBatchChatModel.Builder topP(Double topP)

stop

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

maxCompletionTokens

public OpenAiOfficialBatchChatModel.Builder maxCompletionTokens(Integer maxCompletionTokens)

presencePenalty

public OpenAiOfficialBatchChatModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public OpenAiOfficialBatchChatModel.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

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

responseFormat

public OpenAiOfficialBatchChatModel.Builder responseFormat(String responseFormat)

strictJsonSchema

public OpenAiOfficialBatchChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

seed

public OpenAiOfficialBatchChatModel.Builder seed(Integer seed)

user

public OpenAiOfficialBatchChatModel.Builder user(String user)

strictTools

public OpenAiOfficialBatchChatModel.Builder strictTools(Boolean strictTools)

parallelToolCalls

public OpenAiOfficialBatchChatModel.Builder parallelToolCalls(Boolean parallelToolCalls)

store

public OpenAiOfficialBatchChatModel.Builder store(Boolean store)

metadata

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

Sets the metadata sent with every chat request in the batch.

See Also:

• batchMetadata(Map)

serviceTier

public OpenAiOfficialBatchChatModel.Builder serviceTier(String serviceTier)

completionWindow

public OpenAiOfficialBatchChatModel.Builder completionWindow(String completionWindow)

Sets the time frame within which the batch should be processed. Defaults to 24h, which is currently the only value accepted by OpenAI.

batchMetadata

public OpenAiOfficialBatchChatModel.Builder batchMetadata(Map<String,String> batchMetadata)

Sets the metadata attached to the batch itself, which OpenAI returns when the batch is retrieved or listed. This is distinct from metadata(Map), which is sent with every chat request inside the batch.

inputFileExpiresAfter

public OpenAiOfficialBatchChatModel.Builder inputFileExpiresAfter(Duration inputFileExpiresAfter)

Sets how long after upload the JSONL input file expires. Not set by default, in which case the provider's own retention for batch input files applies and the file is kept until it is deleted. The accepted range is defined by the provider and differs between OpenAI and Azure OpenAI. Values are sent with a whole-second resolution.

outputExpiresAfter

public OpenAiOfficialBatchChatModel.Builder outputExpiresAfter(Duration outputExpiresAfter)

Sets how long after the output file is created it, and the error file, expire. Not set by default, in which case the provider's own retention applies. The accepted range is defined by the provider and differs between OpenAI and Azure OpenAI. Values are sent with a whole-second resolution.

timeout

public OpenAiOfficialBatchChatModel.Builder timeout(Duration timeout)

maxRetries

public OpenAiOfficialBatchChatModel.Builder maxRetries(Integer maxRetries)

proxy

public OpenAiOfficialBatchChatModel.Builder proxy(Proxy proxy)

customHeaders

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

build

public OpenAiOfficialBatchChatModel build()