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

      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

    • clearMaxRetries

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

    • maxRetries

      public BUILDER maxRetries(int maxRetries)
      The maximum number of retries for failed API requests.
      Parameters:
      maxRetries - an Optional containing the maximum number of retries
      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)
      The desired size of the generated images.
      Parameters:
      size - the image size.
      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)
      The quality of the generated images.
      Parameters:
      quality - the image quality.
      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)
      The style of the generated images.
      Parameters:
      style - the image style.
      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)
      The unique identifier for the user making the request.
      Parameters:
      user - the user ID.
      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)
      The format of the response.
      Parameters:
      responseFormat - the response format.
      Returns:
      updated builder instance
      See Also:

    • clearWithPersisting

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

    • withPersisting

      public BUILDER withPersisting(boolean withPersisting)
      The flag to indicate whether to persist the generated images.
      Parameters:
      withPersisting - the persist flag.
      Returns:
      updated builder instance
      See Also:

    • clearPersistTo

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

    • persistTo

      public BUILDER persistTo(Path persistTo)
      The path or location where the generated images should be persisted.
      Parameters:
      persistTo - the persist path.
      Returns:
      updated builder instance
      See Also:

    • enabled

      public BUILDER enabled(boolean enabled)
      If set to false (default), OpenAI model will not be available even if configured.
      Parameters:
      enabled - whether OpenAI model is enabled, defaults to false
      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)
      The base URL for the OpenAI API.
      Parameters:
      baseUrl - the base URL
      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)
      The API key used to authenticate requests to the OpenAI API.
      Parameters:
      apiKey - an Optional containing the API key
      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)
      Whether to log API requests.
      Parameters:
      logRequests - an Optional containing true if requests should be logged, false otherwise
      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)
      Whether to log API responses.
      Parameters:
      logResponses - an Optional containing true if responses should be logged, false otherwise
      Returns:
      updated builder instance
      See Also:

    • customHeaders

      public BUILDER customHeaders(Map<String,String> customHeaders)
      This method replaces all values with the new ones.
      Parameters:
      customHeaders - custom headers map
      Returns:
      updated builder instance
      See Also:

    • addCustomHeaders

      public BUILDER addCustomHeaders(Map<String,String> customHeaders)
      This method keeps existing values, then puts all new values into the map.
      Parameters:
      customHeaders - custom headers map
      Returns:
      updated builder instance
      See Also:

    • putCustomHeader

      public BUILDER putCustomHeader(String key, String customHeader)
      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:

    • clearTimeout

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

    • timeout

      public BUILDER timeout(Duration timeout)
      The timeout setting for API requests.
      Parameters:
      timeout - the timeout setting in Duration.parse(java.lang.CharSequence) format
      Returns:
      updated builder instance
      See Also:

    • clearProxy

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

    • proxy

      public BUILDER proxy(Proxy proxy)
      Proxy to use.
      Parameters:
      proxy - an Optional containing HTTP proxy to use
      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)
      The ID of the organization for API requests.
      Parameters:
      organizationId - organization ID
      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)
      The model name to use (e.g., "gpt-3.5-turbo").
      Parameters:
      modelName - the model name
      Returns:
      updated builder instance
      See Also:

    • maxRetries

      public Optional<Integer> maxRetries()
      The maximum number of retries for failed API requests.
      Returns:
      the max retries

    • size

      public Optional<String> size()
      The desired size of the generated images.
      Returns:
      the size

    • quality

      public Optional<String> quality()
      The quality of the generated images.
      Returns:
      the quality

    • style

      public Optional<String> style()
      The style of the generated images.
      Returns:
      the style

    • user

      public Optional<String> user()
      The unique identifier for the user making the request.
      Returns:
      the user

    • responseFormat

      public Optional<String> responseFormat()
      The format of the response.
      Returns:
      the response format

    • withPersisting

      public Optional<Boolean> withPersisting()
      The flag to indicate whether to persist the generated images.
      Returns:
      the with persisting

    • persistTo

      public Optional<Path> persistTo()
      The path or location where the generated images should be persisted.
      Returns:
      the persist to

    • enabled

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

    • baseUrl

      public Optional<String> baseUrl()
      The base URL for the OpenAI API.
      Returns:
      the base url

    • apiKey

      public Optional<String> apiKey()
      The API key used to authenticate requests to the OpenAI API.
      Returns:
      the api key

    • logRequests

      public Optional<Boolean> logRequests()
      Whether to log API requests.
      Returns:
      the log requests

    • logResponses

      public Optional<Boolean> logResponses()
      Whether to log API responses.
      Returns:
      the log responses

    • customHeaders

      public Map<String,String> customHeaders()
      A map containing custom headers.
      Returns:
      the custom headers

    • timeout

      public Optional<Duration> timeout()
      The timeout setting for API requests.
      Returns:
      the timeout

    • proxy

      public Optional<Proxy> proxy()
      Proxy to use.
      Returns:
      the proxy

    • organizationId

      public Optional<String> organizationId()
      The ID of the organization for API requests.
      Returns:
      the organization id

    • modelName

      public Optional<String> modelName()
      The model name to use (e.g., "gpt-3.5-turbo").
      Returns:
      the model name

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