Module io.helidon.integrations.langchain4j.providers.oracle

Package io.helidon.integrations.langchain4j.providers.oracle

Interface OracleEmbeddingStoreConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

OracleEmbeddingStoreConfig.BuilderBase.OracleEmbeddingStoreConfigImpl

public interface OracleEmbeddingStoreConfig
extends Prototype.Api

Configuration for the Oracle embedding store, OracleEmbeddingStore.

See Also:

• OracleEmbeddingStore
• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OracleEmbeddingStoreConfig.Builder	Fluent API builder for OracleEmbeddingStoreConfig.
static class	OracleEmbeddingStoreConfig.BuilderBase<BUILDER extends OracleEmbeddingStoreConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OracleEmbeddingStoreConfig>	Fluent API builder base for OracleEmbeddingStoreConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ROOT	Default configuration prefix.

Method Summary

Modifier and Type	Method	Description
static OracleEmbeddingStoreConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static OracleEmbeddingStoreConfig.Builder	builder(OracleEmbeddingStoreConfig instance)	Create a new fluent API builder from an existing instance.
static OracleEmbeddingStoreConfig	create()	Create a new instance with default values.
static OracleEmbeddingStoreConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	dataSource()	The data source name used for connecting to the Oracle embedding store.
Optional<OracleEmbeddingTableConfig>	embeddingTable()	Properties of the embedding table associated with the Oracle embedding store.
boolean	enabled()	If set to true, Oracle embedding store will be enabled.
Optional<Boolean>	exactSearch()	The exact search option, which specifies whether exact matching is used in searches.
Optional<dev.langchain4j.store.embedding.oracle.CreateOption>	vectorIndexCreateOption()	The vector index creation option, which defines behavior when creating the vector index.

Field Details

CONFIG_ROOT

static final String CONFIG_ROOT

Default configuration prefix.

See Also:

• Constant Field Values

Method Details

builder

static OracleEmbeddingStoreConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OracleEmbeddingStoreConfig.Builder builder(OracleEmbeddingStoreConfig 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 OracleEmbeddingStoreConfig 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

static OracleEmbeddingStoreConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

If set to true, Oracle embedding store will be enabled.

Returns:

whether Oracle embedding store is enabled, defaults to false

dataSource

Optional<String> dataSource()

The data source name used for connecting to the Oracle embedding store.

Returns:

an Optional containing the datasource name qualifier

embeddingTable

Optional<OracleEmbeddingTableConfig> embeddingTable()

Properties of the embedding table associated with the Oracle embedding store.

Returns:

an Optional containing the OracleEmbeddingTableConfig representing table properties

exactSearch

Optional<Boolean> exactSearch()

The exact search option, which specifies whether exact matching is used in searches.

Returns:

an Optional containing the exact search option if set; otherwise, an empty Optional

vectorIndexCreateOption

Optional<dev.langchain4j.store.embedding.oracle.CreateOption> vectorIndexCreateOption()

The vector index creation option, which defines behavior when creating the vector index.

Returns:

an Optional containing the vector index creation option if set; otherwise, an empty Optional