Database

Object Hierarchy:

Description:

// Register tool config type
OLLMvector.Tool.CodebaseSearchTool.register_config();
OLLMvector.Tool.CodebaseSearchTool.setup_tool_config(config);

// Get dimension first, then create database
var temp_db = new OLLMvector.Database(config, "/path/to/index.faiss", OLLMvector.Database.DISABLE_INDEX);
var dimension = yield temp_db.embed_dimension();
var db = new OLLMvector.Database(config, "/path/to/index.faiss", dimension);

// Add documents (automatically generates embeddings)
yield db.add_documents({"document 1", "document 2"});

// Search
var results = yield db.search("query text", k: 10);

// Save index
db.save_index();

Content:

Constants:

• public const int DISABLE_INDEX
  Sentinel value to indicate index should not be created in constructor. Use this when creating a temporary Database instance just to check dimension.

Properties:

• public int dimension { get; }
  The embedding dimension.
• public uint64 vector_count { get; }
  The total number of vectors in the index.

Static methods:

• public static async bool check_required_models_available (Config2 config)
  Checks if the required models for codebase search are available on the server.

Creation methods:

• public Database (Config2 config, string filename, int dimension) throws Error
  Constructor.

Methods:

• public async void add_documents (string[] texts) throws Error
• public void add_vectors_batch (FloatArray vectors) throws Error
  Adds vectors in batch to the FAISS index.
• public async int embed_dimension () throws Error
  Gets the embedding dimension by doing a test embed.
• public void save_index () throws Error
  Saves the index to the file specified in constructor.
• public async SearchResultWithDocument[] search (string query, uint64 k = 5) throws Error

Inherited Members: