weaviate-ruby 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7188f7ab1cb378b6ffecf86e173bcfd2d6f513cd004559d18cfa011d8c2f9407
-  data.tar.gz: fd07382e798c763a27adbce3543d224bfed059a2035625569a5247e83d11f598
+  metadata.gz: eec9c4e909fa4b73ed59023c291cbc0171c72fcc2aeeef2773b6744b2de6144c
+  data.tar.gz: b66b81b77feb0b5777a15ef833eea0ebdd7f1660208c5f53893887c95aa56201
 SHA512:
-  metadata.gz: 5cb63f9f341edb1acdc580f3fab0e27190221400183c9191590d4ed7e2d08f3d48ce01167381885e3cbdda894cd0cb32c1c418a2827e2625a2a16d26306395ee
-  data.tar.gz: 17aa43b9a7f42b063a3e5f148a697481ea3b73bfc6dc62c7b6ab101cc24d30d8d78e4e501b3e414e6bf6ef6f73d94914df211f0025aac0f1c8d5b0fe599a1a6e
+  metadata.gz: 2b32d7546e9dc5484b63abe834667e03733e694b1fd6d7c10306cc09cb96ecbb8e63f84aaa682452ae881de79cf3f6f2c49dccf744761e6c95a7539e3feef068
+  data.tar.gz: 1a3774e88f29d0de254bd06b912bbcf4b4fa33cfa2b0ac87a60c38e340503c9119fdc6556bc5d7ff77c06097519e9f9122d2ef6cc8ca1541c245091c4bef0115

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,15 @@
 # Weaviate
 
+<p>
+    <img alt='Weaviate logo' src='https://weaviate.io/img/site/weaviate-logo-light.png' height='50' />
+    +&nbsp;&nbsp;
+    <img alt='Weaviate logo' src='https://user-images.githubusercontent.com/541665/230231593-43861278-4550-421d-a543-fd3553aac4f6.png' height='40' />
+</p>
+
 Ruby wrapper for the Weaviate.io API
 
+![Tests status](https://github.com/andreibondarev/weaviate-ruby/actions/workflows/ci.yml/badge.svg)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -14,7 +22,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-### Instantiating the API client
+### Instantiating API client
 
 ```ruby
 require 'weaviate'
@@ -22,6 +30,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
 )
@@ -39,7 +48,7 @@ client.schema.create(
             "dataType": ["text"],
             "description": "The question",
             "name": "question"
-        } ,{ 
+        }, { 
             "dataType": ["text"],
             "description": "The answer",
             "name": "answer"
@@ -56,15 +65,27 @@ client.schema.create(
 # Get a single class from the schema
 client.schema.get(class_name: 'Question')
 
-# Dumps the current Weaviate schema. 
-response = client.schema.list()
-response.data
+# 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.
-client.schema.update(class_name: 'Question')
+# Does not support modifying existing properties.
+client.schema.update(
+    class_name: 'Question',
+    description: 'Information from a Wheel of Fortune question'
+)
+
+# Adding a new property
+client.schema.add_property(
+    class_name: 'Question',
+    property: {
+        "dataType": ["boolean"],
+        "name": "homepage"
+    }
+)
 
 # Inspect the shards of a class
 client.schema.shards(class_name: 'Question')
@@ -83,31 +104,30 @@ client.objects.create(
 )
 
 # Lists all data objects in reverse order of creation.
-response = client.objects.list()
-response.data
+client.objects.list()
 
 # Get a single data object.
 client.objects.get(
     class_name: "Question",
-    id: ''
+    id: "uuid"
 )
 
-# Check if a data object exists
+# Check if a data object exists.
 client.objects.exists?(
     class_name: "Question",
-    id: ''
+    id: "uuid"
 )
 
-# Delete an individual data object from Weaviate.
+# Delete a single data object from Weaviate.
 client.objects.delete(
     class_name: "Question",
-    id: ""
+    id: "uuid"
 )
 
-# Update an individual data object based on its uuid.
+# Update a single data object based on its uuid.
 client.objects.update(
     class_name: "Question",
-    id: '',
+    id: "uuid",
     properties: {
         question: "What does 6 times 7 equal to?",
         category: "math",
@@ -116,7 +136,7 @@ client.objects.update(
 )
 
 # Batch create objects
-response = client.objects.batch_create(objects: [
+client.objects.batch_create(objects: [
     {
         class: "Question",
         properties: {
@@ -133,13 +153,12 @@ response = client.objects.batch_create(objects: [
         }
     }
 ])
-response.data
 
 # Batch delete objects
 client.objects.batch_delete(
     class_name: "Question",
     where: {
-        valueString: "1",
+        valueString: "uuid",
         operator: "Equal",
         path: ["id"]
     }
@@ -148,7 +167,7 @@ client.objects.batch_delete(
 
 ### Querying
 
-#### Get
+#### Get{}
 ```ruby
 near_text = '{ concepts: ["biology"] }'
 sort_obj = '{ path: ["category"], order: desc }'
@@ -186,19 +205,29 @@ client.query.get class_name: 'Question', fields: 'answer question category _addi
 
 ```
 
-#### Aggs
+#### Aggs{}
 ```ruby
 client.query.aggs(
     class_name: "Question",
-    fields: 'meta { count }'
+    fields: 'meta { count }',
     group_by: ["category"],
     object_limit: "10",
     near_text: "{ concepts: [\"knowledge\"] }"
 )
 ```
 
+#### Explore{}
+```ruby
+client.query.explore(
+    fields: 'className',
+    near_text: "{ concepts: [\"science\"] }",
+    limit: "1"
+)
+```
+
 ### Classification
 ```ruby
+# Start a classification
 client.classifications.create(
     type: "zeroshot",
     class_name: "Posts",
@@ -206,6 +235,7 @@ client.classifications.create(
     based_on_properties: ["text"]
 )
 
+# Get the status, results and metadata of a previously created classification
 client.classifications.get(
     id: ""
 )
@@ -213,22 +243,26 @@ client.classifications.get(
 
 ### Backups
 ```ruby
+# Create backup
 client.backups.create(
     backend: "filesystem",
     id: "my-first-backup",
     include: ["Question"]
 )
 
+# Get the backup
 client.backups.get(
     backend: "filesystem",
     id: "my-first-backup"
 )
 
+# Restore backup
 client.backups.restore(
     backend: "filesystem",
     id: "my-first-backup"
 )
 
+# Check the backup restore status
 client.backups.restore_status(
     backend: "filesystem",
     id: "my-first-backup"
@@ -242,7 +276,12 @@ client.nodes
 
 ### Health
 ```ruby
+# Live determines whether the application is alive. It can be used for Kubernetes liveness probe.
 client.live?
+```
+
+```ruby
+# Live determines whether the application is ready to receive traffic. It can be used for Kubernetes readiness probe.
 client.ready?
 ```
 

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
@@ -93,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

@@ -23,17 +23,27 @@ module Weaviate
         req.params["sort"] = sort unless sort.nil?
         req.params["order"] = order unless order.nil?
       end
-      Response::Collection.from_response(response.body, key: "objects", type: Response::Object)
+
+      response.body
     end
 
     # Create a new data object. The provided meta-data and schema values are validated.
     def create(
       class_name:,
       properties:,
+      consistency_level: nil,
       id: nil,
       vector: nil
     )
+      validate_consistency_level!(consistency_level) unless consistency_level.nil?
+
       response = client.connection.post(PATH) do |req|
+        unless consistency_level.nil?
+          req.params = {
+            consistency_level: consistency_level.to_s.upcase
+          }
+        end
+
         req.body = {}
         req.body["class"] = class_name
         req.body["properties"] = properties
@@ -41,45 +51,53 @@ module Weaviate
         req.body["vector"] = vector unless vector.nil?
       end
 
-      if response.success?
-        Weaviate::Response::Object.new(response.body)
-      else
-        response.body
-      end
+      response.body
     end
 
     # Batch create objects
-    def batch_create(objects:)
+    def batch_create(
+      objects:,
+      consistency_level: 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}
       end
 
-      if response.success?
-        Response::Collection.from_response(response.body, type: Response::Object)
-      end
+      response.body
     end
 
     # Get a single data object.
     def get(
       class_name:,
       id:,
-      include: nil
+      include: nil,
+      consistency_level: nil
     )
-      # TODO: validate `include` param values
-      # include	| query | param |	string |	Include additional information, such as classification info. Allowed values include: classification, vector.
+      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["include"] = include unless include.nil?
       end
 
-      if response.success?
-        Weaviate::Response::Object.new(response.body)
-      end
+      response.body
     end
 
     # Check if a data object exists
-    def exists?(class_name:, id:)
-      response = client.connection.head("#{PATH}/#{class_name}/#{id}")
+    def exists?(
+      class_name:,
+      id:,
+      consistency_level: 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?
+      end
+
       response.status == 204
     end
 
@@ -88,24 +106,41 @@ module Weaviate
       class_name:,
       id:,
       properties:,
-      vector: nil
+      vector: 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?
+
         req.body = {}
         req.body["id"] = id
         req.body["class"] = class_name
         req.body["properties"] = properties
         req.body["vector"] = vector unless vector.nil?
       end
-      if response.success?
-        Weaviate::Response::Object.new(response.body)
-      end
+
+      response.body
     end
 
     # Delete an individual data object from Weaviate.
-    def delete(class_name:, id:)
-      response = client.connection.delete("#{PATH}/#{class_name}/#{id}")
-      response.success? && response.body.empty?
+    def delete(
+      class_name:,
+      id:,
+      consistency_level: 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?
+      end
+
+      if response.success?
+        response.body.empty?
+      else
+        response.body
+      end
     end
 
     def batch_delete(
@@ -116,7 +151,12 @@ module Weaviate
       dry_run: nil
     )
       path = "batch/#{PATH}"
-      path << "?consistency_level=#{consistency_level}" unless consistency_level.nil?
+
+      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|
         req.body = {
@@ -133,7 +173,31 @@ module Weaviate
     end
 
     # Validate a data object
-    # def validate
-    # end
+    def validate(
+      class_name:,
+      properties:,
+      id: nil
+    )
+      response = client.connection.post("#{PATH}/validate") do |req|
+        req.body = {}
+        req.body["class"] = class_name
+        req.body["properties"] = properties
+        req.body["id"] = id unless id.nil?
+      end
+
+      if response.success?
+        response.body.empty?
+      else
+        response.body
+      end
+    end
+
+    private
+
+    def validate_consistency_level!(consistency_level)
+      unless %w[ONE QUORUM ALL].include?(consistency_level.to_s.upcase)
+        raise ArgumentError, 'consistency_level must be either "ONE" or "QUORUM" OR "ALL"'
+      end
+    end
   end
 end

data/lib/weaviate/query.rb

@@ -28,7 +28,7 @@ module Weaviate
         limit: limit,
         offset: offset
       )
-      response.data.get.send(class_name.downcase)
+      response.original_hash.dig("data", "Get", class_name)
     rescue Graphlient::Errors::ExecutionError => error
       raise Weaviate::Error.new(error.response.data.get.errors.messages.to_h)
     end
@@ -53,13 +53,68 @@ module Weaviate
         group_by: group_by,
         object_limit: object_limit
       )
-      response.data.aggregate.send(class_name.downcase)
+      response.original_hash.dig("data", "Aggregate", class_name)
     rescue Graphlient::Errors::ExecutionError => error
       raise Weaviate::Error.new(error.response.data.aggregate.errors.messages.to_h)
     end
 
+    def explore(
+      fields:,
+      after: nil,
+      limit: nil,
+      offset: nil,
+      sort: nil,
+      where: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil
+    )
+      response = client.graphql.execute(
+        explore_query(
+          fields: fields,
+          near_text: near_text,
+          near_vector: near_vector,
+          near_object: near_object
+        ),
+        after: after,
+        limit: limit,
+        offset: offset
+      )
+      response.original_hash.dig("data", "Explore")
+    rescue Graphlient::Errors::ExecutionError => error
+      raise Weaviate::Error.new(error.to_s)
+    end
+
     private
 
+    def explore_query(
+      fields:,
+      where: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil,
+      sort: nil
+    )
+      client.graphql.parse <<~GRAPHQL
+        query(
+          $limit: Int,
+          $offset: Int
+        ) {
+          Explore (
+            limit: $limit,
+            offset: $offset,
+            #{near_text.present? ? "nearText: #{near_text}" : ""},
+            #{near_vector.present? ? "nearVector: #{near_vector}" : ""},
+            #{near_object.present? ? "nearObject: #{near_object}" : ""}
+            #{where.present? ? "where: #{where}" : ""},
+            #{sort.present? ? "sort: #{sort}" : ""}
+          ) {
+            #{fields}
+          }
+        }
+      GRAPHQL
+    end
+
     def get_query(
       class_name:,
       fields:,

data/lib/weaviate/schema.rb

@@ -7,7 +7,7 @@ module Weaviate
     # Dumps the current Weaviate schema. The result contains an array of objects.
     def list
       response = client.connection.get(PATH)
-      Response::Collection.from_response(response.body, key: "classes", type: Response::Class)
+      response.body
     end
 
     # Get a single class from the schema
@@ -15,15 +15,17 @@ module Weaviate
       response = client.connection.get("#{PATH}/#{class_name}")
 
       if response.success?
-        Response::Class.new(response.body)
+        response.body
+      elsif response.status == 404
+        response.reason_phrase
       end
     end
 
     # Create a new data object class in the schema.
     def create(
       class_name:,
-      description:,
-      properties:,
+      description: nil,
+      properties: nil,
       vector_index_type: nil,
       vector_index_config: nil,
       vectorizer: nil,
@@ -33,7 +35,7 @@ module Weaviate
     )
       response = client.connection.post(PATH) do |req|
         req.body = {}
-        req.body["class"] = class_name unless class_name.nil?
+        req.body["class"] = class_name
         req.body["description"] = description unless description.nil?
         req.body["vectorIndexType"] = vector_index_type unless vector_index_type.nil?
         req.body["vectorIndexConfig"] = vector_index_config unless vector_index_config.nil?
@@ -45,19 +47,25 @@ module Weaviate
       end
 
       if response.success?
-        Response::Class.new(response.body)
-      else
-        response.body
       end
+      response.body
     end
 
     # Remove a class (and all data in the instances) from the schema.
     def delete(class_name:)
       response = client.connection.delete("#{PATH}/#{class_name}")
-      response.success? && response.body.empty?
+
+      if response.success?
+        response.body.empty?
+      else
+        response.body
+      end
     end
 
     # Update settings of an existing schema class.
+    # TODO: Fix it.
+    # This endpoint keeps returning the following error:
+    # => {"error"=>[{"message"=>"properties cannot be updated through updating the class. Use the add property feature (e.g. \"POST /v1/schema/{className}/properties\") to add additional properties"}]}
     def update(
       class_name:,
       description: nil,
@@ -83,10 +91,22 @@ module Weaviate
       end
 
       if response.success?
-        Response::Class.new(response.body)
-      else
-        response.body
       end
+      response.body
+    end
+
+    # Add a property to an existing schema class.
+    def add_property(
+      class_name:,
+      property:
+    )
+      response = client.connection.post("#{PATH}/#{class_name}/properties") do |req|
+        req.body = property
+      end
+
+      if response.success?
+      end
+      response.body
     end
 
     # Inspect the shards of a class

data/lib/weaviate/version.rb

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

data/lib/weaviate.rb

@@ -15,11 +15,4 @@ module Weaviate
   autoload :Health, "weaviate/health"
   autoload :Classifications, "weaviate/classifications"
   autoload :Backups, "weaviate/backups"
-
-  module Response
-    autoload :Base, "weaviate/response/base"
-    autoload :Object, "weaviate/response/object"
-    autoload :Class, "weaviate/response/class"
-    autoload :Collection, "weaviate/response/collection"
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weaviate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -79,10 +79,6 @@ files:
 - lib/weaviate/objects.rb
 - lib/weaviate/oidc.rb
 - lib/weaviate/query.rb
-- lib/weaviate/response/base.rb
-- lib/weaviate/response/class.rb
-- lib/weaviate/response/collection.rb
-- lib/weaviate/response/object.rb
 - lib/weaviate/schema.rb
 - lib/weaviate/version.rb
 - sig/weaviate.rbs

data/lib/weaviate/response/base.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-
-module Weaviate
-  module Response
-    class Base < OpenStruct
-      def initialize(attributes)
-        super to_ostruct(attributes)
-      end
-
-      def to_ostruct(obj)
-        if obj.is_a?(Hash)
-          OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
-        elsif obj.is_a?(Array)
-          obj.map { |o| to_ostruct(o) }
-        else # Assumed to be a primitive value
-          obj
-        end
-      end
-    end
-  end
-end

data/lib/weaviate/response/class.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Weaviate
-  module Response
-    class Class < Base
-    end
-  end
-end

data/lib/weaviate/response/collection.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Weaviate
-  module Response
-    class Collection
-      attr_reader :data, :total_results
-
-      def self.from_response(body, type:, key: nil)
-        new(
-          data: (key.nil? ? body : body[key]).map { |attrs| type.new(attrs) }
-          # TODO: Integrate and use the totalResults from the response.
-          # total_results: body["totalResults"]
-        )
-      end
-
-      def initialize(data:, total_results: nil)
-        @data = data
-        @total_results = total_results
-      end
-    end
-  end
-end

data/lib/weaviate/response/object.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Weaviate
-  module Response
-    class Object < Base
-    end
-  end
-end