weaviate-ruby 0.8.10 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78db75797066d9789e8c9da6e48aeb031f71f8d47709b87b08ce5caac3b3e04b
-  data.tar.gz: 96f9491d8ea9970cb2b2e0a1b5935b66ff63c18629055b5b08de9a9967167387
+  metadata.gz: df0801c83bc409a791c5a2737f0574def072660fdac96b32261b02aaa6665f33
+  data.tar.gz: d720fc99beed7b91b844479116caa54f6805e8807c4375e67bdffdb9a52573fe
 SHA512:
-  metadata.gz: 621fb1ba1685ac3c934e545732184b10509dc4366089cc8d6e985dbfe49144aa82894e78281c0761857999b920b549a1ccc3da863f3a85d3843e9c2cdeef0128
-  data.tar.gz: 17b5588cddb8ada1fd1ebe0e8bd877d74ca637a9756f686418c6a751504ef3b54369ed7c0a2ee319802d72b87329108a018ed1b5041af2103f6511438fa03170
+  metadata.gz: 807e7b52c259e8559c0b581c1d96a175e95bba8dff16091dd67746a41451b10b3f68c26bbc081c22c862eafeeac2c9d65a7aa12dcbbf69d5521cab8b98cc3275
+  data.tar.gz: 203f861b21b501deff8a787168920c3946cd28682112aa73ed3fc238a52feeb4dd6ee0a5d1eef7c28258210e88b3aca232fa63ee027fce976ab2c54ccba1e12c

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+## [0.9.0] - 2024-07-08
+
+- Add object.replace method which uses PUT which performs a complete object replacement
+
+### Breaking
+- Change the object.update method to use PATCH which only performs a partial update(previously performed a replacement)
+
+## [0.8.11] - 2024-07-02
+- Allow the user to specify any options they want for multi-tenancy when creating a schema using their own hash
+- Allow Ollama vectorizer
+
+## [0.8.10] - 2024-01-25
+
+## [0.8.9] - 2023-10-10
+
+## [0.8.8] - 2023-10-10
+
+## [0.8.7] - 2023-09-11
+
+## [0.8.6] - 2023-08-10
+
 ## [0.8.5] - 2023-07-19
 - Add multi-tenancy support
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weaviate-ruby (0.8.10)
+    weaviate-ruby (0.9.0)
       faraday (>= 2.0.1, < 3.0)
       graphlient (~> 0.7.0)
 

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
@@ -123,14 +168,17 @@ client.objects.exists?(
     id: "uuid"
 )
 
-# Delete a single data object from Weaviate.
-client.objects.delete(
+# Perform a partial update on an object based on its uuid.
+client.objects.update(
     class_name: "Question",
-    id: "uuid"
+    id: "uuid",
+    properties: {
+        category: "simple-math"
+    }
 )
 
-# Update a single data object based on its uuid.
-client.objects.update(
+# Replace an object based on its uuid.
+client.objects.replace(
     class_name: "Question",
     id: "uuid",
     properties: {
@@ -140,6 +188,12 @@ client.objects.update(
     }
 )
 
+# Delete a single data object from Weaviate.
+client.objects.delete(
+    class_name: "Question",
+    id: "uuid"
+)
+
 # Batch create objects
 client.objects.batch_create(objects: [
     {
@@ -296,6 +350,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

@@ -122,6 +122,31 @@ module Weaviate
     )
       validate_consistency_level!(consistency_level) unless consistency_level.nil?
 
+      response = client.connection.patch("#{PATH}/#{class_name}/#{id}") do |req|
+        req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
+
+        req.body = {}
+        req.body["id"] = id
+        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
+    end
+
+    # Replace an individual data object based on its uuid.
+    def replace(
+      class_name:,
+      id:,
+      properties:,
+      vector: nil,
+      tenant: nil,
+      consistency_level: nil
+    )
+      validate_consistency_level!(consistency_level) unless consistency_level.nil?
+
       response = client.connection.put("#{PATH}/#{class_name}/#{id}") do |req|
         req.params["consistency_level"] = consistency_level.to_s.upcase unless consistency_level.nil?
 
@@ -162,14 +187,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|
@@ -181,6 +205,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,
@@ -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.10"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weaviate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.9.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday