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

Interface OpenAiEmbeddingModelConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
OpenAiEmbeddingModelConfig.BuilderBase.OpenAiEmbeddingModelConfigImpl
public interface OpenAiEmbeddingModelConfig extends Prototype.Api
Interface generated from definition. Please add javadoc to the definition interface.
See Also:

  • Field Details

  • Method Details

    • builder

      static OpenAiEmbeddingModelConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static OpenAiEmbeddingModelConfig.Builder builder(OpenAiEmbeddingModelConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static OpenAiEmbeddingModelConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      @Deprecated static OpenAiEmbeddingModelConfig create(Config config)
      Deprecated.
      use create(io.helidon.config.Config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static OpenAiEmbeddingModelConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • enabled

      boolean enabled()
      If set to false (default), OpenAiEmbeddingModel will not be available even if configured.
      Returns:
      whether OpenAiEmbeddingModel is enabled, defaults to false

    • maxSegmentsPerBatch

      Optional<Integer> maxSegmentsPerBatch()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxSegmentsPerBatch(java.lang.Integer)
      Returns:
      Integer property

    • apiKey

      Optional<String> apiKey()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.apiKey(java.lang.String)
      Returns:
      String property

    • logger

      Optional<org.slf4j.Logger> logger()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logger(org.slf4j.Logger)
      Returns:
      Logger property

    • logResponses

      Optional<Boolean> logResponses()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logResponses(java.lang.Boolean)
      Returns:
      Boolean property

    • logRequests

      Optional<Boolean> logRequests()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logRequests(java.lang.Boolean)
      Returns:
      Boolean property

    • timeout

      Optional<Duration> timeout()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.timeout(java.time.Duration)
      Returns:
      Duration property

    • organizationId

      Optional<String> organizationId()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.organizationId(java.lang.String)
      Returns:
      String property

    • modelName

      Optional<String> modelName()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.modelName(java.lang.String)
      Returns:
      String property

    • baseUrl

      Optional<String> baseUrl()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.baseUrl(java.lang.String)
      Returns:
      String property

    • maxRetries

      Optional<Integer> maxRetries()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxRetries(java.lang.Integer)
      Returns:
      Integer property

    • httpClientBuilder

      Optional<dev.langchain4j.http.client.HttpClientBuilder> httpClientBuilder()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Returns:
      HttpClientBuilder property

    • encodingFormat

      Optional<String> encodingFormat()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.encodingFormat(java.lang.String)
      Returns:
      String property

    • projectId

      Optional<String> projectId()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.projectId(java.lang.String)
      Returns:
      String property

    • user

      Optional<String> user()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.user(java.lang.String)
      Returns:
      String property

    • customHeaders

      Map<String,String> customHeaders()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
      Returns:
      Map property

    • dimensions

      Optional<Integer> dimensions()
      Generated from OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.dimensions(java.lang.Integer)
      Returns:
      Integer property

    • configuredBuilder

      default dev.langchain4j.model.openai.OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder configuredBuilder()
      Skipped:
      • modelName - property already exist -> dev.langchain4j.model.openai.OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder modelName(java.lang.String)
      • build - doesn't have exactly one parameter
      Returns:
      Actual Lc4j model builder configured with this blueprint.