weaviate-ruby 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f87a5670b340fe00f3634f0cf7d22b3c699b0737d3cb326d4ec7d55085cea2
-  data.tar.gz: 0b7fbe6084e04d5d1a006871deab4972aa965a65bd5bf8080a58f045787841fd
+  metadata.gz: ad58e91ebbe32128a41045dd5f04b82dcf7b97030af3609d21b8384fdd755cd9
+  data.tar.gz: e4da33cbb7a6a09b06ff65b19ee3addf83f7b4d2fe98311158586d1bd3147983
 SHA512:
-  metadata.gz: dee8739ad9cd3bb53ae226bd4be6b041fc9af449d47ff6347088514b2db2bfc2adef35e9fc2ff2c6c431ee5f2d311e49c5f78569ff473e36b8da366a01dd9d48
-  data.tar.gz: 5dd898fd6c88899b119721369d0f606114cf1be480be31218adbe506954cba1b110f9eead1f135b5619e067d7328aeefd405762159912f93996f9f098b2ff62e
+  metadata.gz: 5d860ad3d6f33ab341181c6807d7c99b33bed83740ddeca9f297d856791498cfb6028f4bec710667d3d4d80a3d630ec0b95f90018ce23c9d530bd7bafb817d47
+  data.tar.gz: f54b9d91b2ecb8fdfc8db95d4c654d43fdd5ae28f3561545e19dc39e652bb9dbd838fe77479c909445eb40a905c747924aca715a9e45cef03467e7c358b60a53

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weaviate-ruby (0.4.0)
+    weaviate-ruby (0.6.0)
       faraday (~> 2.7)
       graphlient (~> 0.7.0)
 

data/README.md

@@ -22,6 +22,7 @@ require 'weaviate'
 client = Weaviate::Client.new(
     scheme: 'https',
     host: 'some-endpoint.weaviate.network',  # Replace with your endpoint
+    api_key: '', # Weaviate API key
     model_service: :openai, # Service that will be used to generate vectors. Possible values: :openai, :cohere, :huggingface
     model_service_api_key: 'xxxxxxx' # Either OpenAI, Cohere or Hugging Face API key
 )
@@ -134,6 +135,16 @@ response = client.objects.batch_create(objects: [
     }
 ])
 response.data
+
+# Batch delete objects
+client.objects.batch_delete(
+    class_name: "Question",
+    where: {
+        valueString: "1",
+        operator: "Equal",
+        path: ["id"]
+    }
+)
 ```
 
 ### Querying
@@ -187,12 +198,50 @@ client.query.aggs(
 )
 ```
 
-#### Nodes
+### Classification
+```ruby
+client.classifications.create(
+    type: "zeroshot",
+    class_name: "Posts",
+    classify_properties: ["hasColor"],
+    based_on_properties: ["text"]
+)
+
+client.classifications.get(
+    id: ""
+)
+```
+
+### Backups
+```ruby
+client.backups.create(
+    backend: "filesystem",
+    id: "my-first-backup",
+    include: ["Question"]
+)
+
+client.backups.get(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+
+client.backups.restore(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+
+client.backups.restore_status(
+    backend: "filesystem",
+    id: "my-first-backup"
+)
+```
+
+### Nodes
 ```ruby
 client.nodes
 ```
 
-#### Health
+### Health
 ```ruby
 client.live?
 client.ready?

data/lib/weaviate/backups.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Backups < Base
+    PATH = "backups"
+
+    def create(
+      backend:,
+      id:,
+      include: nil,
+      exclude: nil
+    )
+      response = client.connection.post("#{PATH}/#{backend}") do |req|
+        req.body = {}
+        req.body["id"] = id
+        req.body["include"] = include if include
+        req.body["exclude"] = exclude if exclude
+      end
+
+      response.body
+    end
+
+    def get(
+      backend:,
+      id:
+    )
+      response = client.connection.get("#{PATH}/#{backend}/#{id}")
+      response.body
+    end
+
+    def restore(
+      backend:,
+      id:,
+      include: nil,
+      exclude: nil
+    )
+      response = client.connection.post("#{PATH}/#{backend}/#{id}/restore") do |req|
+        req.body = {}
+        req.body["include"] = include if include
+        req.body["exclude"] = exclude if exclude
+      end
+
+      response.body
+    end
+
+    def restore_status(
+      backend:,
+      id:
+    )
+      response = client.connection.get("#{PATH}/#{backend}/#{id}/restore")
+      response.body
+    end
+  end
+end

data/lib/weaviate/classifications.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Classifications < Base
+    PATH = "classifications"
+
+    def get(id:)
+      response = client.connection.get("#{PATH}/#{id}")
+      response.body
+    end
+
+    def create(
+      class_name:,
+      type:,
+      classify_properties: nil,
+      based_on_properties: nil,
+      settings: nil,
+      filters: nil
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {}
+        req.body["class"] = class_name
+        req.body["type"] = type
+        req.body["classifyProperties"] = classify_properties if classify_properties
+        req.body["basedOnProperties"] = based_on_properties if based_on_properties
+        req.body["settings"] = settings if settings
+        req.body["filters"] = filters if filters
+      end
+
+      if response.success?
+        response.body
+      end
+    end
+  end
+end

data/lib/weaviate/client.rb

@@ -5,7 +5,7 @@ require "graphlient"
 
 module Weaviate
   class Client
-    attr_reader :scheme, :host, :model_service, :model_service_api_key, :adapter
+    attr_reader :scheme, :host, :api_key, :model_service, :model_service_api_key, :adapter
 
     API_VERSION = "v1"
 
@@ -18,6 +18,7 @@ module Weaviate
     def initialize(
       scheme:,
       host:,
+      api_key: nil,
       model_service: nil,
       model_service_api_key: nil,
       adapter: Faraday.default_adapter
@@ -26,6 +27,7 @@ module Weaviate
 
       @scheme = scheme
       @host = host
+      @api_key = api_key
       @model_service = model_service
       @model_service_api_key = model_service_api_key
       @adapter = adapter
@@ -59,6 +61,14 @@ module Weaviate
       @health.ready?
     end
 
+    def backups
+      @backups ||= Weaviate::Backups.new(client: self)
+    end
+
+    def classifications
+      @classifications ||= Weaviate::Classifications.new(client: self)
+    end
+
     def objects
       @objects ||= Weaviate::Objects.new(client: self)
     end
@@ -85,6 +95,9 @@ module Weaviate
 
     def connection
       @connection ||= Faraday.new(url: "#{scheme}://#{host}/#{API_VERSION}/") do |faraday|
+        if api_key
+          faraday.request :authorization, :Bearer, api_key
+        end
         faraday.request :json
         faraday.response :json, content_type: /\bjson$/
         faraday.adapter adapter

data/lib/weaviate/objects.rb

@@ -108,6 +108,30 @@ module Weaviate
       response.success? && response.body.empty?
     end
 
+    def batch_delete(
+      class_name:,
+      where:,
+      consistency_level: nil,
+      output: nil,
+      dry_run: nil
+    )
+      path = "batch/#{PATH}"
+      path << "?consistency_level=#{consistency_level}" unless consistency_level.nil?
+
+      response = client.connection.delete(path) do |req|
+        req.body = {
+          match: {
+            class: class_name,
+            where: where
+          }
+        }
+        req.body["output"] = output unless output.nil?
+        req.body["dryRun"] = dry_run unless dry_run.nil?
+      end
+
+      response.body
+    end
+
     # Validate a data object
     # def validate
     # end

data/lib/weaviate/version.rb

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

data/lib/weaviate.rb

@@ -13,6 +13,8 @@ module Weaviate
   autoload :Query, "weaviate/query"
   autoload :Nodes, "weaviate/nodes"
   autoload :Health, "weaviate/health"
+  autoload :Classifications, "weaviate/classifications"
+  autoload :Backups, "weaviate/backups"
 
   module Response
     autoload :Base, "weaviate/response/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weaviate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,7 +68,9 @@ files:
 - README.md
 - Rakefile
 - lib/weaviate.rb
+- lib/weaviate/backups.rb
 - lib/weaviate/base.rb
+- lib/weaviate/classifications.rb
 - lib/weaviate/client.rb
 - lib/weaviate/error.rb
 - lib/weaviate/health.rb
@@ -84,13 +86,13 @@ files:
 - lib/weaviate/schema.rb
 - lib/weaviate/version.rb
 - sig/weaviate.rbs
-homepage: https://github.com/andreibondarev/weaviate
+homepage: https://github.com/andreibondarev/weaviate-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/andreibondarev/weaviate
-  source_code_uri: https://github.com/andreibondarev/weaviate
-  changelog_uri: https://github.com/andreibondarev/weaviate/CHANGELOG.md
+  homepage_uri: https://github.com/andreibondarev/weaviate-ruby
+  source_code_uri: https://github.com/andreibondarev/weaviate-ruby
+  changelog_uri: https://github.com/andreibondarev/weaviate-ruby/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: