Merge pull request #2 from andreibondarev/query-graphql-integration

Adding support for the Weaviate GraphQL Get{} query endpoint

Author: andreibondarev

Gemfile.lock

@@ -3,21 +3,38 @@ PATH
   specs:
     weaviate-ruby (0.1.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

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,30 @@ response = client.objects.batch_create(objects: [
 response.data
 ```
 
+### Querying
+```ruby
+near_text = { "concepts": ["biology"] }
+
+client.query.get(
+    class_name: 'Question',
+    fields: ['question', 'answer', 'category'],
+    limit: 1,
+
+    # 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: ...,
+)
+```
+
 ## 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.

bin/console

@@ -12,7 +12,7 @@ require "weaviate"
 # Pry.start
 
 client = Weaviate::Client.new(
-  scheme: "http",
+  scheme: "https",
   host: ENV["WEAVIATE_HOST"],
   model_service: :openai,
   model_service_api_key: ENV["MODEL_SERVICE_API_KEY"]

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"

lib/weaviate/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "graphlient"
 
 module Weaviate
   class Client
@@ -47,6 +48,26 @@ def objects
       @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

lib/weaviate/objects.rb

@@ -23,7 +23,7 @@ def list(
         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 @@ def batch_create(objects:)
       end
 
       if response.success?
-        Response::Collection.from_response(response, type: Response::Object)
+        Response::Collection.from_response(response.body, type: Response::Object)
       end
     end
 

lib/weaviate/query.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Query < Base
+    def get(
+      class_name:,
+      fields:,
+      limit: nil,
+      near_text: 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.data.get.send(class_name.downcase)
+    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
+    end
+  end
+end

lib/weaviate/response/collection.rb

@@ -5,8 +5,7 @@ module Response
     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.

lib/weaviate/schema.rb

@@ -7,7 +7,7 @@ class Schema < Base
     # 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

spec/weaviate/client_spec.rb

@@ -47,6 +47,12 @@
     end
   end
 
+  describe "#query" do
+    it "returns a query client" do
+      expect(client.query).to be_a(Weaviate::Query)
+    end
+  end
+
   describe "#oidc" do
     let(:fixture) { JSON.parse(File.read("spec/fixtures/oidc.json")) }
     let(:response) { OpenStruct.new(body: fixture) }