anndb_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40231828a91cb8e7abaf19f7f59106653fd1a2f1879ef296af3b16ff254d0aa9
+  data.tar.gz: f5a4247b51dcbb1c0a0cd847057d3128e80b8230c18262085b1e158a6eb2a8d6
+SHA512:
+  metadata.gz: ae3175f1cb7b5f85d6aba9839f1df6850017ea77aba31ff692ee72cd4244f705bc07ac0e335d6b4c6f3a56ae91eae43059ac56d7b3a831714f1e67ff1530cb10
+  data.tar.gz: 2ce06b8904d9a2e87bfff59e009883c740a0e9ffa4f7a66cadd7a586a71e8147ea2d740f4d55595a7580cb9d289d60a030c4a6f6e83fe7a8710bc7a473353ab7

data/lib/anndb_api.rb

@@ -0,0 +1 @@
+require 'anndb_api/client'

data/lib/anndb_api/client.rb

@@ -0,0 +1,29 @@
+require 'anndb_api/image_dataset'
+
+module AnndbApi
+    SERVER_ADDR = 'grpc-api.anndb.com:1433'
+
+    class Client
+        def initialize(api_key)
+            @api_key = api_key
+        end
+
+        def images(dataset_name)
+            AnndbApi::ImageDataset.new(AnndbApi::SERVER_ADDR, rpc_metadata_for_dataset(dataset_name))
+        end
+
+        def text(dataset_name)
+            AnndbApi::TextDataset.new(AnndbApi::SERVER_ADDR, rpc_metadata_for_dataset(dataset_name))
+        end
+
+        def vector(dataset_name)
+            AnndbApi::VectorDataset.new(AnndbApi::SERVER_ADDR, rpc_metadata_for_dataset(dataset_name))
+        end
+
+        private
+
+        def rpc_metadata_for_dataset(dataset_name)
+            { 'authorization': @api_key, 'dataset': dataset_name }
+        end
+    end
+end

data/lib/anndb_api/dataset.rb

@@ -0,0 +1,54 @@
+require 'anndb_api/util'
+
+module AnndbApi
+    class DatasetOpError < RuntimeError
+    end
+
+    class Dataset
+
+        def delete(id)
+            format_dataset_op_result_single @stub.delete(AnndbApiPb::DeleteRequest.new(ids: [
+                AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(id))
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def delete_batch(ids)
+            format_dataset_op_result @stub.delete(AnndbApiPb::DeleteRequest.new(ids: ids.map { |id|
+                AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(id))
+                }), { metadata: @rpc_metadata })
+        end
+
+        protected
+
+        def format_search_result(result)
+            result.items.map { |item|
+                {
+                    id: AnndbApi::Util.ascii8bit_to_uuid(item.id),
+                    metadata: item.metadata
+                }
+            }
+        end
+
+        def format_dataset_op_result(result)
+            (0..result.ids.length-1).map { |i|
+                {
+                    id: AnndbApi::Util.ascii8bit_to_uuid(result.ids[i].data),
+                    error: result.errors[i].message
+                }
+            }
+        end
+
+        def format_dataset_op_result_single(result)
+            error = result.errors.first.message
+            if error.length > 0
+                raise AnndbApi::DatasetOpError.new(error)
+            end
+
+            AnndbApi::Util.ascii8bit_to_uuid(result.ids.first.data)
+        end
+
+        def format_req_metadata(metadata)
+            metadata.collect{ |k, v| [k.to_s, v] }.to_h
+        end
+    end
+end

data/lib/anndb_api/image_dataset.rb

@@ -0,0 +1,79 @@
+require 'grpc'
+
+require 'anndb_api/dataset'
+require 'core_pb'
+require 'image_dataset_pb'
+require 'image_dataset_services_pb'
+
+module AnndbApi
+    class ImageDataset < AnndbApi::Dataset
+        def initialize(server_addr, rpc_metadata)
+            @rpc_metadata = rpc_metadata
+            @stub = AnndbApiPb::ImageDataset::Stub.new(server_addr, GRPC::Core::ChannelCredentials.new())
+        end
+
+        def insert(image, metadata = {})
+            format_dataset_op_result_single @stub.insert(AnndbApiPb::ImageDatasetRequest.new(items: [
+                AnndbApiPb::ImageItem.new(
+                    image: image_proto(image),
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def insert_batch(items)
+            format_dataset_op_result @stub.insert(AnndbApiPb::ImageDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::ImageItem.new(
+                    image: image_proto(item[:image]),
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+                }), { metadata: @rpc_metadata })
+        end
+
+        def update(id, image, metadata = {})
+            format_dataset_op_result_single @stub.update(AnndbApiPb::ImageDatasetRequest.new(items: [
+                AnndbApiPb::ImageItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(id)),
+                    image: image_proto(image),
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def update_batch(items)
+            format_dataset_op_result @stub.update(AnndbApiPb::ImageDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::ImageItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(item[:id])),
+                    image: image_proto(item[:image]),
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+                }), { metadata: @rpc_metadata })
+        end
+
+        def search_image(query, n)
+            format_search_result @stub.search_image(AnndbApiPb::ImageSearchImageRequest.new(
+                query: image_proto(query),
+                n: n.to_i
+                ), { metadata: @rpc_metadata })
+        end
+
+        def search_text(query, n)
+            format_search_result @stub.search_text(AnndbApiPb::ImageSearchTextRequest.new(
+                query: query.to_s,
+                n: n.to_i
+                ), { metadata: @rpc_metadata })
+        end
+
+        private
+
+        def image_proto(img)
+            if img.is_a? Array
+                return AnndbApiPb::Image.new(data: img)
+            elsif img.is_a? String
+                return AnndbApiPb::Image.new(url: img)
+            end
+            
+            raise TypeError.new('Image has to be either an array or a string')
+        end
+    end
+end

data/lib/anndb_api/text_dataset.rb

@@ -0,0 +1,57 @@
+require 'grpc'
+
+require 'anndb_api/dataset'
+require 'text_dataset_pb'
+require 'text_dataset_services_pb'
+
+module AnndbApi
+    class TextDataset < AnndbApi::Dataset
+        def initialize(server_addr, rpc_metadata)
+            @rpc_metadata = rpc_metadata
+            @stub = AnndbApiPb::TextDataset::Stub.new(server_addr, GRPC::Core::ChannelCredentials.new())
+        end
+
+        def insert(text, metadata = {})
+            format_dataset_op_result_single @stub.insert(AnndbApiPb::TextDatasetRequest.new(items: [
+                AnndbApiPb::TextItem.new(
+                    text: text,
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def insert_batch(items)
+            format_dataset_op_result @stub.insert(AnndbApiPb::TextDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::TextItem.new(
+                    text: item[:text],
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+
+                }), { metadata: @rpc_metadata })
+        end
+
+        def update(id, text, metadata = {})
+            format_dataset_op_result_single @stub.update(AnndbApiPb::TextDatasetRequest.new(items: [
+                AnndbApiPb::TextItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(id)),
+                    text: text,
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def update_batch(items)
+            format_dataset_op_result @stub.update(AnndbApiPb::TextDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::ImageItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(item[:id])),
+                    text: item[:text],
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+                }), { metadata: @rpc_metadata })
+        end
+
+        def search(query, n)
+            format_search_result @stub.search(AnndbApiPb::TextSearchRequest.new(query: query, n: n), { metadata: @rpc_metadata })
+        end
+    end
+end

data/lib/anndb_api/util.rb

@@ -0,0 +1,11 @@
+module AnndbApi
+    class Util
+        def self.uuid_string_to_bytes(uuid)
+            [uuid.tr('-', '')].pack('H*')
+        end
+    
+        def self.ascii8bit_to_uuid(ascii_str)
+            ascii_str.unpack('H*').first
+        end
+    end
+  end

data/lib/anndb_api/vector_dataset.rb

@@ -0,0 +1,61 @@
+require 'grpc'
+
+require 'anndb_api/dataset'
+require 'core_pb'
+require 'vector_dataset_pb'
+require 'vector_dataset_services_pb'
+
+module AnndbApi
+    class VectorDataset < AnndbApi::Dataset
+        def initialize(server_addr, rpc_metadata)
+            @rpc_metadata = rpc_metadata
+            @stub = AnndbApiPb::VectorDataset::Stub.new(server_addr, GRPC::Core::ChannelCredentials.new())
+        end
+
+        def insert(vector, metadata = {})
+            format_dataset_op_result_single @stub.insert(AnndbApiPb::VectorDatasetRequest.new(items: [
+                AnndbApiPb::VectorItem.new(
+                    vector: AnndbApiPb::Vector.new(values: vector),
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def insert_batch(items)
+            format_dataset_op_result @stub.insert(AnndbApiPb::VectorDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::VectorItem.new(
+                    vector: AnndbApiPb::Vector.new(values: item[:vector]),
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+
+                }), { metadata: @rpc_metadata })
+        end
+
+        def update(id, vector, metadata = {})
+            format_dataset_op_result_single @stub.update(AnndbApiPb::VectorDatasetRequest.new(items: [
+                AnndbApiPb::VectorItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(id)),
+                    vector: AnndbApiPb::Vector.new(values: vector),
+                    metadata: format_req_metadata(metadata)
+                    )
+                ]), { metadata: @rpc_metadata })
+        end
+
+        def update_batch(items)
+            format_dataset_op_result @stub.update(AnndbApiPb::VectorDatasetRequest.new(items: items.map { |item|
+                AnndbApiPb::ImageItem.new(
+                    id: AnndbApiPb::UUID.new(data: AnndbApi::Util.uuid_string_to_bytes(item[:id])),
+                    vector: AnndbApiPb::Vector.new(values: item[:vector]),
+                    metadata: format_req_metadata(item.fetch(:metadata, {}))
+                    )
+                }), { metadata: @rpc_metadata })
+        end
+
+        def search(query, n)
+            format_search_result @stub.search(AnndbApiPb::VectorSearchRequest.new(
+                query: AnndbApiPb::Vector.new(values: query),
+                n: n
+                ), { metadata: @rpc_metadata })
+        end
+    end
+end

data/lib/core_pb.rb

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: core.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("core.proto", :syntax => :proto3) do
+    add_message "anndb_api_pb.Image" do
+      optional :data, :bytes, 1
+      optional :url, :string, 2
+    end
+    add_message "anndb_api_pb.Vector" do
+      repeated :values, :float, 1
+    end
+    add_message "anndb_api_pb.UUID" do
+      optional :data, :bytes, 1
+    end
+    add_message "anndb_api_pb.Error" do
+      optional :code, :uint32, 1
+      optional :message, :string, 2
+    end
+    add_message "anndb_api_pb.DeleteRequest" do
+      repeated :ids, :message, 1, "anndb_api_pb.UUID"
+    end
+    add_message "anndb_api_pb.DatasetOpResult" do
+      repeated :ids, :message, 1, "anndb_api_pb.UUID"
+      repeated :errors, :message, 2, "anndb_api_pb.Error"
+    end
+    add_message "anndb_api_pb.SearchResult" do
+      repeated :items, :message, 1, "anndb_api_pb.SearchResultItem"
+    end
+    add_message "anndb_api_pb.SearchResultItem" do
+      optional :id, :bytes, 1
+      map :metadata, :string, :string, 2
+    end
+  end
+end
+
+module AnndbApiPb
+  Image = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.Image").msgclass
+  Vector = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.Vector").msgclass
+  UUID = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.UUID").msgclass
+  Error = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.Error").msgclass
+  DeleteRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.DeleteRequest").msgclass
+  DatasetOpResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.DatasetOpResult").msgclass
+  SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.SearchResult").msgclass
+  SearchResultItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.SearchResultItem").msgclass
+end

data/lib/image_dataset_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: image_dataset.proto
+
+require 'google/protobuf'
+
+require 'core_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("image_dataset.proto", :syntax => :proto3) do
+    add_message "anndb_api_pb.ImageDatasetRequest" do
+      repeated :items, :message, 1, "anndb_api_pb.ImageItem"
+    end
+    add_message "anndb_api_pb.ImageItem" do
+      optional :id, :message, 1, "anndb_api_pb.UUID"
+      optional :image, :message, 2, "anndb_api_pb.Image"
+      map :metadata, :string, :string, 3
+    end
+    add_message "anndb_api_pb.ImageSearchImageRequest" do
+      optional :query, :message, 1, "anndb_api_pb.Image"
+      optional :n, :uint32, 2
+    end
+    add_message "anndb_api_pb.ImageSearchTextRequest" do
+      optional :query, :string, 1
+      optional :n, :uint32, 2
+    end
+  end
+end
+
+module AnndbApiPb
+  ImageDatasetRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.ImageDatasetRequest").msgclass
+  ImageItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.ImageItem").msgclass
+  ImageSearchImageRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.ImageSearchImageRequest").msgclass
+  ImageSearchTextRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.ImageSearchTextRequest").msgclass
+end

data/lib/image_dataset_services_pb.rb

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: image_dataset.proto for package 'anndb_api_pb'
+
+require 'grpc'
+require 'image_dataset_pb'
+
+module AnndbApiPb
+  module ImageDataset
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'anndb_api_pb.ImageDataset'
+
+      rpc :Insert, ImageDatasetRequest, DatasetOpResult
+      rpc :Update, ImageDatasetRequest, DatasetOpResult
+      rpc :Delete, DeleteRequest, DatasetOpResult
+      rpc :SearchImage, ImageSearchImageRequest, SearchResult
+      rpc :SearchText, ImageSearchTextRequest, SearchResult
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/text_dataset_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: text_dataset.proto
+
+require 'google/protobuf'
+
+require 'core_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("text_dataset.proto", :syntax => :proto3) do
+    add_message "anndb_api_pb.TextDatasetRequest" do
+      repeated :items, :message, 1, "anndb_api_pb.TextItem"
+    end
+    add_message "anndb_api_pb.TextItem" do
+      optional :id, :message, 1, "anndb_api_pb.UUID"
+      optional :text, :string, 2
+      map :metadata, :string, :string, 3
+    end
+    add_message "anndb_api_pb.TextSearchRequest" do
+      optional :query, :string, 1
+      optional :n, :uint32, 2
+    end
+  end
+end
+
+module AnndbApiPb
+  TextDatasetRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.TextDatasetRequest").msgclass
+  TextItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.TextItem").msgclass
+  TextSearchRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.TextSearchRequest").msgclass
+end

data/lib/text_dataset_services_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: text_dataset.proto for package 'anndb_api_pb'
+
+require 'grpc'
+require 'text_dataset_pb'
+
+module AnndbApiPb
+  module TextDataset
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'anndb_api_pb.TextDataset'
+
+      rpc :Insert, TextDatasetRequest, DatasetOpResult
+      rpc :Update, TextDatasetRequest, DatasetOpResult
+      rpc :Delete, DeleteRequest, DatasetOpResult
+      rpc :Search, TextSearchRequest, SearchResult
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/vector_dataset_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: vector_dataset.proto
+
+require 'google/protobuf'
+
+require 'core_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("vector_dataset.proto", :syntax => :proto3) do
+    add_message "anndb_api_pb.VectorDatasetRequest" do
+      repeated :items, :message, 1, "anndb_api_pb.VectorItem"
+    end
+    add_message "anndb_api_pb.VectorItem" do
+      optional :id, :message, 1, "anndb_api_pb.UUID"
+      optional :vector, :message, 2, "anndb_api_pb.Vector"
+      map :metadata, :string, :string, 3
+    end
+    add_message "anndb_api_pb.VectorSearchRequest" do
+      optional :query, :message, 1, "anndb_api_pb.Vector"
+      optional :n, :uint32, 2
+    end
+  end
+end
+
+module AnndbApiPb
+  VectorDatasetRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.VectorDatasetRequest").msgclass
+  VectorItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.VectorItem").msgclass
+  VectorSearchRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("anndb_api_pb.VectorSearchRequest").msgclass
+end

data/lib/vector_dataset_services_pb.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: vector_dataset.proto for package 'anndb_api_pb'
+
+require 'grpc'
+require 'vector_dataset_pb'
+
+module AnndbApiPb
+  module VectorDataset
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'anndb_api_pb.VectorDataset'
+
+      rpc :Insert, VectorDatasetRequest, DatasetOpResult
+      rpc :Update, VectorDatasetRequest, DatasetOpResult
+      rpc :Delete, DeleteRequest, DatasetOpResult
+      rpc :Search, VectorSearchRequest, SearchResult
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: anndb_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marek Galovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+description: 
+email: contact@anndb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/anndb_api.rb
+- lib/anndb_api/client.rb
+- lib/anndb_api/dataset.rb
+- lib/anndb_api/image_dataset.rb
+- lib/anndb_api/text_dataset.rb
+- lib/anndb_api/util.rb
+- lib/anndb_api/vector_dataset.rb
+- lib/core_pb.rb
+- lib/image_dataset_pb.rb
+- lib/image_dataset_services_pb.rb
+- lib/text_dataset_pb.rb
+- lib/text_dataset_services_pb.rb
+- lib/vector_dataset_pb.rb
+- lib/vector_dataset_services_pb.rb
+homepage: https://github.com/anndb-com/anndb-api-client-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: AnnDB client for Ruby
+test_files: []