Class OracleEmbeddingStoreConfig.BuilderBase<BUILDER extends OracleEmbeddingStoreConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OracleEmbeddingStoreConfig>
java.lang.Object
io.helidon.integrations.langchain4j.providers.oracle.OracleEmbeddingStoreConfig.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:
OracleEmbeddingStoreConfig.Builder
- Enclosing interface:
OracleEmbeddingStoreConfig
public abstract static class OracleEmbeddingStoreConfig.BuilderBase<BUILDER extends OracleEmbeddingStoreConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OracleEmbeddingStoreConfig>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for
OracleEmbeddingStoreConfig
.-
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 TypeMethodDescriptionaddIvfIndex
(List<? extends IvfIndexConfig> ivfIndex) IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.addJsonIndex
(List<? extends JsonIndexConfig> jsonIndex) JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
.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).Configures a data source that connects to an Oracle Database.dataSource
(DataSource dataSource) Configures a data source that connects to an Oracle Database.Configures a table used to store embeddings, text, and metadata.embeddingTable
(EmbeddingTableConfig embeddingTable) Configures a table used to store embeddings, text, and metadata.embeddingTable
(Consumer<EmbeddingTableConfig.Builder> consumer) Configures a table used to store embeddings, text, and metadata.boolean
enabled()
If set tofalse
(default), OracleEmbeddingStore will not be available even if configured.enabled
(boolean enabled) If set tofalse
(default), OracleEmbeddingStore will not be available even if configured.Generated fromOracleEmbeddingStore.Builder.exactSearch(boolean)
exactSearch
(boolean exactSearch) Generated fromOracleEmbeddingStore.Builder.exactSearch(boolean)
from
(OracleEmbeddingStoreConfig prototype) Update this builder from an existing prototype instance.from
(OracleEmbeddingStoreConfig.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.ivfIndex()
IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.ivfIndex
(List<? extends IvfIndexConfig> ivfIndex) IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
.jsonIndex
(List<? extends JsonIndexConfig> jsonIndex) JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
.protected void
Handles providers and decorators.serviceRegistry
(ServiceRegistry registry) Provide an explicit registry instance to use.toString()
protected void
Validates required properties.Optional
<dev.langchain4j.store.embedding.oracle.CreateOption> The vector index creation option, which defines behavior when creating the vector index.vectorIndex
(dev.langchain4j.store.embedding.oracle.CreateOption vectorIndex) The vector index creation option, which defines behavior when creating the vector index.Optional
<dev.langchain4j.store.embedding.oracle.CreateOption> Deprecated.usevectorIndex()
insteadvectorIndexCreateOption
(dev.langchain4j.store.embedding.oracle.CreateOption vectorIndexCreateOption) Configures the creation of an index on the embedding column of theEmbeddingTable
used by the embedding store.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 OracleEmbeddingStoreConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OracleEmbeddingStoreConfig> - 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 OracleEmbeddingStoreConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OracleEmbeddingStoreConfig> - 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), OracleEmbeddingStore will not be available even if configured.- Parameters:
enabled
- whether OracleEmbeddingStore is enabled, defaults tofalse
- Returns:
- updated builder instance
- See Also:
-
clearExactSearch
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
exactSearch
Generated fromOracleEmbeddingStore.Builder.exactSearch(boolean)
- Parameters:
exactSearch
- boolean property- Returns:
- updated builder instance
- See Also:
-
clearEmbeddingTable
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
embeddingTable
Configures a table used to store embeddings, text, and metadata. -
embeddingTable
Configures a table used to store embeddings, text, and metadata. -
jsonIndex
JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
. The function used to index a key is the same as the function used for searching on the store.- Parameters:
jsonIndex
- a list of json indexes- Returns:
- updated builder instance
- See Also:
-
addJsonIndex
JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
. The function used to index a key is the same as the function used for searching on the store.- Parameters:
jsonIndex
- a list of json indexes- Returns:
- updated builder instance
- See Also:
-
ivfIndex
IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.- Parameters:
ivfIndex
- a list of ivf indexes- Returns:
- updated builder instance
- See Also:
-
addIvfIndex
IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.- Parameters:
ivfIndex
- a list of ivf indexes- Returns:
- updated builder instance
- See Also:
-
clearVectorIndex
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
vectorIndex
The vector index creation option, which defines behavior when creating the vector index. -
clearVectorIndexCreateOption
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
vectorIndexCreateOption
public BUILDER vectorIndexCreateOption(dev.langchain4j.store.embedding.oracle.CreateOption vectorIndexCreateOption) Configures the creation of an index on the embedding column of theEmbeddingTable
used by the embedding store. Depending on which CreateOption is provided, an index may be created. The default createOption isCreateOption.CREATE_NONE
. -
dataSource
Configures a data source that connects to an Oracle Database.- Parameters:
dataSource
- Data source to configure. Not null.- Returns:
- updated builder instance
- See Also:
-
enabled
public boolean enabled()If set tofalse
(default), OracleEmbeddingStore will not be available even if configured.- Returns:
- the enabled
-
exactSearch
Generated fromOracleEmbeddingStore.Builder.exactSearch(boolean)
- Returns:
- the exact search
-
embeddingTable
Configures a table used to store embeddings, text, and metadata.- Returns:
- the embedding table
-
jsonIndex
JSONIndex allows configuring a function-based index on one or several keys of the metadata column of theEmbeddingTable
. The function used to index a key is the same as the function used for searching on the store.- Returns:
- the json index
-
ivfIndex
IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of theEmbeddingTable
.- Returns:
- the ivf index
-
vectorIndex
The vector index creation option, which defines behavior when creating the vector index.- Returns:
- the vector index
-
vectorIndexCreateOption
@Deprecated public Optional<dev.langchain4j.store.embedding.oracle.CreateOption> vectorIndexCreateOption()Deprecated.usevectorIndex()
insteadConfigures the creation of an index on the embedding column of theEmbeddingTable
used by the embedding store. Depending on which CreateOption is provided, an index may be created. The default createOption isCreateOption.CREATE_NONE
.- Returns:
- the vector index create option
-
dataSource
Configures a data source that connects to an Oracle Database.- Returns:
- the data source
-
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)