Elixir bindings for zvec, an in-process vector database.

This module manages the zvec library lifecycle: initialization, shutdown, and version introspection. For collection operations, use the dedicated modules:

Quick Start

alias Zvex.{Collection, Document, Query, Vector}
alias Zvex.Collection.Schema

# Initialize the library
:ok = Zvex.initialize()

# Define a schema
schema =
  Schema.new("products")
  |> Schema.add_field("id", :string, primary_key: true)
  |> Schema.add_field("embedding", :vector_fp32,
       dimension: 128,
       index: [type: :hnsw, metric: :cosine])
  |> Schema.add_field("name", :string)

# Create a collection and insert a document
{:ok, coll} = Collection.create("/tmp/products", schema)

doc =
  Document.new()
  |> Document.put_pk("prod-1")
  |> Document.put("name", "Widget")
  |> Document.put("embedding", Vector.from_list(List.duplicate(0.1, 128), :fp32))

{:ok, _} = Collection.insert(coll, doc)

# Query nearest neighbors
query_vec = Vector.from_list(List.duplicate(0.1, 128), :fp32)

{:ok, results} =
  Query.new()
  |> Query.field("embedding")
  |> Query.vector(query_vec)
  |> Query.top_k(5)
  |> Query.execute(coll)

:ok = Collection.close(coll)
:ok = Zvex.shutdown()

Error Handling

Every fallible function comes in two flavours:

• fun/n returns {:ok, result} or {:error, %Zvex.Error{}}.
• fun!/n returns the unwrapped result or raises.

See Zvex.Error for the full error hierarchy.