Index

Object Hierarchy:

Description:

// Create or load index
var index = new OLLMvector.Index("/path/to/index.faiss", 1024);

// Add vectors
var vectors = new OLLMchat.Response.FloatArray(1024);
vectors.add(vector1);
vectors.add(vector2);
index.add_vectors(vectors);

// Search for similar vectors
var results = index.search(query_vector, k: 10);

// Save index to disk
index.save_to_file("/path/to/index.faiss");

Content:

Properties:

• public int dimension { get; }
  The dimension (width) of vectors in this index.
• public int64[] map { get; }
  For tmp indexes built with @copy_from: FAISS label @i → source index vector_id. Only indices @i < @get_total_vectors are used; array may be longer if some ids were skipped. Empty: no remap (normal on-disk index).

Creation methods:

• public Index (string filename, int dim) throws Error
  Constructor.
• public Index.create_tmp_hnsw (int dim) throws Error
  In-RAM HNSWFlat (M=16), not backed by a file. Use @copy_from then @ search; @map holds label→source ids.

Methods:

• public void add_vectors (FloatArray vectors) throws Error
  Adds vectors in batch to the FAISS index.
• public uint64 copy_from (Index src, ArrayList<int> source_vector_ids) throws Error
  Call only on an empty tmp index. Reconstructs vectors from @src for each id in order.
• public uint64 get_total_vectors ()
  Gets the total number of vectors in the index.
• public float[] reconstruct_vector (int64 vector_id) throws Error
  Reconstruct a vector by its ID.
• public void save_to_file (string filename) throws Error
  Saves the FAISS index to a file.
• public SearchResult[] search (float[] query_vector, uint64 k = 5, IDSelector? selector = null) throws Error
  Search for similar vectors.

Inherited Members: