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

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

java.lang.Object
io.helidon.integrations.langchain4j.providers.openai.OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
OpenAiImageModelConfig.Builder
Enclosing interface:
OpenAiImageModelConfig
public abstract static class OpenAiImageModelConfig.BuilderBase<BUILDER extends OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiImageModelConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenAiImageModelConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenAiImageModelConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(OpenAiImageModelConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiImageModelConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiImageModelConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • serviceRegistry

      public BUILDER serviceRegistry(ServiceRegistry registry)
      Provide an explicit registry instance to use.

      If not configured, the GlobalServiceRegistry would be used to discover services.

      Parameters:
      registry - service registry instance
      Returns:
      updated builder instance

    • enabled

      public BUILDER enabled(boolean enabled)
      If set to false (default), OpenAiImageModel will not be available even if configured.
      Parameters:
      enabled - whether OpenAiImageModel is enabled, defaults to false
      Returns:
      updated builder instance
      See Also:

    • clearApiKey

      public BUILDER clearApiKey()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • apiKey

      public BUILDER apiKey(String apiKey)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.apiKey(java.lang.String)
      Parameters:
      apiKey - String property
      Returns:
      updated builder instance
      See Also:

    • clearLogger

      public BUILDER clearLogger()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logger

      public BUILDER logger(org.slf4j.Logger logger)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logger(org.slf4j.Logger)
      Parameters:
      logger - Logger property
      Returns:
      updated builder instance
      See Also:

    • clearLogResponses

      public BUILDER clearLogResponses()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logResponses

      public BUILDER logResponses(boolean logResponses)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logResponses(java.lang.Boolean)
      Parameters:
      logResponses - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearLogRequests

      public BUILDER clearLogRequests()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logRequests

      public BUILDER logRequests(boolean logRequests)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logRequests(java.lang.Boolean)
      Parameters:
      logRequests - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearTimeout

      public BUILDER clearTimeout()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • timeout

      public BUILDER timeout(Duration timeout)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.timeout(java.time.Duration)
      Parameters:
      timeout - Duration property
      Returns:
      updated builder instance
      See Also:

    • clearQuality

      public BUILDER clearQuality()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • quality

      public BUILDER quality(String quality)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)
      Parameters:
      quality - String property
      Returns:
      updated builder instance
      See Also:

    • clearOrganizationId

      public BUILDER clearOrganizationId()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • organizationId

      public BUILDER organizationId(String organizationId)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.organizationId(java.lang.String)
      Parameters:
      organizationId - String property
      Returns:
      updated builder instance
      See Also:

    • clearModelName

      public BUILDER clearModelName()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • modelName

      public BUILDER modelName(String modelName)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.modelName(java.lang.String)
      Parameters:
      modelName - String property
      Returns:
      updated builder instance
      See Also:

    • clearBaseUrl

      public BUILDER clearBaseUrl()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • baseUrl

      public BUILDER baseUrl(String baseUrl)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.baseUrl(java.lang.String)
      Parameters:
      baseUrl - String property
      Returns:
      updated builder instance
      See Also:

    • clearMaxRetries

      public BUILDER clearMaxRetries()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • maxRetries

      public BUILDER maxRetries(int maxRetries)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.maxRetries(java.lang.Integer)
      Parameters:
      maxRetries - Integer property
      Returns:
      updated builder instance
      See Also:

    • clearSize

      public BUILDER clearSize()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • size

      public BUILDER size(String size)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)
      Parameters:
      size - String property
      Returns:
      updated builder instance
      See Also:

    • clearHttpClientBuilder

      public BUILDER clearHttpClientBuilder()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • httpClientBuilder

      public BUILDER httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder httpClientBuilder)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Parameters:
      httpClientBuilder - HttpClientBuilder property
      Returns:
      updated builder instance
      See Also:

    • clearStyle

      public BUILDER clearStyle()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • style

      public BUILDER style(String style)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)
      Parameters:
      style - String property
      Returns:
      updated builder instance
      See Also:

    • clearProjectId

      public BUILDER clearProjectId()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • projectId

      public BUILDER projectId(String projectId)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.projectId(java.lang.String)
      Parameters:
      projectId - String property
      Returns:
      updated builder instance
      See Also:

    • clearUser

      public BUILDER clearUser()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • user

      public BUILDER user(String user)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.user(java.lang.String)
      Parameters:
      user - String property
      Returns:
      updated builder instance
      See Also:

    • customHeaders

      public BUILDER customHeaders(Map<String,String> customHeaders)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map) This method replaces all values with the new ones.
      Parameters:
      customHeaders - Map property
      Returns:
      updated builder instance
      See Also:

    • addCustomHeaders

      public BUILDER addCustomHeaders(Map<String,String> customHeaders)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map) This method keeps existing values, then puts all new values into the map.
      Parameters:
      customHeaders - Map property
      Returns:
      updated builder instance
      See Also:

    • putCustomHeader

      public BUILDER putCustomHeader(String key, String customHeader)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      customHeader - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearResponseFormat

      public BUILDER clearResponseFormat()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • responseFormat

      public BUILDER responseFormat(String responseFormat)
      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.
      Parameters:
      responseFormat - "json_object" to enable JSON mode on older models like gpt-3.5-turbo or gpt-4
      Returns:
      updated builder instance
      See Also:

    • enabled

      public boolean enabled()
      If set to false (default), OpenAiImageModel will not be available even if configured.
      Returns:
      the enabled

    • apiKey

      public Optional<String> apiKey()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.apiKey(java.lang.String)
      Returns:
      the api key

    • logger

      public Optional<org.slf4j.Logger> logger()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logger(org.slf4j.Logger)
      Returns:
      the logger

    • logResponses

      public Optional<Boolean> logResponses()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logResponses(java.lang.Boolean)
      Returns:
      the log responses

    • logRequests

      public Optional<Boolean> logRequests()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.logRequests(java.lang.Boolean)
      Returns:
      the log requests

    • timeout

      public Optional<Duration> timeout()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.timeout(java.time.Duration)
      Returns:
      the timeout

    • quality

      public Optional<String> quality()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)
      Returns:
      the quality

    • organizationId

      public Optional<String> organizationId()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.organizationId(java.lang.String)
      Returns:
      the organization id

    • modelName

      public Optional<String> modelName()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.modelName(java.lang.String)
      Returns:
      the model name

    • baseUrl

      public Optional<String> baseUrl()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.baseUrl(java.lang.String)
      Returns:
      the base url

    • maxRetries

      public Optional<Integer> maxRetries()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.maxRetries(java.lang.Integer)
      Returns:
      the max retries

    • size

      public Optional<String> size()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)
      Returns:
      the size

    • httpClientBuilder

      public Optional<dev.langchain4j.http.client.HttpClientBuilder> httpClientBuilder()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Returns:
      the http client builder

    • style

      public Optional<String> style()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)
      Returns:
      the style

    • projectId

      public Optional<String> projectId()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.projectId(java.lang.String)
      Returns:
      the project id

    • user

      public Optional<String> user()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.user(java.lang.String)
      Returns:
      the user

    • customHeaders

      public Map<String,String> customHeaders()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map)
      Returns:
      the custom headers

    • responseFormat

      public Optional<String> responseFormat()
      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.
      Returns:
      the response format

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.