Class OpenAiEmbeddingModelConfig.BuilderBase<BUILDER extends OpenAiEmbeddingModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiEmbeddingModelConfig>
java.lang.Object
io.helidon.integrations.langchain4j.providers.openai.OpenAiEmbeddingModelConfig.BuilderBase<BUILDER,PROTOTYPE>
- Type Parameters:
BUILDER
- type of the builder extending this abstract builderPROTOTYPE
- type of the prototype interface that would be built byPrototype.Builder.buildPrototype()
- All Implemented Interfaces:
Prototype.Builder<BUILDER,
,PROTOTYPE> ConfigBuilderSupport.ConfiguredBuilder<BUILDER,
,PROTOTYPE> ConfigBuilderSupport.ConfiguredBuilder<BUILDER,
PROTOTYPE>
- Direct Known Subclasses:
OpenAiEmbeddingModelConfig.Builder
- Enclosing interface:
OpenAiEmbeddingModelConfig
public abstract static class OpenAiEmbeddingModelConfig.BuilderBase<BUILDER extends OpenAiEmbeddingModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiEmbeddingModelConfig>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for
OpenAiEmbeddingModelConfig
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
Generated implementation of the prototype, can be extended by descendant prototype implementations. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCustomHeaders
(Map<String, String> customHeaders) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
This method keeps existing values, then puts all new values into the map.apiKey()
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.apiKey(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.apiKey(java.lang.String)
baseUrl()
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.baseUrl(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.baseUrl(java.lang.String)
Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.config()
If this instance was configured, this would be the config instance used.Deprecated.Update builder from configuration (node of this type).Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
customHeaders
(Map<String, String> customHeaders) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
This method replaces all values with the new ones.Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.dimensions(java.lang.Integer)
dimensions
(int dimensions) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.dimensions(java.lang.Integer)
boolean
enabled()
If set tofalse
(default), OpenAiEmbeddingModel will not be available even if configured.enabled
(boolean enabled) If set tofalse
(default), OpenAiEmbeddingModel will not be available even if configured.Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.encodingFormat(java.lang.String)
encodingFormat
(String encodingFormat) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.encodingFormat(java.lang.String)
from
(OpenAiEmbeddingModelConfig prototype) Update this builder from an existing prototype instance.from
(OpenAiEmbeddingModelConfig.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.Optional
<dev.langchain4j.http.client.HttpClientBuilder> Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
httpClientBuilder
(dev.langchain4j.http.client.HttpClientBuilder httpClientBuilder) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
Optional
<org.slf4j.Logger> logger()
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logger(org.slf4j.Logger)
logger
(org.slf4j.Logger logger) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logger(org.slf4j.Logger)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logRequests(java.lang.Boolean)
logRequests
(boolean logRequests) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logRequests(java.lang.Boolean)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logResponses(java.lang.Boolean)
logResponses
(boolean logResponses) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logResponses(java.lang.Boolean)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxRetries(java.lang.Integer)
maxRetries
(int maxRetries) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxRetries(java.lang.Integer)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxSegmentsPerBatch(java.lang.Integer)
maxSegmentsPerBatch
(int maxSegmentsPerBatch) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxSegmentsPerBatch(java.lang.Integer)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.modelName(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.modelName(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.organizationId(java.lang.String)
organizationId
(String organizationId) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.organizationId(java.lang.String)
protected void
Handles providers and decorators.Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.projectId(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.projectId(java.lang.String)
putCustomHeader
(String key, String customHeader) Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
This method adds a new value to the map, or replaces it if the key already exists.serviceRegistry
(ServiceRegistry registry) Provide an explicit registry instance to use.timeout()
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.timeout(java.time.Duration)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.timeout(java.time.Duration)
toString()
user()
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.user(java.lang.String)
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.user(java.lang.String)
protected void
Validates required properties.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.helidon.builder.api.Prototype.Builder
buildPrototype, self
-
Constructor Details
-
BuilderBase
protected BuilderBase()Protected to support extensibility.
-
-
Method Details
-
from
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
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.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 interfaceConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiEmbeddingModelConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OpenAiEmbeddingModelConfig> - Parameters:
config
- configuration instance used to obtain values to update this builder- Returns:
- updated builder instance
-
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 interfaceConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiEmbeddingModelConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OpenAiEmbeddingModelConfig> - Parameters:
config
- configuration instance used to obtain values to update this builder- Returns:
- updated builder instance
-
serviceRegistry
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
If set tofalse
(default), OpenAiEmbeddingModel will not be available even if configured.- Parameters:
enabled
- whether OpenAiEmbeddingModel is enabled, defaults tofalse
- Returns:
- updated builder instance
- See Also:
-
clearMaxSegmentsPerBatch
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
maxSegmentsPerBatch
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxSegmentsPerBatch(java.lang.Integer)
- Parameters:
maxSegmentsPerBatch
- Integer property- Returns:
- updated builder instance
- See Also:
-
clearApiKey
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
apiKey
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.apiKey(java.lang.String)
- Parameters:
apiKey
- String property- Returns:
- updated builder instance
- See Also:
-
clearLogger
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
logger
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logger(org.slf4j.Logger)
- Parameters:
logger
- Logger property- Returns:
- updated builder instance
- See Also:
-
clearLogResponses
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
logResponses
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logResponses(java.lang.Boolean)
- Parameters:
logResponses
- Boolean property- Returns:
- updated builder instance
- See Also:
-
clearLogRequests
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
logRequests
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logRequests(java.lang.Boolean)
- Parameters:
logRequests
- Boolean property- Returns:
- updated builder instance
- See Also:
-
clearTimeout
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
timeout
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.timeout(java.time.Duration)
- Parameters:
timeout
- Duration property- Returns:
- updated builder instance
- See Also:
-
clearOrganizationId
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
organizationId
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.organizationId(java.lang.String)
- Parameters:
organizationId
- String property- Returns:
- updated builder instance
- See Also:
-
clearModelName
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
modelName
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.modelName(java.lang.String)
- Parameters:
modelName
- String property- Returns:
- updated builder instance
- See Also:
-
clearBaseUrl
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
baseUrl
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.baseUrl(java.lang.String)
- Parameters:
baseUrl
- String property- Returns:
- updated builder instance
- See Also:
-
clearMaxRetries
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
maxRetries
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxRetries(java.lang.Integer)
- Parameters:
maxRetries
- Integer property- Returns:
- updated builder instance
- See Also:
-
clearHttpClientBuilder
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
httpClientBuilder
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
- Parameters:
httpClientBuilder
- HttpClientBuilder property- Returns:
- updated builder instance
- See Also:
-
clearEncodingFormat
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
encodingFormat
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.encodingFormat(java.lang.String)
- Parameters:
encodingFormat
- String property- Returns:
- updated builder instance
- See Also:
-
clearProjectId
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
projectId
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.projectId(java.lang.String)
- Parameters:
projectId
- String property- Returns:
- updated builder instance
- See Also:
-
clearUser
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
user
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.user(java.lang.String)
- Parameters:
user
- String property- Returns:
- updated builder instance
- See Also:
-
customHeaders
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
This method replaces all values with the new ones.- Parameters:
customHeaders
- Map property- Returns:
- updated builder instance
- See Also:
-
addCustomHeaders
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.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
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.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 replacecustomHeader
- new value for the key- Returns:
- updated builder instance
- See Also:
-
clearDimensions
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
dimensions
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.dimensions(java.lang.Integer)
- Parameters:
dimensions
- Integer property- Returns:
- updated builder instance
- See Also:
-
enabled
public boolean enabled()If set tofalse
(default), OpenAiEmbeddingModel will not be available even if configured.- Returns:
- the enabled
-
maxSegmentsPerBatch
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxSegmentsPerBatch(java.lang.Integer)
- Returns:
- the max segments per batch
-
apiKey
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.apiKey(java.lang.String)
- Returns:
- the api key
-
logger
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logger(org.slf4j.Logger)
- Returns:
- the logger
-
logResponses
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logResponses(java.lang.Boolean)
- Returns:
- the log responses
-
logRequests
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.logRequests(java.lang.Boolean)
- Returns:
- the log requests
-
timeout
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.timeout(java.time.Duration)
- Returns:
- the timeout
-
organizationId
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.organizationId(java.lang.String)
- Returns:
- the organization id
-
modelName
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.modelName(java.lang.String)
- Returns:
- the model name
-
baseUrl
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.baseUrl(java.lang.String)
- Returns:
- the base url
-
maxRetries
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.maxRetries(java.lang.Integer)
- Returns:
- the max retries
-
httpClientBuilder
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
- Returns:
- the http client builder
-
encodingFormat
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.encodingFormat(java.lang.String)
- Returns:
- the encoding format
-
projectId
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.projectId(java.lang.String)
- Returns:
- the project id
-
user
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.user(java.lang.String)
- Returns:
- the user
-
customHeaders
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.customHeaders(java.util.Map)
- Returns:
- the custom headers
-
dimensions
Generated fromOpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder.dimensions(java.lang.Integer)
- Returns:
- the dimensions
-
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
-
preBuildPrototype
protected void preBuildPrototype()Handles providers and decorators. -
validatePrototype
protected void validatePrototype()Validates required properties.
-
config(io.helidon.config.Config)