Merge pull request #10 from andreibondarev/explore-endpoint

Explore endpoint

Author: andreibondarev

README.md

@@ -67,8 +67,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')
 ```
@@ -119,7 +129,7 @@ client.objects.update(
 )
 
 # Batch create objects
-response = client.objects.batch_create(objects: [
+client.objects.batch_create(objects: [
     {
         class: "Question",
         properties: {
@@ -136,7 +146,6 @@ response = client.objects.batch_create(objects: [
         }
     }
 ])
-response.data
 
 # Batch delete objects
 client.objects.batch_delete(
@@ -193,7 +202,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.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

lib/weaviate/objects.rb

@@ -23,63 +23,81 @@ 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)
+
+      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
         req.body["id"] = id unless id.nil?
         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 @@ 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)
-      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 @@ 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 +173,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