Changes

Author: andreibondarev

README.md

@@ -65,8 +65,18 @@ response.data
 client.schema.delete(class_name: 'Question')
 
 # Update settings of an existing schema class.
+# Does not support modifying existing properties.
 client.schema.update(class_name: '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')
 ```
@@ -117,7 +127,7 @@ client.objects.update(
 )
 
 # Batch create objects
-response = client.objects.batch_create(objects: [
+client.objects.batch_create(objects: [
     {
         class: "Question",
         properties: {
@@ -134,7 +144,6 @@ response = client.objects.batch_create(objects: [
         }
     }
 ])
-response.data
 
 # Batch delete objects
 client.objects.batch_delete(
@@ -191,7 +200,7 @@ client.query.get class_name: 'Question', fields: 'answer question category _addi
 ```ruby
 client.query.aggs(
     class_name: "Question",
-    fields: 'meta { count }'
+    fields: 'meta { count }',
     group_by: ["category"],
     object_limit: "10",
     near_text: "{ concepts: [\"knowledge\"] }"

lib/weaviate/objects.rb

@@ -23,17 +23,29 @@ def list(
         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)
+      
+      if response.success?
+        response.body
+      else
+        response.body
+      end
     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|
+        req.params = {
+          consistency_level: consistency_level.to_s.upcase
+        } unless consistency_level.nil?
+
         req.body = {}
         req.body["class"] = class_name
         req.body["properties"] = properties
@@ -42,44 +54,64 @@ def create(
       end
 
       if response.success?
-        Weaviate::Response::Object.new(response.body)
+        response.body
       else
         response.body
       end
     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)
+        response.body
+      else
+        response.body
       end
     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)
+        response.body
+      else
+        response.body
       end
     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 +120,45 @@ def update(
       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)
+        response.body
+      else
+        response.body
       end
     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 +169,12 @@ def batch_delete(
       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 +191,31 @@ def batch_delete(
     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

lib/weaviate/query.rb

@@ -28,7 +28,7 @@ def get(
         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,7 +53,7 @@ def aggs(
         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
@@ -80,7 +80,7 @@ def explore(
         limit: limit,
         offset: offset
       )
-      response.data.explore
+      response.original_hash.dig('data', 'Explore')
     rescue Graphlient::Errors::ExecutionError => error
       raise Weaviate::Error.new(error.to_s)
     end

lib/weaviate/schema.rb

@@ -1,29 +1,33 @@
 # frozen_string_literal: true
 
+require 'pry'
+
 module Weaviate
   class Schema < Base
     PATH = "schema"
 
     # 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
     def get(class_name:)
       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 +37,7 @@ def create(
     )
       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,7 +49,7 @@ def create(
       end
 
       if response.success?
-        Response::Class.new(response.body)
+        response.body
       else
         response.body
       end
@@ -54,10 +58,18 @@ def create(
     # 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,7 +95,23 @@ def update(
       end
 
       if response.success?
-        Response::Class.new(response.body)
+        response.body
+      else
+        response.body
+      end
+    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?
+        response.body
       else
         response.body
       end

spec/fixtures/class.json

@@ -1,7 +1,7 @@
 {
   "class": "Question",
   "description": "Information from a Jeopardy! question",
- "properties": [
+  "properties": [
     {
       "dataType": ["text"],
       "description": "The question",