Class OpenAiOfficialResponsesChatModel.Builder

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialResponsesChatModel.Builder

Enclosing class:

OpenAiOfficialResponsesChatModel

public static class OpenAiOfficialResponsesChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialResponsesChatModel.Builder	apiKey(String apiKey)
OpenAiOfficialResponsesChatModel.Builder	azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
OpenAiOfficialResponsesChatModel.Builder	baseUrl(String baseUrl)
OpenAiOfficialResponsesChatModel	build()
OpenAiOfficialResponsesChatModel.Builder	client(com.openai.client.OpenAIClient client)
OpenAiOfficialResponsesChatModel.Builder	credential(com.openai.credential.Credential credential)
OpenAiOfficialResponsesChatModel.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiOfficialResponsesChatModel.Builder	defaultRequestParameters(ChatRequestParameters defaultRequestParameters)
OpenAiOfficialResponsesChatModel.Builder	include(List<String> include)
OpenAiOfficialResponsesChatModel.Builder	isGitHubModels(boolean isGitHubModels)
OpenAiOfficialResponsesChatModel.Builder	isMicrosoftFoundry(boolean isMicrosoftFoundry)
OpenAiOfficialResponsesChatModel.Builder	listeners(ChatModelListener... listeners)
OpenAiOfficialResponsesChatModel.Builder	listeners(List<ChatModelListener> listeners)
OpenAiOfficialResponsesChatModel.Builder	maxOutputTokens(Integer maxOutputTokens)
OpenAiOfficialResponsesChatModel.Builder	maxRetries(Integer maxRetries)
OpenAiOfficialResponsesChatModel.Builder	maxToolCalls(Integer maxToolCalls)
OpenAiOfficialResponsesChatModel.Builder	microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)
OpenAiOfficialResponsesChatModel.Builder	modelName(String modelName)
OpenAiOfficialResponsesChatModel.Builder	organizationId(String organizationId)
OpenAiOfficialResponsesChatModel.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiOfficialResponsesChatModel.Builder	previousResponseId(String previousResponseId)
OpenAiOfficialResponsesChatModel.Builder	promptCacheKey(String promptCacheKey)
OpenAiOfficialResponsesChatModel.Builder	promptCacheRetention(String promptCacheRetention)
OpenAiOfficialResponsesChatModel.Builder	proxy(Proxy proxy)
OpenAiOfficialResponsesChatModel.Builder	reasoningEffort(com.openai.models.ReasoningEffort reasoningEffort)
OpenAiOfficialResponsesChatModel.Builder	reasoningSummary(com.openai.models.Reasoning.Summary reasoningSummary)
OpenAiOfficialResponsesChatModel.Builder	responseFormat(ResponseFormat responseFormat)
OpenAiOfficialResponsesChatModel.Builder	safetyIdentifier(String safetyIdentifier)
OpenAiOfficialResponsesChatModel.Builder	serviceTier(String serviceTier)	When Enterprise Open AI subscription is used, service tier = "priority" puts requests into a faster pool.
OpenAiOfficialResponsesChatModel.Builder	store(Boolean store)
OpenAiOfficialResponsesChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)
OpenAiOfficialResponsesChatModel.Builder	strictTools(Boolean strictTools)
OpenAiOfficialResponsesChatModel.Builder	temperature(Double temperature)
OpenAiOfficialResponsesChatModel.Builder	textVerbosity(String textVerbosity)
OpenAiOfficialResponsesChatModel.Builder	timeout(Duration timeout)
OpenAiOfficialResponsesChatModel.Builder	toolChoice(ToolChoice toolChoice)
OpenAiOfficialResponsesChatModel.Builder	toolSpecifications(ToolSpecification... toolSpecifications)
OpenAiOfficialResponsesChatModel.Builder	toolSpecifications(List<ToolSpecification> toolSpecifications)
OpenAiOfficialResponsesChatModel.Builder	topLogprobs(Integer topLogprobs)
OpenAiOfficialResponsesChatModel.Builder	topP(Double topP)
OpenAiOfficialResponsesChatModel.Builder	truncation(String truncation)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

baseUrl

public OpenAiOfficialResponsesChatModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiOfficialResponsesChatModel.Builder apiKey(String apiKey)

credential

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

microsoftFoundryDeploymentName

public OpenAiOfficialResponsesChatModel.Builder microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)

azureOpenAIServiceVersion

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

organizationId

public OpenAiOfficialResponsesChatModel.Builder organizationId(String organizationId)

isMicrosoftFoundry

public OpenAiOfficialResponsesChatModel.Builder isMicrosoftFoundry(boolean isMicrosoftFoundry)

isGitHubModels

public OpenAiOfficialResponsesChatModel.Builder isGitHubModels(boolean isGitHubModels)

customHeaders

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

timeout

public OpenAiOfficialResponsesChatModel.Builder timeout(Duration timeout)

maxRetries

public OpenAiOfficialResponsesChatModel.Builder maxRetries(Integer maxRetries)

proxy

public OpenAiOfficialResponsesChatModel.Builder proxy(Proxy proxy)

client

public OpenAiOfficialResponsesChatModel.Builder client(com.openai.client.OpenAIClient client)

modelName

public OpenAiOfficialResponsesChatModel.Builder modelName(String modelName)

temperature

public OpenAiOfficialResponsesChatModel.Builder temperature(Double temperature)

topP

public OpenAiOfficialResponsesChatModel.Builder topP(Double topP)

maxOutputTokens

public OpenAiOfficialResponsesChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

maxToolCalls

public OpenAiOfficialResponsesChatModel.Builder maxToolCalls(Integer maxToolCalls)

parallelToolCalls

public OpenAiOfficialResponsesChatModel.Builder parallelToolCalls(Boolean parallelToolCalls)

previousResponseId

public OpenAiOfficialResponsesChatModel.Builder previousResponseId(String previousResponseId)

topLogprobs

public OpenAiOfficialResponsesChatModel.Builder topLogprobs(Integer topLogprobs)

truncation

public OpenAiOfficialResponsesChatModel.Builder truncation(String truncation)

include

public OpenAiOfficialResponsesChatModel.Builder include(List<String> include)

serviceTier

public OpenAiOfficialResponsesChatModel.Builder serviceTier(String serviceTier)

When Enterprise Open AI subscription is used, service tier = "priority" puts requests into a faster pool.

safetyIdentifier

public OpenAiOfficialResponsesChatModel.Builder safetyIdentifier(String safetyIdentifier)

promptCacheKey

public OpenAiOfficialResponsesChatModel.Builder promptCacheKey(String promptCacheKey)

promptCacheRetention

public OpenAiOfficialResponsesChatModel.Builder promptCacheRetention(String promptCacheRetention)

reasoningEffort

public OpenAiOfficialResponsesChatModel.Builder reasoningEffort(com.openai.models.ReasoningEffort reasoningEffort)

reasoningSummary

public OpenAiOfficialResponsesChatModel.Builder reasoningSummary(com.openai.models.Reasoning.Summary reasoningSummary)

textVerbosity

public OpenAiOfficialResponsesChatModel.Builder textVerbosity(String textVerbosity)

store

public OpenAiOfficialResponsesChatModel.Builder store(Boolean store)

listeners

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

listeners

public OpenAiOfficialResponsesChatModel.Builder listeners(ChatModelListener... listeners)

strictTools

public OpenAiOfficialResponsesChatModel.Builder strictTools(Boolean strictTools)

strictJsonSchema

public OpenAiOfficialResponsesChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

toolSpecifications

public OpenAiOfficialResponsesChatModel.Builder toolSpecifications(List<ToolSpecification> toolSpecifications)

toolSpecifications

public OpenAiOfficialResponsesChatModel.Builder toolSpecifications(ToolSpecification... toolSpecifications)

toolChoice

public OpenAiOfficialResponsesChatModel.Builder toolChoice(ToolChoice toolChoice)

responseFormat

public OpenAiOfficialResponsesChatModel.Builder responseFormat(ResponseFormat responseFormat)

defaultRequestParameters

public OpenAiOfficialResponsesChatModel.Builder defaultRequestParameters(ChatRequestParameters defaultRequestParameters)

build

public OpenAiOfficialResponsesChatModel build()