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

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

Class OpenAiImageModelConfig.BuilderBase.OpenAiImageModelConfigImpl

java.lang.Object

io.helidon.integrations.langchain4j.providers.openai.OpenAiImageModelConfig.BuilderBase.OpenAiImageModelConfigImpl

All Implemented Interfaces:

Prototype.Api, OpenAiImageModelConfig

Enclosing class:

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

protected static class OpenAiImageModelConfig.BuilderBase.OpenAiImageModelConfigImpl
extends Object
implements OpenAiImageModelConfig

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.OpenAiImageModelConfig

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

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	OpenAiImageModelConfigImpl(OpenAiImageModelConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Optional<String>	apiKey()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.apiKey(java.lang.String)
Optional<String>	baseUrl()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.baseUrl(java.lang.String)
default dev.langchain4j.model.openai.OpenAiImageModel.OpenAiImageModelBuilder	configuredBuilder()	Skipped: modelName - property already exist -> dev.langchain4j.model.openai.OpenAiImageModel.OpenAiImageModelBuilder modelName(java.lang.String) build - doesn't have exactly one parameter
Map<String,String>	customHeaders()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map)
boolean	enabled()	If set to false (default), OpenAiImageModel will not be available even if configured.
boolean	equals(Object o)
int	hashCode()
Optional<dev.langchain4j.http.client.HttpClientBuilder>	httpClientBuilder()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
Optional<org.slf4j.Logger>	logger()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.logger(org.slf4j.Logger)
Optional<Boolean>	logRequests()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.logRequests(java.lang.Boolean)
Optional<Boolean>	logResponses()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.logResponses(java.lang.Boolean)
Optional<Integer>	maxRetries()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.maxRetries(java.lang.Integer)
Optional<String>	modelName()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.modelName(java.lang.String)
Optional<String>	organizationId()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.organizationId(java.lang.String)
Optional<String>	projectId()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.projectId(java.lang.String)
Optional<String>	quality()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)
Optional<String>	responseFormat()	Enable a "JSON mode" in the model configuration.
Optional<String>	size()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)
Optional<String>	style()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)
Optional<Duration>	timeout()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.timeout(java.time.Duration)
String	toString()
Optional<String>	user()	Generated from OpenAiImageModel.OpenAiImageModelBuilder.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

OpenAiImageModelConfigImpl

protected OpenAiImageModelConfigImpl(OpenAiImageModelConfig.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: OpenAiImageModelConfig

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

Specified by:

enabled in interface OpenAiImageModelConfig

Returns:

whether OpenAiImageModel is enabled, defaults to false

apiKey

public Optional<String> apiKey()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.apiKey(java.lang.String)

Specified by:

apiKey in interface OpenAiImageModelConfig

Returns:

String property

logger

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

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.logger(org.slf4j.Logger)

Specified by:

logger in interface OpenAiImageModelConfig

Returns:

Logger property

logResponses

public Optional<Boolean> logResponses()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.logResponses(java.lang.Boolean)

Specified by:

logResponses in interface OpenAiImageModelConfig

Returns:

Boolean property

logRequests

public Optional<Boolean> logRequests()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.logRequests(java.lang.Boolean)

Specified by:

logRequests in interface OpenAiImageModelConfig

Returns:

Boolean property

timeout

public Optional<Duration> timeout()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.timeout(java.time.Duration)

Specified by:

timeout in interface OpenAiImageModelConfig

Returns:

Duration property

quality

public Optional<String> quality()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)

Specified by:

quality in interface OpenAiImageModelConfig

Returns:

String property

organizationId

public Optional<String> organizationId()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.organizationId(java.lang.String)

Specified by:

organizationId in interface OpenAiImageModelConfig

Returns:

String property

modelName

public Optional<String> modelName()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.modelName(java.lang.String)

Specified by:

modelName in interface OpenAiImageModelConfig

Returns:

String property

baseUrl

public Optional<String> baseUrl()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.baseUrl(java.lang.String)

Specified by:

baseUrl in interface OpenAiImageModelConfig

Returns:

String property

maxRetries

public Optional<Integer> maxRetries()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.maxRetries(java.lang.Integer)

Specified by:

maxRetries in interface OpenAiImageModelConfig

Returns:

Integer property

size

public Optional<String> size()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)

Specified by:

size in interface OpenAiImageModelConfig

Returns:

String property

httpClientBuilder

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

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)

Specified by:

httpClientBuilder in interface OpenAiImageModelConfig

Returns:

HttpClientBuilder property

style

public Optional<String> style()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)

Specified by:

style in interface OpenAiImageModelConfig

Returns:

String property

projectId

public Optional<String> projectId()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.projectId(java.lang.String)

Specified by:

projectId in interface OpenAiImageModelConfig

Returns:

String property

user

public Optional<String> user()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.user(java.lang.String)

Specified by:

user in interface OpenAiImageModelConfig

Returns:

String property

customHeaders

public Map<String,String> customHeaders()

Description copied from interface: OpenAiImageModelConfig

Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map)

Specified by:

customHeaders in interface OpenAiImageModelConfig

Returns:

Map property

responseFormat

public Optional<String> responseFormat()

Description copied from interface: OpenAiImageModelConfig

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 OpenAiImageModelConfig

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.OpenAiImageModel.OpenAiImageModelBuilder configuredBuilder()

Skipped:

• modelName - property already exist -> dev.langchain4j.model.openai.OpenAiImageModel.OpenAiImageModelBuilder modelName(java.lang.String)
• build - doesn't have exactly one parameter

Overridden:

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

Returns:

Actual Lc4j model builder configured with this blueprint.