roseflow-pinecone 0.1.0

data/lib/roseflow/pinecone/vectors/common.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module Pinecone
+    module Vectors
+      module Common
+        def self.extended(base_class)
+          base_class.extend ClassMethods
+        end
+
+        def self.included(base_class)
+          base_class.extend ClassMethods
+        end
+
+        module ClassMethods
+          def self.new(input)
+            validation = self.contract_object.new.call(input)
+            if validation.success?
+              super(input)
+            else
+              raise ArgumentError.new(validation.errors.to_h.inspect)
+            end
+          end
+        end
+
+        def to_json
+          to_h.map do |key, value|
+            [key.to_s.split("_").map.with_index do |word, index|
+              index == 0 ? word : word.capitalize
+            end.join.to_sym, value]
+          end.to_h.to_json
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/deletion.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+require "roseflow/pinecone/object"
+require "roseflow/pinecone/vectors/filter"
+require "roseflow/pinecone/vectors/common"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class Deletion < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+
+        class DeletionContract < Dry::Validation::Contract
+          params do
+            optional(:ids).filled(:array)
+            optional(:namespace).filled(:string)
+            optional(:filter).filled
+            optional(:delete_all).filled(:bool)
+          end
+        end
+
+        contract_object DeletionContract
+
+        attribute? :ids, Dry::Types['array'].of(Dry::Types['string'])
+        attribute? :namespace, Dry::Types['string']
+        attribute? :filter, Types.Instance(Filter)
+        attribute? :delete_all, Dry::Types['bool'].default(false)
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/filter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+module Types
+  include Dry.Types()
+
+  StringOrNumberOrBoolean = Dry::Types['string'] | Dry::Types['integer'] | Dry::Types['float'] | Dry::Types['bool']
+  StringOrNumber = Dry::Types['string'] | Dry::Types['integer'] | Dry::Types['float']
+  Number = Dry::Types['integer'] | Dry::Types['float']
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class Filter < Hash
+        class FilterContract < Dry::Validation::Contract
+          schema do
+            optional(:$and).filled(:array)
+            optional(:$or).filled(:array)
+            optional(:$eq).filled(Types::StringOrNumberOrBoolean)
+            optional(:$ne).filled(Types::StringOrNumberOrBoolean)
+            optional(:$gt).filled(Types::Number)
+            optional(:$gte).filled(Types::Number)
+            optional(:$lt).filled(Types::Number)
+            optional(:$lte).filled(Types::Number)
+            optional(:$in).filled(:array).each(Types::StringOrNumber)
+            optional(:$nin).filled(:array).each(Types::StringOrNumber)
+          end
+
+          rule(:$and) do
+            if key?
+              key(:$and).failure("'$any' must be an array") unless value.is_a?(Array)
+
+              value.each do |v|
+                key(:$and).failure("'$any' must be an array of filters") unless v.is_a?(Filter) || to_filter(v).is_a?(Filter)
+              end
+            end
+          end
+
+          rule(:$or) do
+            if key?
+              key(:$or).failure("'$or' must be an array") unless value.is_a?(Array)
+
+              value.each do |v|
+                key(:$or).failure("'$or' must be an array of filters") unless v.is_a?(Filter) || to_filter(v).is_a?(Filter)
+              end
+            end
+          end
+
+          def to_filter(input)
+            return false unless input.is_a?(Hash)
+            return Filter.new(input)
+          end
+        end
+
+        def self.new(input)
+          validation = FilterContract.new.call(input)
+          if validation.success?
+            super(input)
+          else
+            raise ArgumentError.new(validation.errors.to_h.inspect)
+          end
+        end
+
+        def self.default?
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/query.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+require "roseflow/pinecone/vectors/filter"
+require "roseflow/pinecone/vectors/sparse_vector"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class Query < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+
+        class QueryContract < Dry::Validation::Contract
+          params do
+            optional(:vector).filled(:array)
+            optional(:id).filled(:string)
+          end
+
+          rule(:vector, :id) do
+            if !values[:vector].nil? && !values[:id].nil?
+              key(:vector).failure("Only one of vector or id can be specified")
+              key(:id).failure("Only one of vector or id can be specified")
+            end
+          end
+        end
+
+        contract_object QueryContract
+
+        schema schema.strict
+
+        attribute :namespace, Dry::Types['string'].default("")
+        attribute :include_values, Dry::Types['bool'].default(false)
+        attribute :include_metadata, Dry::Types['bool'].default(true)
+        attribute :top_k, Dry::Types['integer'].default(10)
+        attribute? :vector, Dry::Types['array'].of(Dry::Types['float'] | Dry::Types['integer'])
+        attribute? :filter, Filter
+        attribute? :sparse_vector, SparseVector
+        attribute? :id, Dry::Types['string']
+
+        def self.new(input)
+          validation = self.contract_object.new.call(input)
+          if validation.success?
+            super(input)
+          else
+            raise ArgumentError.new(validation.errors.to_h.inspect)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/sparse_vector.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+require "roseflow/pinecone/object"
+require "roseflow/pinecone/vectors/common"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class SparseVector < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+
+        class SparseVectorContract < Dry::Validation::Contract
+          params do
+            required(:indices).filled(:array)
+            required(:values).filled(:array)
+          end
+
+          rule(:indices, :values) do
+            unless values[:indices].size === values[:values].size
+              key(:indices).failure("Indices and values must be the same size")
+              key(:values).failure("Indices and values must be the same size")
+            end
+          end
+        end
+
+        contract_object SparseVectorContract
+
+        attribute :indices, Dry::Types['array'].of(Dry::Types['integer'])
+        attribute :values, Dry::Types['array'].of(Dry::Types['float'] | Dry::Types['integer'])
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/update.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+require "roseflow/pinecone/object"
+require "roseflow/pinecone/vectors/sparse_vector"
+require "roseflow/pinecone/vectors/common"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class Update < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+
+        class UpdateContract < Dry::Validation::Contract
+          params do
+            required(:id).filled(:string)
+            optional(:namespace).filled(:string)
+            optional(:values).filled(:array)
+            optional(:sparse_values).filled
+            optional(:metadata).filled(:hash)
+          end
+        end
+
+        contract_object UpdateContract
+
+        attribute :id, Dry::Types['string']
+        attribute? :namespace, Dry::Types['string'].optional
+        attribute? :values, Dry::Types['array'].of(Dry::Types['float']).optional
+        attribute? :sparse_values, SparseVector.optional
+        attribute? :metadata, Dry::Types['hash'].optional
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/upsert.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+require "roseflow/pinecone/object"
+require "roseflow/pinecone/vectors/sparse_vector"
+require "roseflow/pinecone/vectors/vector_object"
+require "roseflow/pinecone/vectors/common"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class Upsert < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+
+        class UpsertContract < Dry::Validation::Contract
+          params do
+            required(:vectors).filled(:array)
+            optional(:namespace).filled(:string)
+          end
+        end
+
+        contract_object UpsertContract
+
+        attribute :vectors, Dry::Types['array'].of(VectorObject)
+        attribute? :namespace, Dry::Types['string'].optional
+
+        def self.from(data)
+          raise ArgumentError, "Data must be a valid upsert hash" unless data.is_a?(Hash) && data.keys.include?(:vectors)
+          new(
+            vectors: data[:vectors].map { |vector| VectorObject.new(id: vector[:id], values: vector[:values]) },
+            namespace: data[:namespace]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/vectors/vector_object.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+
+require "roseflow/pinecone/object"
+require "roseflow/pinecone/vectors/sparse_vector"
+require "roseflow/pinecone/vectors/common"
+
+module Types
+  include Dry.Types()
+
+  Number = Types::Coercible::Float
+  # SparseVector = Roseflow::Pinecone::Vector::SparseVector
+end
+
+module Roseflow
+  module Pinecone
+    class Vector
+      class VectorObject < PineconeObject
+        include Roseflow::Pinecone::Vectors::Common
+        transform_keys(&:to_sym)
+
+        class VectorObjectContract < Dry::Validation::Contract
+          params do
+            required(:id).filled(:string)
+            required(:values).filled(:array)
+            optional(:sparse_values).filled
+            optional(:metadata).filled(:hash)
+          end
+        end
+        
+        contract_object VectorObjectContract
+
+        attribute :id, Dry::Types['string']
+        attribute :values, Dry::Types['array'].of(Types::Number)
+        attribute? :score, Types::Number.optional
+        attribute? :sparse_values, SparseVector.optional
+        attribute? :metadata, Dry::Types['hash'].optional
+      end
+    end
+  end
+end

data/lib/roseflow/pinecone/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module Pinecone
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+
+    module VERSION
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      PRE   = nil
+
+      STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
+    end
+  end
+end

data/lib/roseflow/pinecone.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "pinecone/version"
+
+require "roseflow/pinecone/client"
+require "roseflow/pinecone/collection"
+require "roseflow/pinecone/config"
+require "roseflow/pinecone/response"
+
+require "dry-struct"
+
+module Types
+  include Dry.Types()
+end
+
+module Roseflow
+  module Pinecone
+    class Error < StandardError; end
+    class IndexURLNotSetError < Error; end
+  end
+end
+

data/roseflow-pinecone.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/roseflow/pinecone/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "roseflow-pinecone"
+  spec.version = Roseflow::Pinecone.gem_version
+  spec.authors = ["Lauri Jutila"]
+  spec.email = ["git@laurijutila.com"]
+
+  spec.summary = "Roseflow meets Pinecone"
+  spec.description = "Pinecone vector database integration and support for Roseflow."
+  spec.homepage = "https://github.com/roseflow-ai/roseflow-pinecone"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/roseflow-ai/roseflow-pinecone"
+  spec.metadata["changelog_uri"] = "https://github.com/roseflow-ai/roseflow-pinecone/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+  spec.add_dependency "anyway_config", "~> 2.0"
+  spec.add_dependency "dry-struct"
+  spec.add_dependency "dry-validation"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-retry"
+
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "roseflow"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/roseflow/pinecone.rbs

@@ -0,0 +1,6 @@
+module Roseflow
+  module Pinecone
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end