Class OpenAiOfficialResponsesStreamingChatModel.Builder

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialResponsesStreamingChatModel.Builder

Enclosing class:

OpenAiOfficialResponsesStreamingChatModel

public static class OpenAiOfficialResponsesStreamingChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialResponsesStreamingChatModel.Builder	apiKey(String apiKey)
OpenAiOfficialResponsesStreamingChatModel.Builder	azureDeploymentName(String azureDeploymentName)	Deprecated. Use microsoftFoundryDeploymentName(String) instead
OpenAiOfficialResponsesStreamingChatModel.Builder	azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
OpenAiOfficialResponsesStreamingChatModel.Builder	baseUrl(String baseUrl)
OpenAiOfficialResponsesStreamingChatModel	build()
OpenAiOfficialResponsesStreamingChatModel.Builder	client(com.openai.client.OpenAIClient client)
OpenAiOfficialResponsesStreamingChatModel.Builder	credential(com.openai.credential.Credential credential)
OpenAiOfficialResponsesStreamingChatModel.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiOfficialResponsesStreamingChatModel.Builder	executorService(ExecutorService executorService)
OpenAiOfficialResponsesStreamingChatModel.Builder	include(List<String> include)
OpenAiOfficialResponsesStreamingChatModel.Builder	isAzure(boolean isAzure)	Deprecated. Use isMicrosoftFoundry(boolean) instead
OpenAiOfficialResponsesStreamingChatModel.Builder	isGitHubModels(boolean isGitHubModels)
OpenAiOfficialResponsesStreamingChatModel.Builder	isMicrosoftFoundry(boolean isMicrosoftFoundry)
OpenAiOfficialResponsesStreamingChatModel.Builder	listeners(ChatModelListener... listeners)
OpenAiOfficialResponsesStreamingChatModel.Builder	listeners(List<ChatModelListener> listeners)
OpenAiOfficialResponsesStreamingChatModel.Builder	maxOutputTokens(Integer maxOutputTokens)
OpenAiOfficialResponsesStreamingChatModel.Builder	maxRetries(Integer maxRetries)
OpenAiOfficialResponsesStreamingChatModel.Builder	maxToolCalls(Integer maxToolCalls)
OpenAiOfficialResponsesStreamingChatModel.Builder	microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)
OpenAiOfficialResponsesStreamingChatModel.Builder	modelName(String modelName)
OpenAiOfficialResponsesStreamingChatModel.Builder	organizationId(String organizationId)
OpenAiOfficialResponsesStreamingChatModel.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiOfficialResponsesStreamingChatModel.Builder	previousResponseId(String previousResponseId)
OpenAiOfficialResponsesStreamingChatModel.Builder	promptCacheKey(String promptCacheKey)
OpenAiOfficialResponsesStreamingChatModel.Builder	promptCacheRetention(String promptCacheRetention)
OpenAiOfficialResponsesStreamingChatModel.Builder	proxy(Proxy proxy)
OpenAiOfficialResponsesStreamingChatModel.Builder	reasoningEffort(String reasoningEffort)
OpenAiOfficialResponsesStreamingChatModel.Builder	safetyIdentifier(String safetyIdentifier)
OpenAiOfficialResponsesStreamingChatModel.Builder	serviceTier(String serviceTier)	When Enterprise Open AI subscription is used, service tier = "priority" puts requests into a faster pool.
OpenAiOfficialResponsesStreamingChatModel.Builder	store(Boolean store)
OpenAiOfficialResponsesStreamingChatModel.Builder	streamIncludeObfuscation(Boolean streamIncludeObfuscation)
OpenAiOfficialResponsesStreamingChatModel.Builder	strict(Boolean strict)	Sets whether to use strict mode for function calling.
OpenAiOfficialResponsesStreamingChatModel.Builder	temperature(Double temperature)
OpenAiOfficialResponsesStreamingChatModel.Builder	textVerbosity(String textVerbosity)
OpenAiOfficialResponsesStreamingChatModel.Builder	timeout(Duration timeout)
OpenAiOfficialResponsesStreamingChatModel.Builder	topLogprobs(Integer topLogprobs)
OpenAiOfficialResponsesStreamingChatModel.Builder	topP(Double topP)
OpenAiOfficialResponsesStreamingChatModel.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 OpenAiOfficialResponsesStreamingChatModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiOfficialResponsesStreamingChatModel.Builder apiKey(String apiKey)

credential

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

azureDeploymentName

@Deprecated
public OpenAiOfficialResponsesStreamingChatModel.Builder azureDeploymentName(String azureDeploymentName)

Deprecated.

Use microsoftFoundryDeploymentName(String) instead

microsoftFoundryDeploymentName

public OpenAiOfficialResponsesStreamingChatModel.Builder microsoftFoundryDeploymentName(String microsoftFoundryDeploymentName)

azureOpenAIServiceVersion

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

organizationId

public OpenAiOfficialResponsesStreamingChatModel.Builder organizationId(String organizationId)

isAzure

@Deprecated
public OpenAiOfficialResponsesStreamingChatModel.Builder isAzure(boolean isAzure)

Deprecated.

Use isMicrosoftFoundry(boolean) instead

isMicrosoftFoundry

public OpenAiOfficialResponsesStreamingChatModel.Builder isMicrosoftFoundry(boolean isMicrosoftFoundry)

isGitHubModels

public OpenAiOfficialResponsesStreamingChatModel.Builder isGitHubModels(boolean isGitHubModels)

customHeaders

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

timeout

public OpenAiOfficialResponsesStreamingChatModel.Builder timeout(Duration timeout)

maxRetries

public OpenAiOfficialResponsesStreamingChatModel.Builder maxRetries(Integer maxRetries)

proxy

public OpenAiOfficialResponsesStreamingChatModel.Builder proxy(Proxy proxy)

client

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

modelName

public OpenAiOfficialResponsesStreamingChatModel.Builder modelName(String modelName)

temperature

public OpenAiOfficialResponsesStreamingChatModel.Builder temperature(Double temperature)

topP

public OpenAiOfficialResponsesStreamingChatModel.Builder topP(Double topP)

maxOutputTokens

public OpenAiOfficialResponsesStreamingChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

maxToolCalls

public OpenAiOfficialResponsesStreamingChatModel.Builder maxToolCalls(Integer maxToolCalls)

parallelToolCalls

public OpenAiOfficialResponsesStreamingChatModel.Builder parallelToolCalls(Boolean parallelToolCalls)

previousResponseId

public OpenAiOfficialResponsesStreamingChatModel.Builder previousResponseId(String previousResponseId)

topLogprobs

public OpenAiOfficialResponsesStreamingChatModel.Builder topLogprobs(Integer topLogprobs)

truncation

public OpenAiOfficialResponsesStreamingChatModel.Builder truncation(String truncation)

include

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

serviceTier

public OpenAiOfficialResponsesStreamingChatModel.Builder serviceTier(String serviceTier)

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

safetyIdentifier

public OpenAiOfficialResponsesStreamingChatModel.Builder safetyIdentifier(String safetyIdentifier)

promptCacheKey

public OpenAiOfficialResponsesStreamingChatModel.Builder promptCacheKey(String promptCacheKey)

promptCacheRetention

public OpenAiOfficialResponsesStreamingChatModel.Builder promptCacheRetention(String promptCacheRetention)

reasoningEffort

public OpenAiOfficialResponsesStreamingChatModel.Builder reasoningEffort(String reasoningEffort)

textVerbosity

public OpenAiOfficialResponsesStreamingChatModel.Builder textVerbosity(String textVerbosity)

streamIncludeObfuscation

public OpenAiOfficialResponsesStreamingChatModel.Builder streamIncludeObfuscation(Boolean streamIncludeObfuscation)

store

public OpenAiOfficialResponsesStreamingChatModel.Builder store(Boolean store)

listeners

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

listeners

public OpenAiOfficialResponsesStreamingChatModel.Builder listeners(ChatModelListener... listeners)

executorService

public OpenAiOfficialResponsesStreamingChatModel.Builder executorService(ExecutorService executorService)

strict

public OpenAiOfficialResponsesStreamingChatModel.Builder strict(Boolean strict)

Sets whether to use strict mode for function calling. Defaults to true.

When strict mode is enabled, the schema will include "additionalProperties": false and "required" arrays with all property keys.

build

public OpenAiOfficialResponsesStreamingChatModel build()