Module io.helidon.integrations.langchain4j.providers.openai

Package io.helidon.integrations.langchain4j.providers.openai

Class OpenAiChatModelConfig.BuilderBase.OpenAiChatModelConfigImpl

java.lang.Object

io.helidon.integrations.langchain4j.providers.openai.OpenAiChatModelConfig.BuilderBase.OpenAiChatModelConfigImpl

All Implemented Interfaces:

Prototype.Api, OpenAiChatModelConfig

Enclosing class:

OpenAiChatModelConfig.BuilderBase<BUILDER extends OpenAiChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiChatModelConfig>

protected static class OpenAiChatModelConfig.BuilderBase.OpenAiChatModelConfigImpl
extends Object
implements OpenAiChatModelConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.integrations.langchain4j.providers.openai.OpenAiChatModelConfig

OpenAiChatModelConfig.Builder, OpenAiChatModelConfig.BuilderBase<BUILDER extends OpenAiChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiChatModelConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ROOT	The root configuration key for this builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiChatModelConfigImpl(OpenAiChatModelConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Optional<String>	apiKey()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.apiKey(java.lang.String)
Optional<String>	baseUrl()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.baseUrl(java.lang.String)
default dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder	configuredBuilder()	Skipped: modelName - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder modelName(java.lang.String) responseFormat - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder responseFormat(java.lang.String) supportedCapabilities - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder supportedCapabilities(java.util.Set<dev.langchain4j.model.chat.Capability>) build - doesn't have exactly one parameter
Map<String,String>	customHeaders()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.customHeaders(java.util.Map)
Optional<dev.langchain4j.model.chat.request.ChatRequestParameters>	defaultRequestParameters()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
boolean	enabled()	If set to false (default), OpenAiChatModel will not be available even if configured.
boolean	equals(Object o)
Optional<Double>	frequencyPenalty()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.frequencyPenalty(java.lang.Double)
int	hashCode()
Optional<dev.langchain4j.http.client.HttpClientBuilder>	httpClientBuilder()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
List<dev.langchain4j.model.chat.listener.ChatModelListener>	listeners()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.listeners(java.util.List)
Optional<org.slf4j.Logger>	logger()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.logger(org.slf4j.Logger)
Map<String,Integer>	logitBias()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.logitBias(java.util.Map)
Optional<Boolean>	logRequests()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.logRequests(java.lang.Boolean)
Optional<Boolean>	logResponses()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.logResponses(java.lang.Boolean)
Optional<Integer>	maxCompletionTokens()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxCompletionTokens(java.lang.Integer)
Optional<Integer>	maxRetries()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxRetries(java.lang.Integer)
Optional<Integer>	maxTokens()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxTokens(java.lang.Integer)
Map<String,String>	metadata()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.metadata(java.util.Map)
Optional<String>	modelName()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.modelName(java.lang.String)
Optional<String>	organizationId()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.organizationId(java.lang.String)
Optional<Boolean>	parallelToolCalls()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.parallelToolCalls(java.lang.Boolean)
Optional<Double>	presencePenalty()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.presencePenalty(java.lang.Double)
Optional<String>	projectId()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.projectId(java.lang.String)
Optional<String>	responseFormat()	Enable a "JSON mode" in the model configuration.
Optional<Boolean>	returnThinking()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.returnThinking(java.lang.Boolean)
Optional<Integer>	seed()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.seed(java.lang.Integer)
Optional<String>	serviceTier()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.serviceTier(java.lang.String)
List<String>	stop()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.stop(java.util.List)
Optional<Boolean>	store()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.store(java.lang.Boolean)
Optional<Boolean>	strictJsonSchema()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictJsonSchema(java.lang.Boolean)
Optional<Boolean>	strictTools()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictTools(java.lang.Boolean)
Set<dev.langchain4j.model.chat.Capability>	supportedCapabilities()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)
Optional<Double>	temperature()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.temperature(java.lang.Double)
Optional<Duration>	timeout()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.timeout(java.time.Duration)
Optional<Double>	topP()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.topP(java.lang.Double)
String	toString()
Optional<String>	user()	Generated from OpenAiChatModel.OpenAiChatModelBuilder.user(java.lang.String)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONFIG_ROOT

static final String CONFIG_ROOT

The root configuration key for this builder.

See Also:

• Constant Field Values

Constructor Details

OpenAiChatModelConfigImpl

protected OpenAiChatModelConfigImpl(OpenAiChatModelConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

enabled

public boolean enabled()

Description copied from interface: OpenAiChatModelConfig

If set to false (default), OpenAiChatModel will not be available even if configured.

Specified by:

enabled in interface OpenAiChatModelConfig

Returns:

whether OpenAiChatModel is enabled, defaults to false

parallelToolCalls

public Optional<Boolean> parallelToolCalls()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.parallelToolCalls(java.lang.Boolean)

Specified by:

parallelToolCalls in interface OpenAiChatModelConfig

Returns:

Boolean property

metadata

public Map<String,String> metadata()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.metadata(java.util.Map)

Specified by:

metadata in interface OpenAiChatModelConfig

Returns:

Map property

apiKey

public Optional<String> apiKey()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.apiKey(java.lang.String)

Specified by:

apiKey in interface OpenAiChatModelConfig

Returns:

String property

strictJsonSchema

public Optional<Boolean> strictJsonSchema()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictJsonSchema(java.lang.Boolean)

Specified by:

strictJsonSchema in interface OpenAiChatModelConfig

Returns:

Boolean property

seed

public Optional<Integer> seed()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.seed(java.lang.Integer)

Specified by:

seed in interface OpenAiChatModelConfig

Returns:

Integer property

logger

public Optional<org.slf4j.Logger> logger()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.logger(org.slf4j.Logger)

Specified by:

logger in interface OpenAiChatModelConfig

Returns:

Logger property

defaultRequestParameters

public Optional<dev.langchain4j.model.chat.request.ChatRequestParameters> defaultRequestParameters()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)

Specified by:

defaultRequestParameters in interface OpenAiChatModelConfig

Returns:

ChatRequestParameters property

timeout

public Optional<Duration> timeout()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.timeout(java.time.Duration)

Specified by:

timeout in interface OpenAiChatModelConfig

Returns:

Duration property

organizationId

public Optional<String> organizationId()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.organizationId(java.lang.String)

Specified by:

organizationId in interface OpenAiChatModelConfig

Returns:

String property

presencePenalty

public Optional<Double> presencePenalty()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.presencePenalty(java.lang.Double)

Specified by:

presencePenalty in interface OpenAiChatModelConfig

Returns:

Double property

httpClientBuilder

public Optional<dev.langchain4j.http.client.HttpClientBuilder> httpClientBuilder()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)

Specified by:

httpClientBuilder in interface OpenAiChatModelConfig

Returns:

HttpClientBuilder property

temperature

public Optional<Double> temperature()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.temperature(java.lang.Double)

Specified by:

temperature in interface OpenAiChatModelConfig

Returns:

Double property

maxTokens

public Optional<Integer> maxTokens()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxTokens(java.lang.Integer)

Specified by:

maxTokens in interface OpenAiChatModelConfig

Returns:

Integer property

logitBias

public Map<String,Integer> logitBias()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.logitBias(java.util.Map)

Specified by:

logitBias in interface OpenAiChatModelConfig

Returns:

Map property

frequencyPenalty

public Optional<Double> frequencyPenalty()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.frequencyPenalty(java.lang.Double)

Specified by:

frequencyPenalty in interface OpenAiChatModelConfig

Returns:

Double property

customHeaders

public Map<String,String> customHeaders()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.customHeaders(java.util.Map)

Specified by:

customHeaders in interface OpenAiChatModelConfig

Returns:

Map property

maxCompletionTokens

public Optional<Integer> maxCompletionTokens()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxCompletionTokens(java.lang.Integer)

Specified by:

maxCompletionTokens in interface OpenAiChatModelConfig

Returns:

Integer property

listeners

public List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.listeners(java.util.List)

Specified by:

listeners in interface OpenAiChatModelConfig

Returns:

List property

supportedCapabilities

public Set<dev.langchain4j.model.chat.Capability> supportedCapabilities()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)

Specified by:

supportedCapabilities in interface OpenAiChatModelConfig

Returns:

Set property

store

public Optional<Boolean> store()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.store(java.lang.Boolean)

Specified by:

store in interface OpenAiChatModelConfig

Returns:

Boolean property

logResponses

public Optional<Boolean> logResponses()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.logResponses(java.lang.Boolean)

Specified by:

logResponses in interface OpenAiChatModelConfig

Returns:

Boolean property

topP

public Optional<Double> topP()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.topP(java.lang.Double)

Specified by:

topP in interface OpenAiChatModelConfig

Returns:

Double property

logRequests

public Optional<Boolean> logRequests()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.logRequests(java.lang.Boolean)

Specified by:

logRequests in interface OpenAiChatModelConfig

Returns:

Boolean property

returnThinking

public Optional<Boolean> returnThinking()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.returnThinking(java.lang.Boolean)

Specified by:

returnThinking in interface OpenAiChatModelConfig

Returns:

Boolean property

modelName

public Optional<String> modelName()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.modelName(java.lang.String)

Specified by:

modelName in interface OpenAiChatModelConfig

Returns:

String property

baseUrl

public Optional<String> baseUrl()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.baseUrl(java.lang.String)

Specified by:

baseUrl in interface OpenAiChatModelConfig

Returns:

String property

maxRetries

public Optional<Integer> maxRetries()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxRetries(java.lang.Integer)

Specified by:

maxRetries in interface OpenAiChatModelConfig

Returns:

Integer property

stop

public List<String> stop()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.stop(java.util.List)

Specified by:

stop in interface OpenAiChatModelConfig

Returns:

List property

strictTools

public Optional<Boolean> strictTools()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictTools(java.lang.Boolean)

Specified by:

strictTools in interface OpenAiChatModelConfig

Returns:

Boolean property

serviceTier

public Optional<String> serviceTier()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.serviceTier(java.lang.String)

Specified by:

serviceTier in interface OpenAiChatModelConfig

Returns:

String property

projectId

public Optional<String> projectId()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.projectId(java.lang.String)

Specified by:

projectId in interface OpenAiChatModelConfig

Returns:

String property

user

public Optional<String> user()

Description copied from interface: OpenAiChatModelConfig

Generated from OpenAiChatModel.OpenAiChatModelBuilder.user(java.lang.String)

Specified by:

user in interface OpenAiChatModelConfig

Returns:

String property

responseFormat

public Optional<String> responseFormat()

Description copied from interface: OpenAiChatModelConfig

Enable a "JSON mode" in the model configuration. This way, the LLM will be forced to respond with a valid JSON. For newer models that support Structured Outputs use supported-capabilities.

Specified by:

responseFormat in interface OpenAiChatModelConfig

Returns:

"json_object" to enable JSON mode on older models like gpt-3.5-turbo or gpt-4

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

configuredBuilder

default dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder configuredBuilder()

Skipped:

• modelName - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder modelName(java.lang.String)
• responseFormat - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder responseFormat(java.lang.String)
• supportedCapabilities - property already exist -> dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder supportedCapabilities(java.util.Set<dev.langchain4j.model.chat.Capability>)
• build - doesn't have exactly one parameter

Overridden:

• OpenAiLc4jProvider.responseFormat()
• OpenAiLc4jProvider.responseFormat()

Returns:

Actual Lc4j model builder configured with this blueprint.