Merge pull request #5 from andreibondarev/classification-endpoint

Classification endpoint

Author: andreibondarev

README.md

@@ -187,12 +187,26 @@ client.query.aggs(
 )
 ```
 
-#### Nodes
+### Classification
+```ruby
+client.classifications.create(
+    type: "zeroshot",
+    class_name: "Posts",
+    classify_properties: ["hasColor"],
+    based_on_properties: ["text"]
+)
+
+client.classifications.get(
+    id: ""
+)
+```
+
+### Nodes
 ```ruby
 client.nodes
 ```
 
-#### Health
+### Health
 ```ruby
 client.live?
 client.ready?

lib/weaviate.rb

@@ -13,6 +13,7 @@ module Weaviate
   autoload :Query, "weaviate/query"
   autoload :Nodes, "weaviate/nodes"
   autoload :Health, "weaviate/health"
+  autoload :Classifications, "weaviate/classifications"
 
   module Response
     autoload :Base, "weaviate/response/base"

lib/weaviate/classifications.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Classifications < Base
+    PATH = "classifications"
+
+    def get(id:)
+      response = client.connection.get("#{PATH}/#{id}")
+      response.body
+    end
+
+    def create(
+      class_name:,
+      type:,
+      classify_properties: nil,
+      based_on_properties: nil,
+      settings: nil,
+      filters: nil
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {}
+        req.body["class"] = class_name
+        req.body["type"] = type
+        req.body["classifyProperties"] = classify_properties if classify_properties
+        req.body["basedOnProperties"] = based_on_properties if based_on_properties
+        req.body["settings"] = settings if settings
+        req.body["filters"] = filters if filters
+      end
+
+      if response.success?
+        response.body
+      end
+    end
+  end
+end

lib/weaviate/client.rb

@@ -59,6 +59,10 @@ def ready?
       @health.ready?
     end
 
+    def classifications
+      @classifications ||= Weaviate::Classifications.new(client: self)
+    end
+
     def objects
       @objects ||= Weaviate::Objects.new(client: self)
     end

spec/fixtures/classification.json

@@ -0,0 +1,12 @@
+{
+  "basedOnProperties": ["text"],
+  "class": "Posts",
+  "classifyProperties": ["hasColor"],
+  "id": "1",
+  "meta": {
+    "completed": "0001-01-01T00:00:00.000Z",
+    "started": "2023-04-03T19:58:13.965Z"
+  },
+  "status": "running",
+  "type": "zeroshot"
+}

spec/weaviate/classifications_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Weaviate::Classifications do
+  let(:client) {
+    Weaviate::Client.new(
+      scheme: "http",
+      host: "localhost:8080"
+    )
+  }
+
+  let(:classifications) { client.classifications }
+  let(:classification_fixture) { JSON.parse(File.read("spec/fixtures/classification.json")) }
+
+  describe "#create" do
+    let(:response) { OpenStruct.new(success?: true, body: classification_fixture) }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:post)
+        .with("classifications")
+        .and_return(response)
+    end
+
+    it "creates the classification" do
+      response = classifications.create(
+        class_name: "Posts",
+        type: "zeroshot",
+        classify_properties: ["hasColor"],
+        based_on_properties: ["text"]
+      )
+      expect(response["type"]).to eq("zeroshot")
+      expect(response["status"]).to eq("running")
+    end
+  end
+
+  describe "#get" do
+    let(:response) { OpenStruct.new(success?: true, body: classification_fixture) }
+
+    before do
+      allow_any_instance_of(Faraday::Connection).to receive(:get)
+        .with("classifications/1")
+        .and_return(response)
+    end
+
+    it "returns the classification" do
+      response = classifications.get(id: "1")
+      expect(response["id"]).to eq("1")
+    end
+  end
+end