voyageai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e168ee217dd0d4a6bd9ac0f220369bddc558d15cb157187d725f4ee4a2340d2
+  data.tar.gz: f2a891d5dcb4654f7ac9143eb0e6d95bd800f77b39d0acdcd38c05616a2c4cde
+SHA512:
+  metadata.gz: fe1eaccbf9d80eb5a33dcb407f9bd6e2bc578a8bbdc5627c5aeaededde53493cb17f97fb07992e671151aad576ed39ee82b093330ab932c5cf0360e4d2ab6b12
+  data.tar.gz: 7ef2238c0073848e4d9bfcebda47d271806d1bde7801ffc180a7654f82f5d24b0bd3ecbd38a9a017ff04540cdc4057df4724d5a2b6b80b352ff3093533f10f8a

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "factory_bot"
+gem "rake"
+gem "rspec"
+gem "rspec_junit_formatter"
+gem "rubocop"
+gem "rubocop-factory_bot"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "webmock"
+gem "yard"

data/README.md

@@ -0,0 +1,44 @@
+# VoyageAI
+
+`voyageai` is a ruby client for [VoyageAI](https://www.voyageai.com)
+
+## Installation
+
+```bash
+gem install voyageai
+```
+
+## Usage
+
+```ruby
+require 'voyageai'
+
+input = [
+  'John is a musician.',
+  'Paul is a plumber.',
+  'George is a teacher.',
+  'Ringo is a doctor.',
+]
+
+voyage_ai = VoyageAI::Client.new(api_key: 'pa-...')
+result = voyage_ai.embed(input)
+embed.model # "..."
+embed.usage # "#<VoyageAI::Usage total_tokens=...>"
+embed.embeddings.each do |embedding|
+  embedding # "#<VoyageAI::Embedding index=... embedding=...>
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/voyageai.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "voyageai"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/voyageai/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  # A client for interacting with the VoyageAI API.
+  class Client
+    BASE_URL = "https://api.voyageai.com/v1"
+
+    # An error raised for any HTTP issues.
+    class RequestError < StandardError
+      attr_accessor :response
+
+      # @param response [HTTP::Response]
+      def initialize(response:)
+        super("status=#{response.status} body=#{response.body}")
+        @response = response
+      end
+    end
+
+    # @param api_key [String] optional if ENV['VOYAGE_API_KEY'] otherwise required
+    def initialize(api_key: ENV.fetch("VOYAGE_API_KEY", nil))
+      @api_key = api_key || raise(ArgumentError, "api_key is required or ENV['VOYAGE_API_KEY'] must be present")
+    end
+
+    # @return [String]
+    def inspect
+      masked_api_key = "#{@api_key[..4]}***"
+
+      "#<#{self.class.name} api_key=#{masked_api_key.inspect}>"
+    end
+
+    # @param model [String] optional (e.g. VoyageAI::Model::VOYAGE or "voyage-3")
+    # @param input [Array<String>] required (e.g. ["Sample 1", "Sample 2", ...])
+    #
+    # @return [Embedding]
+    def embed(input, model: Model::VOYAGE)
+      payload = { input: input, model: model }
+      response = HTTP
+        .accept(:json)
+        .auth(@api_key)
+        .post("#{BASE_URL}/embeddings", json: payload)
+
+      raise RequestError.new(response:) unless response.status.ok?
+
+      Embed.parse(data: response.parse)
+    end
+  end
+end

data/lib/voyageai/embed.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  # The response for an embeddings request that wraps the model / usage / embeddings.
+  #
+  # @example
+  #   VoyageAI::Embed.new(model: "voyage-3", usage: VoyageAI::Usage.new(total_tokens: 0), embeddings: [])
+  class Embed
+    # @!attribute [rw] model
+    #   @return [String]
+    attr_accessor :model
+
+    # @!attribute [rw] usage
+    #   @return [Usage]
+    attr_accessor :usage
+
+    # @!attribute [rw] embeddings
+    #   @return [Array<Embedding>]
+    attr_accessor :embeddings
+
+    # @param data [Hash]
+    # @return [Embed]
+    def self.parse(data:)
+      model = data["model"]
+      usage = Usage.parse(data: data["usage"])
+      embeddings = data["data"].map do |embedding_data|
+        Embedding.parse(data: embedding_data)
+      end
+
+      Embed.new(model: model, usage: usage, embeddings: embeddings)
+    end
+
+    # @param model [String]
+    # @param usage [Usage]
+    # @param embeddings [Array<Embedding>]
+    def initialize(model:, usage:, embeddings:)
+      @model = model
+      @usage = usage
+      @embeddings = embeddings
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} model=#{@model.inspect} embeddings=#{@embeddings.inspect} usage=#{@usage.inspect}>"
+    end
+  end
+end

data/lib/voyageai/embedding.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  # An embedding returned by the VoyageAI API.
+  #
+  # @example
+  #   VoyageAI::Embedding.new(index: 0, embedding: [0.0, 1.0, 2.0, 3.0])
+  class Embedding
+    # @!attribute [rw] model
+    #   @return [Integer]
+    attr_accessor :index
+
+    # @!attribute [rw] embedding
+    #   @return [Array<Float>]
+    attr_accessor :embedding
+
+    # @param data [Hash]
+    # @return [Embedding]
+    def self.parse(data:)
+      index = data["index"]
+      embedding = data["embedding"]
+      new(index:, embedding:)
+    end
+
+    # @param index [Integer]
+    # @param embedding [Array<Float>]
+    def initialize(index:, embedding:)
+      @index = index
+      @embedding = embedding
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} index=#{index} embedding=#{embedding.inspect}>"
+    end
+  end
+end

data/lib/voyageai/model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  module Model
+    VOYAGE_3 = "voyage-3"
+    VOYAGE_3_LITE = "voyage-3-lite"
+    VOYAGE_FINANCE_2 = "voyage-finance-2"
+    VOYAGE_MULTILINGUAL_2 = "age-multilingual-2"
+    VOYAGE_LAW_2 = "voyage-law-2"
+    VOYAGE_CODE_2 = "voyage-code-2"
+
+    VOYAGE = VOYAGE_3
+    VOYAGE_LITE = VOYAGE_3_LITE
+    VOYAGE_FINANCE = VOYAGE_FINANCE_2
+    VOYAGE_MULTILINGUAL = VOYAGE_MULTILINGUAL_2
+    VOYAGE_LAW = VOYAGE_LAW_2
+    VOYAGE_CODE = VOYAGE_CODE_2
+  end
+end

data/lib/voyageai/usage.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  # The usage returned by the VoyageAI API.
+  #
+  # @example
+  #   VoyageAI::Usage.new(total_tokens: 0)
+  class Usage
+    # @!attribute [rw] total_tokens
+    #   @return [Integer]
+    attr_accessor :total_tokens
+
+    # @param total_tokens [Integer]
+    def initialize(total_tokens:)
+      @total_tokens = total_tokens
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} total_tokens=#{total_tokens}>"
+    end
+
+    # @param data [Hash]
+    # @return [Usage]
+    def self.parse(data:)
+      new(total_tokens: data["total_tokens"])
+    end
+  end
+end

data/lib/voyageai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VoyageAI
+  VERSION = "0.1.0"
+end

data/lib/voyageai.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "voyageai" => "VoyageAI"
+loader.setup
+
+module VoyageAI
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: voyageai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for generating embeddings with https://voyageai.com.
+email:
+- kevin@ksylvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- lib/voyageai.rb
+- lib/voyageai/client.rb
+- lib/voyageai/embed.rb
+- lib/voyageai/embedding.rb
+- lib/voyageai/model.rb
+- lib/voyageai/usage.rb
+- lib/voyageai/version.rb
+homepage: https://github.com/ksylvest/voyageai.
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ksylvest/voyageai.
+  changelog_uri: https://github.com/ksylvest/voyageai./releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: A client for voyageai.com.
+test_files: []