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
Interface generated from definition. Please add javadoc to the definition interface.
See Also:

  • Field Details

  • 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

      @Deprecated static OracleEmbeddingStoreConfig 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 OracleEmbeddingStoreConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • enabled

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

    • exactSearch

      Optional<Boolean> exactSearch()
      Generated from OracleEmbeddingStore.Builder.exactSearch(boolean)
      Returns:
      boolean property

    • embeddingTable

      Optional<EmbeddingTableConfig> embeddingTable()
      Configures a table used to store embeddings, text, and metadata.
      Returns:
      an Optional containing the table used to store embeddings if set; otherwise, an empty Optional.

    • jsonIndex

      List<JsonIndexConfig> jsonIndex()
      JSONIndex allows configuring a function-based index on one or several keys of the metadata column of the EmbeddingTable. The function used to index a key is the same as the function used for searching on the store.
      Returns:
      a list of json indexes

    • ivfIndex

      List<IvfIndexConfig> ivfIndex()
      IVFIndex allows configuring an Inverted File Flat (IVF) index on the embedding column of the EmbeddingTable.
      Returns:
      a list of ivf indexes

    • vectorIndex

      Optional<dev.langchain4j.store.embedding.oracle.CreateOption> vectorIndex()
      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

    • vectorIndexCreateOption

      Optional<dev.langchain4j.store.embedding.oracle.CreateOption> vectorIndexCreateOption()
      Deprecated.
      Use vectorIndex instead
      Configures the creation of an index on the embedding column of the EmbeddingTable used by the embedding store. Depending on which CreateOption is provided, an index may be created. The default createOption is CreateOption.CREATE_NONE.
      Returns:
      an Optional containing the vector index creation option if set; otherwise, an empty Optional

    • dataSource

      DataSource dataSource()
      Configures a data source that connects to an Oracle Database.
      Returns:
      Data source to configure. Not null.

    • configuredBuilder

      default dev.langchain4j.store.embedding.oracle.OracleEmbeddingStore.Builder configuredBuilder()
      Skipped:
      • embeddingTable - by pattern 'embeddingTable.*'
      • embeddingTable - doesn't have exactly one parameter
      • embeddingTable - by pattern 'embeddingTable.*'
      • index - by pattern 'index.*'
      • build - doesn't have exactly one parameter

      Overridden:

      • OracleLc4jProvider.vectorIndex()
      • OracleLc4jProvider.dataSource()
      • OracleLc4jProvider.vectorIndex()
      • OracleLc4jProvider.dataSource()
      Returns:
      Actual Lc4j model builder configured with this blueprint.