weaviate-ruby 0.8.9 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8289cf9c5b37631db1c1d0607f0e2820477e8edb637b34a3efbef8bc80af80bf
-  data.tar.gz: 7423bff81c02baad908512e0818abc43fbbcc3d0204b4ada1c2f978493349737
+  metadata.gz: f1533db1f83e65e849863776ab0312149c0e5dcdcbb2c65ea922294ea9af6ee7
+  data.tar.gz: ce9ca1a00db9c4b117a8c19216c9049663f481750b7773bd69a4637f26074282
 SHA512:
-  metadata.gz: 4887f5222fbb592df702fbc2a6907f5513285143c4b3bb838486120045de58a2d866554d340ed098a9c3edb6a090e96e941f879e27c3bfa9654aa39ed5afcc78
-  data.tar.gz: a708d38650a8e83e94bd660b2a34860488e0e123eb3e69c6afc868b832e69a6c352468d30d1b101b0ed757d855420a40651d16bc7da08e8adac151fbd6690f7c
+  metadata.gz: 8af749e6537bdef2d2c87fdc0b0724e860368f00f37550c94a7b3e0139555c89d624fda050abda601b7c7d317ad9eccdfb01ee654586e6ce038e7048128d37cb
+  data.tar.gz: 4afef756ad24eba7c8fb9314219dda512e49ae2cf0dc07ce9f8cc9ec1269d4b71c7ef738b4f36de780147e9b707f384bf0cb271d7ebf57d3333c2ce9e135ac07

data/Gemfile

@@ -9,3 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 gem "standard", "~> 1.25.0"
+gem "graphql-client", "~> 0.19.0"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    weaviate-ruby (0.8.9)
+    weaviate-ruby (0.8.11)
       faraday (>= 2.0.1, < 3.0)
       graphlient (~> 0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.0)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -19,14 +19,14 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.0)
-    drb (2.1.1)
+    drb (2.2.0)
       ruby2_keywords
     faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
@@ -35,8 +35,9 @@ GEM
     graphlient (0.7.0)
       faraday (~> 2.0)
       graphql-client
-    graphql (2.1.1)
-    graphql-client (0.18.0)
+    graphql (2.2.6)
+      racc (~> 1.4)
+    graphql-client (0.19.0)
       activesupport (>= 3.0)
       graphql
     i18n (1.14.1)
@@ -44,8 +45,8 @@ GEM
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.20.0)
-    mutex_m (0.1.2)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
@@ -55,6 +56,7 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.0.6)
     rdiscount (2.2.7.1)
@@ -101,11 +103,13 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-darwin-19
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  graphql-client (~> 0.19.0)
   pry-byebug (~> 3.9)
   rake (~> 13.0)
   rdiscount

data/README.md

@@ -10,11 +10,14 @@ Ruby wrapper for the Weaviate.io API.
 
 Part of the [Langchain.rb](https://github.com/andreibondarev/langchainrb) stack.
 
+Available for paid consulting engagements! [Email me](mailto:andrei@sourcelabs.io).
+
 ![Tests status](https://github.com/andreibondarev/weaviate-ruby/actions/workflows/ci.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/weaviate-ruby.svg)](https://badge.fury.io/rb/weaviate-ruby)
 [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/weaviate-ruby)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/andreibondarev/weaviate-ruby/blob/main/LICENSE.txt)
 [![](https://dcbadge.vercel.app/api/server/WDARp7J2n8?compact=true&style=flat)](https://discord.gg/WDARp7J2n8)
+[![X](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40rushing_andrei)](https://twitter.com/rushing_andrei)
 
 ## Installation
 
@@ -63,7 +66,7 @@ client.schema.create(
             "name": "category"
         }
     ],
-    # Possible values: 'text2vec-cohere', 'text2vec-openai', 'text2vec-huggingface', 'text2vec-transformers', 'text2vec-contextionary', 'img2vec-neural', 'multi2vec-clip', 'ref2vec-centroid'
+    # Possible values: 'text2vec-cohere', 'text2vec-ollama', 'text2vec-openai', 'text2vec-huggingface', 'text2vec-transformers', 'text2vec-contextionary', 'img2vec-neural', 'multi2vec-clip', 'ref2vec-centroid'
     vectorizer: "text2vec-openai"
 )
 
@@ -73,9 +76,6 @@ client.schema.get(class_name: 'Question')
 # Get the schema
 client.schema.list()
 
-# Remove a class (and all data in the instances) from the schema.
-client.schema.delete(class_name: 'Question')
-
 # Update settings of an existing schema class.
 # Does not support modifying existing properties.
 client.schema.update(
@@ -94,6 +94,51 @@ client.schema.add_property(
 
 # Inspect the shards of a class
 client.schema.shards(class_name: 'Question')
+
+# Remove a class (and all data in the instances) from the schema.
+client.schema.delete(class_name: 'Question')
+
+# Creating a new data object class in the schema while configuring the vectorizer on the schema and on individual properties (Ollama example)
+client.schema.create(
+    class_name: 'Question',
+    description: 'Information from a Jeopardy! question',
+    properties: [
+        {
+            "dataType": ["text"],
+            "description": "The question",
+            "name": "question"
+            # By default all properties are included in the vector
+        }, { 
+            "dataType": ["text"],
+            "description": "The answer",
+            "name": "answer",
+            "moduleConfig": {
+                "text2vec-ollama": {
+                    "skip": false,
+                    "vectorizePropertyName": true,
+                },
+            },
+        }, {
+            "dataType": ["text"],
+            "description": "The category",
+            "name": "category",
+            "indexFilterable": true,
+            "indexSearchable": false,
+            "moduleConfig": {
+                "text2vec-ollama": {
+                    "skip": true, # Don't include in the vector
+                },
+            },
+        }
+    ],
+    vectorizer: "text2vec-ollama",
+    module_config: {
+        "text2vec-ollama": {
+            apiEndpoint: "http://localhost:11434",
+            model: "mxbai-embed-large",
+        },
+    },
+)
 ```
 
 ### Using the Objects endpoint
@@ -296,6 +341,30 @@ client.live?
 client.ready?
 ```
 
+### Tenants
+
+Any schema can be multi-tenant
+
+```ruby
+client.schema.create(
+    # Other keys...
+    mutli_tenant: true, # passes { enabled: true } to weaviate
+)
+```
+
+You can also manually specify your multi tenancy configuration with a hash
+
+```ruby
+client.schema.create(
+    # Other keys...
+    mutli_tenant: { enabled: true, autoTenantCreation: true, autoTenantActivation: true },
+)
+```
+
+See [Weaviate Multi-tenancy operations](https://weaviate.io/developers/weaviate/manage-data/multi-tenancy). Note that the mix of snake case(used by Ruby) and lower camel case(used by Weaviate) is intentional as that hash is passed directly to Weaviate.
+
+All data methods in this library support an optional `tenant` argument which must be passed if multi-tenancy is enabled on the related collection
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/weaviate/client.rb

@@ -10,6 +10,7 @@ module Weaviate
     API_VERSION = "v1"
 
     API_KEY_HEADERS = {
+      ollama: "X-Ollama-Not-Used",
       openai: "X-OpenAI-Api-Key",
       azure_openai: "X-Azure-Api-Key",
       cohere: "X-Cohere-Api-Key",

data/lib/weaviate/objects.rb

@@ -61,13 +61,15 @@ module Weaviate
     # Batch create objects
     def batch_create(
       objects:,
-      consistency_level: nil
+      consistency_level: nil,
+      tenant: nil
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
 
       response = client.connection.post("batch/#{PATH}") do |req|
         req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
         req.body = {objects: objects}
+        req.body["tenant"] = tenant unless tenant.nil?
       end
 
       response.body
@@ -78,12 +80,14 @@ module Weaviate
       class_name:,
       id:,
       include: nil,
-      consistency_level: nil
+      consistency_level: nil,
+      tenant: nil
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
 
       response = client.connection.get("#{PATH}/#{class_name}/#{id}") do |req|
         req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
+        req.params["tenant"] = tenant unless tenant.nil?
         req.params["include"] = include unless include.nil?
       end
 
@@ -94,12 +98,14 @@ module Weaviate
     def exists?(
       class_name:,
       id:,
-      consistency_level: nil
+      consistency_level: nil,
+      tenant: nil
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
 
       response = client.connection.head("#{PATH}/#{class_name}/#{id}") do |req|
         req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
+        req.params["tenant"] = tenant unless tenant.nil?
       end
 
       response.status == 204
@@ -111,6 +117,7 @@ module Weaviate
       id:,
       properties:,
       vector: nil,
+      tenant: nil,
       consistency_level: nil
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
@@ -123,6 +130,7 @@ module Weaviate
         req.body["class"] = class_name
         req.body["properties"] = properties
         req.body["vector"] = vector unless vector.nil?
+        req.body["tenant"] = tenant unless tenant.nil?
       end
 
       response.body
@@ -132,12 +140,14 @@ module Weaviate
     def delete(
       class_name:,
       id:,
-      consistency_level: nil
+      consistency_level: nil,
+      tenant: nil
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
 
       response = client.connection.delete("#{PATH}/#{class_name}/#{id}") do |req|
         req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
+        req.params["tenant"] = tenant unless tenant.nil?
       end
 
       if response.success?
@@ -152,14 +162,13 @@ module Weaviate
       where:,
       consistency_level: nil,
       output: nil,
-      dry_run: nil
+      dry_run: nil,
+      tenant: nil
     )
       path = "batch/#{PATH}"
 
       unless consistency_level.nil?
         validate_consistency_level!(consistency_level)
-
-        path << "?consistency_level=#{consistency_level.to_s.upcase}"
       end
 
       response = client.connection.delete(path) do |req|
@@ -171,6 +180,8 @@ module Weaviate
         }
         req.body["output"] = output unless output.nil?
         req.body["dryRun"] = dry_run unless dry_run.nil?
+        req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
+        req.params["tenant"] = tenant unless tenant.nil?
       end
 
       response.body

data/lib/weaviate/query.rb

@@ -48,6 +48,7 @@ module Weaviate
     def aggs(
       class_name:,
       fields: nil,
+      tenant: nil,
       where: nil,
       object_limit: nil,
       near_text: nil,
@@ -59,6 +60,7 @@ module Weaviate
       response = client.graphql.execute(
         aggs_query(
           class_name: class_name,
+          tenant: tenant,
           fields: fields,
           where: where,
           near_text: near_text,
@@ -164,7 +166,7 @@ module Weaviate
               limit: $limit,
               offset: $offset,
               #{(!autocut.nil?) ? "autocut: #{autocut}" : ""},
-              #{(!tenant.nil?) ? "tenant: #{tenant}" : ""},
+              #{(!tenant.nil?) ? "tenant: \"#{tenant}\"" : ""},
               #{(!near_text.nil?) ? "nearText: #{near_text}" : ""},
               #{(!near_vector.nil?) ? "nearVector: #{near_vector}" : ""},
               #{(!near_image.nil?) ? "nearImage: #{near_image}" : ""},
@@ -185,6 +187,7 @@ module Weaviate
     def aggs_query(
       class_name:,
       fields:,
+      tenant: nil,
       where: nil,
       near_text: nil,
       near_vector: nil,
@@ -200,6 +203,7 @@ module Weaviate
             #{class_name}(
               objectLimit: $object_limit,
               groupBy: $group_by,
+              #{(!tenant.nil?) ? "tenant: \"#{tenant}\"" : ""},
               #{(!near_text.nil?) ? "nearText: #{near_text}" : ""},
               #{(!near_vector.nil?) ? "nearVector: #{near_vector}" : ""},
               #{(!near_image.nil?) ? "nearImage: #{near_image}" : ""},

data/lib/weaviate/schema.rb

@@ -43,7 +43,11 @@ module Weaviate
         req.body["vectorizer"] = vectorizer unless vectorizer.nil?
         req.body["moduleConfig"] = module_config unless module_config.nil?
         req.body["properties"] = properties unless properties.nil?
-        req.body["multiTenancyConfig"] = {enabled: true} unless multi_tenant.nil?
+        if multi_tenant.is_a?(Hash)
+          req.body["multiTenancyConfig"] = multi_tenant
+        elsif multi_tenant.present?
+          req.body["multiTenancyConfig"] = {enabled: true}
+        end
         req.body["invertedIndexConfig"] = inverted_index_config unless inverted_index_config.nil?
         req.body["replicationConfig"] = replication_config unless replication_config.nil?
       end

data/lib/weaviate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Weaviate
-  VERSION = "0.8.9"
+  VERSION = "0.8.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weaviate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.11
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Weaviate.io API