weaviate-ruby 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb276e9b3dd49bfbdfbbe59abfba8f63c3e4d9f93f1942aede595c991300626
-  data.tar.gz: 7ed2ed88ae192a6b7cd52bdf01fd683cae274b78f61f1a19bf2703c63adc6dad
+  metadata.gz: 52fb7ba7147345178fa220aa2bbed2ce66a7903a4df42b8cf5a016ddd329ff3f
+  data.tar.gz: c03e3a537651f2c9e5beb4febdf826f22eadbce6cc1c96ed983b8e0311140604
 SHA512:
-  metadata.gz: cac32112b0c05d70ff0862c70b63567bd1688c8518617d263a3262711f5919a73e6a94eb5e0161e18a791249b89607a69a110f78caa7532088ab5329bede4d01
-  data.tar.gz: eb14f8b055ed26adb286d54232922d0bb883c11654b15261fc694391bc8ea36d21627d09416f6d81db8030cf956fd7c440db69bd6b33037e4a499f2f39654685
+  metadata.gz: f53cf142fa41ce9236e865c251c8e183669b0c3fea0b8b3fe0720a8e9b30dedfd0e37fea888a86b75e9e3d8c5a7118592e5d4b14b1dcfc36221c85a996e332c6
+  data.tar.gz: a71fa15a01d2d75c51de572b2f87d231862ae442a5841a2022ef25c7b20400cc3469217c1ca6d5af42a4995d5b4393f4f33795e846361cdfb663cdf6431edeed

data/Gemfile.lock

@@ -1,23 +1,40 @@
 PATH
   remote: .
   specs:
-    weaviate-ruby (0.1.0)
+    weaviate-ruby (0.3.0)
       faraday (~> 2.7)
+      graphlient (~> 0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    graphlient (0.7.0)
+      faraday (~> 2.0)
+      graphql-client
+    graphql (2.0.19)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
+    minitest (5.18.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
@@ -65,6 +82,8 @@ GEM
       language_server-protocol (~> 3.17.0.2)
       rubocop (~> 1.48.1)
       rubocop-performance (~> 1.16.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS

data/README.md

@@ -48,7 +48,9 @@ client.schema.create(
             "description": "The category",
             "name": "category"
         }
-    ]
+    ],
+    # Possible values: 'text2vec-cohere', 'text2vec-openai', 'text2vec-huggingface', 'text2vec-transformers', 'text2vec-contextionary', 'img2vec-neural', 'multi2vec-clip', 'ref2vec-centroid'
+    vectorizer: "text2vec-openai"
 )
 
 # Get a single class from the schema
@@ -134,6 +136,57 @@ response = client.objects.batch_create(objects: [
 response.data
 ```
 
+### Querying
+
+#### Get
+```ruby
+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",
+    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'
+    near_text: near_text,
+
+    # To use this parameter you must have created your schema by setting the `vectorizer:` property to 'multi2vec-clip' or 'img2vec-neural'
+    # near_image: ...,
+
+    # hybrid: ...,
+
+    # bm25: ...,
+
+    # 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\"] }"
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/weaviate/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "graphlient"
 
 module Weaviate
   class Client
@@ -47,6 +48,26 @@ module Weaviate
       @objects ||= Weaviate::Objects.new(client: self)
     end
 
+    def query
+      @query ||= Weaviate::Query.new(client: self)
+    end
+
+    def graphql
+      headers = {}
+      if model_service && model_service_api_key
+        headers[API_KEY_HEADERS[model_service]] = model_service_api_key
+      end
+
+      @graphql ||= Graphlient::Client.new(
+        "#{scheme}://#{host}/#{API_VERSION}/graphql",
+        headers: headers,
+        http_options: {
+          read_timeout: 20,
+          write_timeout: 30
+        }
+      )
+    end
+
     def connection
       @connection ||= Faraday.new(url: "#{scheme}://#{host}/#{API_VERSION}/") do |faraday|
         faraday.request :json

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/objects.rb

@@ -23,7 +23,7 @@ module Weaviate
         req.params["sort"] = sort unless sort.nil?
         req.params["order"] = order unless order.nil?
       end
-      Response::Collection.from_response(response, key: "objects", type: Response::Object)
+      Response::Collection.from_response(response.body, key: "objects", type: Response::Object)
     end
 
     # Create a new data object. The provided meta-data and schema values are validated.
@@ -52,7 +52,7 @@ module Weaviate
       end
 
       if response.success?
-        Response::Collection.from_response(response, type: Response::Object)
+        Response::Collection.from_response(response.body, type: Response::Object)
       end
     end
 

data/lib/weaviate/query.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Query < Base
+    def get(
+      class_name:,
+      fields:,
+      after: nil,
+      limit: nil,
+      offset: nil,
+      sort: nil,
+      where: nil,
+      near_text: nil,
+      near_vector: nil,
+      near_object: nil
+    )
+      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:,
+      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/response/collection.rb

@@ -5,8 +5,7 @@ module Weaviate
     class Collection
       attr_reader :data, :total_results
 
-      def self.from_response(response, type:, key: nil)
-        body = response.body
+      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.

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, key: "classes", type: Response::Class)
+      Response::Collection.from_response(response.body, key: "classes", type: Response::Class)
     end
 
     # Get a single class from the schema

data/lib/weaviate/version.rb

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

data/lib/weaviate.rb

@@ -10,6 +10,7 @@ module Weaviate
   autoload :Meta, "weaviate/meta"
   autoload :Objects, "weaviate/objects"
   autoload :OIDC, "weaviate/oidc"
+  autoload :Query, "weaviate/query"
 
   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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: graphlient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +74,7 @@ files:
 - lib/weaviate/meta.rb
 - 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