Deprecate Epsilla vectordb (#958)

* Deprecate Langchain::Vectorsearch::Epsilla

* Deprecate Langchain::Vectorsearch::Epsilla

* Move require('epsilla') inside the if statement

Author: andreibondarev

.env.example

@@ -7,7 +7,6 @@ CHROMA_URL=
 COHERE_API_KEY=
 ELASTICSEARCH_URL=https://[username]:[password]@localhost:9200
 ELASTICSEARCH_CA_FINGERPRINT=
-EPSILLA_URL=
 GOOGLE_VERTEX_AI_PROJECT_ID=
 # Automagical name which is picked up by Google Cloud Ruby auth module. If set, takes auth token from that key file.
 GOOGLE_CLOUD_CREDENTIALS=

.github/workflows/ci.yml

@@ -11,7 +11,6 @@ jobs:
   tests:
     env:
       POSTGRES_URL: postgresql://postgres:postgres@localhost:5432/postgres
-      EPSILLA_URL: http://127.0.0.1:8888
 
     runs-on: ubuntu-latest
     strategy:
@@ -26,13 +25,6 @@ jobs:
         env:
           POSTGRES_PASSWORD: postgres
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
-      epsilla:
-        image: epsilla/vectordb:0.3.12
-        ports:
-          - 8888:8888
-        # Faster health checks
-        options: >-
-          --health-interval 1s
 
     steps:
       - uses: actions/checkout@master

CHANGELOG.md

@@ -13,6 +13,7 @@
 - [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/859] Add metadata support to PgVector storage
 - [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/939] Fix Langchain::Vectorsearch::Milvus initializer by passing :api_key
 - [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/953] Handle nil response in OpenAI LLM streaming
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/956] Deprecate `Langchain::Vectorsearch::Epsilla` class
 
 ## [0.19.4] - 2025-02-17
 - [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/894] Tools can now output image_urls, and all tool output must be wrapped by a tool_response() method

Gemfile.lock

@@ -139,8 +139,6 @@ GEM
       elasticsearch-api (= 8.2.2)
     elasticsearch-api (8.2.2)
       multi_json
-    epsilla-ruby (0.0.4)
-      faraday (>= 1)
     eqn (1.6.5)
       treetop (>= 1.2.0)
     erubi (1.13.0)
@@ -462,7 +460,6 @@ DEPENDENCIES
   docx (~> 0.8.0)
   dotenv-rails (~> 3.1.6)
   elasticsearch (~> 8.2.0)
-  epsilla-ruby (~> 0.0.4)
   eqn (~> 1.6.5)
   faraday
   google_search_results (~> 2.0.0)

README.md

@@ -387,7 +387,6 @@ Langchain.rb provides a convenient unified interface on top of supported vectors
 | Database                                                                                   | Open-source        | Cloud offering     |
 | --------                                                                                   |:------------------:| :------------:     |
 | [Chroma](https://trychroma.com/?utm_source=langchainrb&utm_medium=github)                  | ✅                 | ✅                 |
-| [Epsilla](https://epsilla.com/?utm_source=langchainrb&utm_medium=github)                   | ✅                 | ✅                 |
 | [Hnswlib](https://github.com/nmslib/hnswlib/?utm_source=langchainrb&utm_medium=github)     | ✅                 | ❌                 |
 | [Milvus](https://milvus.io/?utm_source=langchainrb&utm_medium=github)                      | ✅                 | ✅ Zilliz Cloud    |
 | [Pinecone](https://www.pinecone.io/?utm_source=langchainrb&utm_medium=github)              | ❌                 | ✅                 |
@@ -420,7 +419,6 @@ client = Langchain::Vectorsearch::Weaviate.new(
 You can instantiate any other supported vector search database:
 ```ruby
 client = Langchain::Vectorsearch::Chroma.new(...)   # `gem "chroma-db", "~> 0.6.0"`
-client = Langchain::Vectorsearch::Epsilla.new(...)  # `gem "epsilla-ruby", "~> 0.0.3"`
 client = Langchain::Vectorsearch::Hnswlib.new(...)  # `gem "hnswlib", "~> 0.8.1"`
 client = Langchain::Vectorsearch::Milvus.new(...)   # `gem "milvus", "~> 0.9.3"`
 client = Langchain::Vectorsearch::Pinecone.new(...) # `gem "pinecone", "~> 0.1.6"`

langchain.gemspec

@@ -50,7 +50,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "cohere-ruby", "~> 0.9.10"
   spec.add_development_dependency "docx", "~> 0.8.0"
   spec.add_development_dependency "elasticsearch", "~> 8.2.0"
-  spec.add_development_dependency "epsilla-ruby", "~> 0.0.4"
   spec.add_development_dependency "eqn", "~> 1.6.5"
   spec.add_development_dependency "faraday"
   spec.add_development_dependency "googleauth"

lib/langchain/vectorsearch/base.rb

@@ -7,7 +7,6 @@ module Langchain::Vectorsearch
   # == Available vector databases
   #
   # - {Langchain::Vectorsearch::Chroma}
-  # - {Langchain::Vectorsearch::Epsilla}
   # - {Langchain::Vectorsearch::Elasticsearch}
   # - {Langchain::Vectorsearch::Hnswlib}
   # - {Langchain::Vectorsearch::Milvus}
@@ -30,7 +29,6 @@ module Langchain::Vectorsearch
   #     )
   #
   #     # You can instantiate other supported vector databases the same way:
-  #     epsilla  = Langchain::Vectorsearch::Epsilla.new(...)
   #     milvus   = Langchain::Vectorsearch::Milvus.new(...)
   #     qdrant   = Langchain::Vectorsearch::Qdrant.new(...)
   #     pinecone = Langchain::Vectorsearch::Pinecone.new(...)

lib/langchain/vectorsearch/epsilla.rb

@@ -21,6 +21,8 @@ class Epsilla < Base
     # @param index_name [String] The name of the Epsilla table to use
     # @param llm [Object] The LLM client to use
     def initialize(url:, db_name:, db_path:, index_name:, llm:)
+      Langchain.logger.warn "DEPRECATED: `Langchain::Vectorsearch::Epsilla` is deprecated, and will be removed in the next major version. Please use other vector storage engines."
+
       depends_on "epsilla-ruby", req: "epsilla"
 
       uri = URI.parse(url)

spec/langchain/vectorsearch/epsilla_spec.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "epsilla"
-
 if ENV["EPSILLA_URL"]
+  require "epsilla"
+
   RSpec.describe Langchain::Vectorsearch::Epsilla do
     let(:index_name) { "documents" }