zvec-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d2d9ae7fa3290edf87996ab690b06669c130f7d40c8f551c936fec0fcef7f21
+  data.tar.gz: 2ae81deaa2c80feecadeb7bf0a78431af054aee5dfc095f96f3069b45f5cab05
+SHA512:
+  metadata.gz: bda7fd52e20ab379efedace6180aca4925ef4136d0de0a8da068b96fc628ef1d7d98d0fcdad368f646098c06596bc6a81aedd85c41b94d4e2f51457a04b45a2a
+  data.tar.gz: 52adf87fc675871312342561fc5f1b04fa38519f2787d9e33680e3adecda84d9ab801c977dee97e26a077a6b2f4a6545a57e6110caf562a07a86e547b591195a

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-03-06
+
+### Added
+- Initial release
+- Rice-based C++ bindings for zvec vector database
+- Ruby DSL for schema definition (`Zvec::Schema`)
+- High-level `Zvec::Collection` with `add`, `search`, `query`, `fetch`, `delete`
+- `Zvec::Doc` with typed getters/setters and hash-like access
+- `Zvec::VectorQuery` for configuring vector similarity searches
+- Support for HNSW, Flat, and IVF index types
+- Support for L2, IP, and Cosine distance metrics
+- `Zvec::RubyLLM::Store` integration for ruby_llm gem
+- `Zvec::ActiveRecord::Vectorize` concern for Rails models
+- Data type constants for all scalar, vector, sparse vector, and array types

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 zvec-ruby contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,189 @@
+# zvec-ruby
+
+Ruby bindings for [zvec](https://github.com/alibaba/zvec), a high-performance C++ vector database from Alibaba. Built with [Rice](https://github.com/jasonroelofs/rice) (Ruby's C++ binding library).
+
+## Installation
+
+### Precompiled (recommended)
+
+Precompiled native gems are available for:
+
+| Platform | Architectures |
+|---|---|
+| Linux | x86_64, aarch64 |
+| macOS | x86_64 (Intel), arm64 (Apple Silicon) |
+
+```ruby
+# Gemfile
+gem "zvec"
+```
+
+```bash
+gem install zvec
+```
+
+No compiler or build tools needed — the gem ships with the native extension and all zvec dependencies statically linked.
+
+### From source
+
+If no precompiled gem is available for your platform, you'll need to build zvec first:
+
+```bash
+# 1. Build zvec from source
+git clone --depth 1 https://github.com/alibaba/zvec /tmp/zvec
+cd /tmp/zvec && mkdir build && cd build
+cmake .. -DCMAKE_BUILD_TYPE=Release
+make -j$(nproc)
+
+# 2. Install the gem with ZVEC_DIR pointing to the build
+ZVEC_DIR=/tmp/zvec gem install zvec
+```
+
+Or using the included helper script:
+
+```bash
+git clone https://github.com/johannesdwicahyo/zvec-ruby
+cd zvec-ruby
+./script/build_zvec.sh
+ZVEC_DIR=/tmp/zvec bundle install && bundle exec rake compile
+```
+
+## Quick Start
+
+```ruby
+require "zvec"
+
+# Define a schema
+schema = Zvec::Schema.new("my_collection") do
+  string "title"
+  int32  "year"
+  vector "embedding", dimension: 128,
+         index: Zvec::Ext::HnswIndexParams.new(Zvec::COSINE)
+end
+
+# Create and populate a collection
+collection = Zvec::Collection.create_and_open("/tmp/my_vectors", schema)
+
+collection.add(pk: "doc1", title: "Hello", year: 2025,
+               embedding: Array.new(128) { rand })
+
+# Search
+results = collection.search([0.1] * 128, top_k: 5)
+results.each { |doc| puts "#{doc.pk}: #{doc.score}" }
+
+# Clean up
+collection.destroy
+```
+
+## Schema DSL
+
+```ruby
+schema = Zvec::Schema.new("name") do
+  string  "title"
+  int32   "count"
+  int64   "big_count"
+  float   "score"
+  double  "precise_score"
+  bool    "active"
+  vector  "embedding", dimension: 1536
+  field   "tags", Zvec::ARRAY_STRING
+end
+```
+
+## Index Types
+
+```ruby
+# HNSW (default for vector search)
+Zvec::Ext::HnswIndexParams.new(Zvec::COSINE, m: 16, ef_construction: 200)
+
+# Flat (brute-force, exact)
+Zvec::Ext::FlatIndexParams.new(Zvec::L2)
+
+# IVF (inverted file index)
+Zvec::Ext::IVFIndexParams.new(Zvec::IP, n_list: 1024)
+
+# Inverted index (for scalar fields)
+Zvec::Ext::InvertIndexParams.new
+```
+
+## Collection API
+
+```ruby
+# CRUD
+collection.add(pk: "id", title: "text", embedding: [...])
+collection.upsert(doc)
+collection.delete("id1", "id2")
+collection.fetch("id1")
+
+# Search
+collection.search(vector, top_k: 10, filter: "year > 2024")
+
+# Full query control
+collection.query(
+  field_name: "embedding",
+  vector: [...],
+  topk: 10,
+  filter: "category='tech'",
+  include_vector: true,
+  output_fields: ["title", "url"]
+)
+
+# Management
+collection.flush
+collection.optimize
+collection.doc_count
+collection.destroy
+```
+
+## ruby_llm Integration
+
+```ruby
+require "zvec/ruby_llm"
+
+store = Zvec::RubyLLM::Store.new("/tmp/vectors", dimension: 1536, metric: :cosine)
+
+store.add("doc-1", embedding: [...], content: "Some text")
+store.search(query_embedding, top_k: 5)
+```
+
+## ActiveRecord Integration
+
+```ruby
+require "zvec/active_record"
+
+class Article < ApplicationRecord
+  include Zvec::ActiveRecord::Vectorize
+
+  vectorize :content,
+    dimensions: 1536,
+    embed_with: ->(text) { MyEmbedder.embed(text) }
+end
+
+# Automatic embedding on save
+article = Article.create!(title: "Hello", content: "World")
+
+# Vector similarity search
+Article.vector_search("similar articles", top_k: 5)
+Article.vector_search([0.1, 0.2, ...], top_k: 10, embed: false)
+```
+
+## Development
+
+```bash
+# Build zvec
+./script/build_zvec.sh
+
+# Compile and test
+ZVEC_DIR=/tmp/zvec bundle exec rake compile
+ZVEC_DIR=/tmp/zvec bundle exec rake test
+
+# Run pure Ruby tests only (no native extension needed)
+bundle exec rake test_pure
+
+# Package a native gem for your platform
+ruby script/package_native_gem.rb
+```
+
+## License
+
+Apache-2.0 (same as zvec)

data/Rakefile

@@ -0,0 +1,83 @@
+require "rake/extensiontask"
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+GEMSPEC = Gem::Specification.load("zvec.gemspec")
+
+CROSS_RUBIES = %w[3.1.0 3.2.0 3.3.0 3.4.0]
+CROSS_PLATFORMS = %w[
+  x86_64-linux
+  aarch64-linux
+  x86_64-darwin
+  arm64-darwin
+]
+
+Rake::ExtensionTask.new("zvec_ext", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/zvec"
+  ext.ext_dir = "ext/zvec"
+  ext.cross_compile  = true
+  ext.cross_platform = CROSS_PLATFORMS
+  ext.cross_compiling do |spec|
+    # Precompiled gems don't need ext/ sources or rice dependency
+    spec.files.reject! { |f| f.start_with?("ext/") }
+    spec.extensions.clear
+    spec.dependencies.reject! { |d| d.name == "rice" }
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test" << "lib"
+  t.pattern = "test/test_*.rb"
+  t.warning = true
+end
+
+desc "Run pure Ruby tests (no native extension required)"
+Rake::TestTask.new(:test_pure) do |t|
+  t.libs << "test" << "lib"
+  t.test_files = FileList[
+    "test/test_version.rb",
+    "test/test_data_types.rb",
+    "test/test_schema.rb",
+    "test/test_doc.rb",
+    "test/test_query.rb",
+    "test/test_active_record.rb",
+  ]
+  t.warning = true
+end
+
+namespace :gem do
+  desc "Build native gem for the current platform"
+  task :native do
+    platform = Gem::Platform.local.to_s
+    sh "gem build zvec.gemspec"
+    # Repackage with the precompiled .so/.bundle
+    puts "\nTo build a platform-specific gem, use:"
+    puts "  rake native gem RUBY_CC_VERSION=#{CROSS_RUBIES.join(':')}"
+  end
+
+  desc "Build precompiled gems for all platforms using rake-compiler-dock"
+  task :precompile do
+    require "rake_compiler_dock"
+
+    CROSS_PLATFORMS.each do |plat|
+      RakeCompilerDock.sh <<~SCRIPT, platform: plat
+        set -e
+        # Build zvec inside the container
+        git clone --depth 1 https://github.com/alibaba/zvec /tmp/zvec
+        cd /tmp/zvec && mkdir build && cd build
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local
+        make -j$(nproc)
+        make install
+        ldconfig 2>/dev/null || true
+
+        # Build the native gem
+        cd /payload
+        export ZVEC_DIR=/tmp/zvec
+        bundle install
+        rake native:#{plat} gem RUBY_CC_VERSION=#{CROSS_RUBIES.join(':')}
+      SCRIPT
+    end
+  end
+end
+
+task default: :compile

data/examples/basic.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require "zvec"
+
+# Define schema with a vector field and scalar fields
+schema = Zvec::Schema.new("my_docs") do
+  string "title"
+  string "category", nullable: true
+  int32  "year"
+  vector "embedding", dimension: 4,
+         index: Zvec::Ext::HnswIndexParams.new(Zvec::COSINE)
+end
+
+# Create collection
+path = "/tmp/zvec_ruby_example"
+FileUtils.rm_rf(path) if Dir.exist?(path)
+
+collection = Zvec::Collection.create_and_open(path, schema)
+
+# Insert documents
+docs = [
+  { pk: "doc1", title: "Ruby Gems", category: "programming", year: 2024,
+    embedding: [0.1, 0.2, 0.3, 0.4] },
+  { pk: "doc2", title: "Vector Databases", category: "databases", year: 2025,
+    embedding: [0.4, 0.3, 0.2, 0.1] },
+  { pk: "doc3", title: "Machine Learning", category: "ai", year: 2025,
+    embedding: [0.2, 0.4, 0.1, 0.3] },
+]
+
+docs.each do |d|
+  collection.add(pk: d[:pk], **d.except(:pk))
+end
+
+puts "Inserted #{collection.doc_count} documents"
+
+# Search
+query_vector = [0.1, 0.2, 0.3, 0.4]
+results = collection.search(query_vector, top_k: 2)
+
+puts "\nSearch results (top 2):"
+results.each do |doc|
+  puts "  #{doc.pk}: score=#{doc.score}, title=#{doc["title"]}"
+end
+
+# Fetch by ID
+fetched = collection.fetch("doc2")
+puts "\nFetched doc2: #{fetched["doc2"]&.to_h}"
+
+# Filter query
+results = collection.query(
+  field_name: "embedding",
+  vector: query_vector,
+  topk: 10,
+  filter: "year == 2025"
+)
+
+puts "\nFiltered results (year=2025):"
+results.each do |doc|
+  puts "  #{doc.pk}: #{doc["title"]}"
+end
+
+# Cleanup
+collection.destroy
+puts "\nDone!"

data/examples/with_ruby_llm.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+require "zvec/ruby_llm"
+# require "ruby_llm"  # Uncomment when ruby_llm is installed
+
+# This example shows how to use Zvec as a vector store with the ruby_llm gem.
+#
+# Prerequisites:
+#   gem install ruby_llm
+#   export OPENAI_API_KEY=your_key
+#
+# The Zvec::RubyLLM::Store provides a simple interface for storing and
+# retrieving embeddings that can be used with any LLM framework.
+
+DIMENSION = 4  # Use 1536 for OpenAI text-embedding-3-small
+
+# Create a vector store
+store = Zvec::RubyLLM::Store.new(
+  "/tmp/zvec_ruby_llm_example",
+  dimension: DIMENSION,
+  metric: :cosine
+)
+
+# --- Option A: Manual embeddings (for demo without API keys) ---
+
+store.add("chunk-1",
+  embedding: [0.1, 0.2, 0.3, 0.4],
+  content: "Ruby is a dynamic, open source programming language."
+)
+
+store.add("chunk-2",
+  embedding: [0.4, 0.3, 0.2, 0.1],
+  content: "Vector databases store and search high-dimensional vectors."
+)
+
+store.add_many([
+  {
+    id: "chunk-3",
+    embedding: [0.2, 0.4, 0.1, 0.3],
+    content: "Machine learning models generate embeddings from text."
+  },
+  {
+    id: "chunk-4",
+    embedding: [0.3, 0.1, 0.4, 0.2],
+    content: "Retrieval-augmented generation improves LLM responses."
+  }
+])
+
+store.flush
+
+puts "Stored #{store.count} documents"
+
+# Search
+results = store.search([0.1, 0.2, 0.3, 0.4], top_k: 3)
+
+puts "\nSearch results:"
+results.each do |r|
+  puts "  [#{r[:score].round(4)}] #{r[:id]}: #{r[:content]}"
+end
+
+# --- Option B: With ruby_llm (uncomment below) ---
+#
+# RubyLLM.configure do |config|
+#   config.openai_api_key = ENV["OPENAI_API_KEY"]
+# end
+#
+# # Use OpenAI to generate real embeddings
+# embed = ->(text) { RubyLLM.embed(text).vectors.first }
+#
+# store.add("real-1",
+#   embedding: embed.call("The quick brown fox"),
+#   content: "The quick brown fox jumps over the lazy dog."
+# )
+#
+# query_embedding = embed.call("fast animal")
+# results = store.search(query_embedding, top_k: 5)
+
+# Cleanup
+store.collection.destroy
+puts "\nDone!"