Package dev.langchain4j.store.embedding.oracle

Class Index

java.lang.Object
dev.langchain4j.store.embedding.oracle.Index
public class Index extends Object

Represents a database index. Indexes can be configured using two builders:

IVFIndexBuilder allows to configure an Inverted File Flat (IVF) index on the embedding column of the EmbeddingTable.

JSONIndexBuilder allows to configure 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.

  • Method Details

    • ivfIndexBuilder

      public static IVFIndexBuilder ivfIndexBuilder()
      Creates a builder to configure an IVF index on the embedding column of the EmbeddingTable.
      Returns:
      A builder that allows to configure an IVF index.

    • jsonIndexBuilder

      public static JSONIndexBuilder jsonIndexBuilder()
      Creates a builder to configure a function-based index on one or several keys of the metadata column of the EmbeddingTable.
      Returns:
      A builder that allows to configure an index on the metadata column.

    • name

      public String name()
      Returns the name of the index.
      Returns:
      The name of the index or null if the name has not been set and the index has not been created.

    • tableName

      public String tableName()
      Returns the name of this table.
      Returns:
      Once the index has been created it returns the table name, otherwise it returns null.