Merge branch 'main' into replace_object

Author: cameronmccord2

CHANGELOG.md

@@ -11,6 +11,16 @@
 - 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
 

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:[email protected]).
+
 ![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
@@ -305,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.

lib/weaviate/client.rb

@@ -10,6 +10,7 @@ class Client
     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",

lib/weaviate/schema.rb

@@ -43,7 +43,11 @@ def create(
         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