Initializing the weaviate client requires the single url: key instead of separate host: and schema:

Author: andreibondarev

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.8.0] - 2023-04-18
+
+### Breaking
+- Initializing the weaviate client requires the single `url:` key instead of separate `host:` and `schema:`
+
 ## [0.1.0] - 2023-03-24
 
 - Initial release

Gemfile.lock

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

README.md

@@ -28,8 +28,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 require 'weaviate'
 
 client = Weaviate::Client.new(
-    scheme: 'https',
-    host: 'some-endpoint.weaviate.network',  # Replace with your endpoint
+    url: 'https://some-endpoint.weaviate.network',  # Replace with your endpoint
     api_key: '', # Weaviate API key
     model_service: :openai, # Service that will be used to generate vectors. Possible values: :openai, :cohere, :huggingface
     model_service_api_key: 'xxxxxxx' # Either OpenAI, Cohere or Hugging Face API key

bin/console

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

lib/weaviate/client.rb

@@ -5,7 +5,7 @@
 
 module Weaviate
   class Client
-    attr_reader :scheme, :host, :api_key, :model_service, :model_service_api_key, :adapter
+    attr_reader :url, :api_key, :model_service, :model_service_api_key, :adapter
 
     API_VERSION = "v1"
 
@@ -16,17 +16,15 @@ class Client
     }
 
     def initialize(
-      scheme:,
-      host:,
+      url:,
       api_key: nil,
       model_service: nil,
       model_service_api_key: nil,
       adapter: Faraday.default_adapter
     )
       validate_model_service!(model_service) unless model_service.nil?
 
-      @scheme = scheme
-      @host = host
+      @url = url
       @api_key = api_key
       @model_service = model_service
       @model_service_api_key = model_service_api_key
@@ -89,7 +87,7 @@ def graphql
       end
 
       @graphql ||= Graphlient::Client.new(
-        "#{scheme}://#{host}/#{API_VERSION}/graphql",
+        "#{url}/#{API_VERSION}/graphql",
         headers: headers,
         http_options: {
           read_timeout: 20,
@@ -99,7 +97,7 @@ def graphql
     end
 
     def connection
-      @connection ||= Faraday.new(url: "#{scheme}://#{host}/#{API_VERSION}/") do |faraday|
+      @connection ||= Faraday.new(url: "#{url}/#{API_VERSION}/") do |faraday|
         if api_key
           faraday.request :authorization, :Bearer, api_key
         end

lib/weaviate/version.rb

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

spec/weaviate/backups_spec.rb

@@ -5,8 +5,7 @@
 RSpec.describe Weaviate::Backups do
   let(:client) {
     Weaviate::Client.new(
-      scheme: "http",
-      host: "localhost:8080"
+      url: "http://localhost:8080"
     )
   }
 

spec/weaviate/classifications_spec.rb

@@ -5,8 +5,7 @@
 RSpec.describe Weaviate::Classifications do
   let(:client) {
     Weaviate::Client.new(
-      scheme: "http",
-      host: "localhost:8080"
+      url: "http://localhost:8080"
     )
   }
 

spec/weaviate/client_spec.rb

@@ -5,8 +5,7 @@
 RSpec.describe Weaviate::Client do
   let(:client) {
     Weaviate::Client.new(
-      scheme: "http",
-      host: "localhost:8080",
+      url: "http://localhost:8080",
       model_service: :openai,
       model_service_api_key: "123"
     )

spec/weaviate/health_spec.rb

@@ -5,8 +5,7 @@
 RSpec.describe Weaviate::Health do
   let(:client) {
     Weaviate::Client.new(
-      scheme: "http",
-      host: "localhost:8080"
+      url: "http://localhost:8080"
     )
   }