weaviate-ruby 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b105dbf4536df10fd278d0aac2c437483440c87caf37ec9f6c06e34eeb690b
-  data.tar.gz: 24b3933c80ebd659f292c0785cdd311733337d1adf21e9ea9d04da602f274d43
+  metadata.gz: e9f87a5670b340fe00f3634f0cf7d22b3c699b0737d3cb326d4ec7d55085cea2
+  data.tar.gz: 0b7fbe6084e04d5d1a006871deab4972aa965a65bd5bf8080a58f045787841fd
 SHA512:
-  metadata.gz: d1961b6e0123e21b60414b53055807ce83305a241c01b74747240cb0022e42483e2a2c2bb9305d2e35630ea2ab28517c311fa094de927c19246f199f91598ce4
-  data.tar.gz: 68ceaf84cded37b443cd7cf8879d5b947352b7be718f2b5a041571eacc584cfddfffd04f94f3b3daa6d1b712f842ac27a4ae105edb2711ebaef28a7cfe73541a
+  metadata.gz: dee8739ad9cd3bb53ae226bd4be6b041fc9af449d47ff6347088514b2db2bfc2adef35e9fc2ff2c6c431ee5f2d311e49c5f78569ff473e36b8da366a01dd9d48
+  data.tar.gz: 5dd898fd6c88899b119721369d0f606114cf1be480be31218adbe506954cba1b110f9eead1f135b5619e067d7328aeefd405762159912f93996f9f098b2ff62e

data/Gemfile.lock

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

data/README.md

@@ -137,13 +137,21 @@ response.data
 ```
 
 ### Querying
+
+#### Get
 ```ruby
-near_text = { "concepts": ["biology"] }
+near_text = '{ concepts: ["biology"] }'
+sort_obj = '{ path: ["category"], order: desc }'
+where_obj = '{ path: ["id"], operator: Equal, valueString: "..." }'
 
 client.query.get(
     class_name: 'Question',
-    fields: ['question', 'answer', 'category'],
-    limit: 1,
+    fields: 'question answer category',
+    limit: "1",
+    offset: "1",
+    after: "id",
+    sort: sort_obj,
+    where_obj: where_obj,
 
     # To use this parameter you must have created your schema by setting the `vectorizer:` property to
     # either 'text2vec-transformers', 'text2vec-contextionary', 'text2vec-openai', 'multi2vec-clip', 'text2vec-huggingface' or 'text2vec-cohere'
@@ -158,6 +166,36 @@ client.query.get(
 
     # near_object: ...,
 )
+
+# Example queries:
+client.query.get class_name: 'Question', where: '{ operator: Like, valueText: "SCIENCE", path: ["category"] }', fields: 'answer question category', limit: "2"
+
+client.query.get class_name: 'Question', fields: 'answer question category _additional { id }', after: "3c5f7039-37f3-4244-b3e2-8f4a083e448d", limit: "1"
+
+
+
+```
+
+#### Aggs
+```ruby
+client.query.aggs(
+    class_name: "Question",
+    fields: 'meta { count }'
+    group_by: ["category"],
+    object_limit: "10",
+    near_text: "{ concepts: [\"knowledge\"] }"
+)
+```
+
+#### Nodes
+```ruby
+client.nodes
+```
+
+#### Health
+```ruby
+client.live?
+client.ready?
 ```
 
 ## Development

data/lib/weaviate/client.rb

@@ -44,6 +44,21 @@ module Weaviate
       @meta.get
     end
 
+    def nodes
+      @nodes ||= Weaviate::Nodes.new(client: self)
+      @nodes.list
+    end
+
+    def live?
+      @health ||= Weaviate::Health.new(client: self)
+      @health.live?
+    end
+
+    def ready?
+      @health ||= Weaviate::Health.new(client: self)
+      @health.ready?
+    end
+
     def objects
       @objects ||= Weaviate::Objects.new(client: self)
     end

data/lib/weaviate/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Weaviate
-  class Error
+  class Error < StandardError
   end
 end

data/lib/weaviate/health.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Health < Base
+    PATH = ".well-known"
+
+    def live?
+      response = client.connection.get("#{PATH}/live")
+      response.status == 200
+    end
+
+    def ready?
+      response = client.connection.get("#{PATH}/ready")
+      response.status == 200
+    end
+  end
+end

data/lib/weaviate/nodes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Nodes < Base
+    PATH = "nodes"
+
+    def list
+      response = client.connection.get(PATH)
+      response.body
+    end
+  end
+end

data/lib/weaviate/objects.rb

@@ -40,8 +40,11 @@ module Weaviate
         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
     end
 

data/lib/weaviate/query.rb

@@ -5,32 +5,119 @@ module Weaviate
     def get(
       class_name:,
       fields:,
+      after: nil,
       limit: nil,
-      near_text: nil
+      offset: nil,
+      sort: nil,
+      where: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil
     )
-      params = {}
-      params["nearText"] = near_text unless near_text.nil?
-      params["limit"] = limit unless limit.nil?
-      # TODO implement the rest of the API params
-
-      response = client.graphql.execute(get_query(class_name, params, fields), near_text: near_text)
+      response = client.graphql.execute(
+        get_query(
+          class_name: class_name,
+          fields: fields,
+          sort: sort,
+          where: where,
+          near_text: near_text,
+          near_vector: near_vector,
+          near_object: near_object
+        ),
+        after: after,
+        limit: limit,
+        offset: offset
+      )
       response.data.get.send(class_name.downcase)
+    rescue Graphlient::Errors::ExecutionError => error
+      raise Weaviate::Error.new(error.response.data.get.errors.messages.to_h)
+    end
+
+    def aggs(
+      class_name:,
+      fields: nil,
+      object_limit: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil,
+      group_by: nil
+    )
+      response = client.graphql.execute(
+        aggs_query(
+          class_name: class_name,
+          fields: fields,
+          near_text: near_text,
+          near_vector: near_vector,
+          near_object: near_object
+        ),
+        group_by: group_by,
+        object_limit: object_limit
+      )
+      response.data.aggregate.send(class_name.downcase)
+    rescue Graphlient::Errors::ExecutionError => error
+      raise Weaviate::Error.new(error.response.data.aggregate.errors.messages.to_h)
     end
 
     private
 
-    def get_query(class_name, params, fields)
-      client.graphql.parse do
-        query do
-          Get do
-            public_send(class_name, params) do
-              fields.map do |field|
-                public_send(field)
-              end
-            end
-          end
-        end
-      end
+    def get_query(
+      class_name:,
+      fields:,
+      where: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil,
+      sort: nil
+    )
+      client.graphql.parse <<~GRAPHQL
+        query(
+          $after: String,
+          $limit: Int,
+          $offset: Int,
+        ) {
+          Get {
+            #{class_name}(
+              after: $after,
+              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 aggs_query(
+      class_name:,
+      fields:,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil
+    )
+      client.graphql.parse <<~GRAPHQL
+        query(
+          $group_by: [String],
+          $object_limit: Int,
+        ) {
+          Aggregate {
+            #{class_name}(
+              objectLimit: $object_limit,
+              groupBy: $group_by,
+              #{near_text.present? ? "nearText: #{near_text}" : ""},
+              #{near_vector.present? ? "nearVector: #{near_vector}" : ""},
+              #{near_object.present? ? "nearObject: #{near_object}" : ""}
+            ) {
+              #{fields}
+            }
+          }
+        }
+      GRAPHQL
     end
   end
 end

data/lib/weaviate/version.rb

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

data/lib/weaviate.rb

@@ -11,6 +11,8 @@ module Weaviate
   autoload :Objects, "weaviate/objects"
   autoload :OIDC, "weaviate/oidc"
   autoload :Query, "weaviate/query"
+  autoload :Nodes, "weaviate/nodes"
+  autoload :Health, "weaviate/health"
 
   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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -71,7 +71,9 @@ files:
 - lib/weaviate/base.rb
 - lib/weaviate/client.rb
 - lib/weaviate/error.rb
+- lib/weaviate/health.rb
 - lib/weaviate/meta.rb
+- lib/weaviate/nodes.rb
 - lib/weaviate/objects.rb
 - lib/weaviate/oidc.rb
 - lib/weaviate/query.rb