voyageai 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4d48a99c21b4d0120511d09b89038e3a6082a145e620fb6ecaf427f0247390
-  data.tar.gz: 4d931a99a02500a3173404b0ec7ada0c9f1a5203f074d09ddd6ef7769a884aed
+  metadata.gz: c834adfa635ba86d940fab56c4ac8bb46086fc6a025319d392c818533389e7dd
+  data.tar.gz: a610e60874f1440eaf05ae2f545350b79fd432b786ad60392251032e5b1cc7e1
 SHA512:
-  metadata.gz: 4f559800105a83db3479237cfa5c2fcd576d609a15a3d88dfc8f448750ee4fd2189abf6ce11d039f2879958b8ba418e00e214b850ce357487a562a4e13fc1f9f
-  data.tar.gz: 8cfaf28bcc73fc5540a17cf857c2458dc4197e4d452e0cd2dbdd409e6d1024992f1eb22998a19ca5733cb7ae3c2208863f71d66b475c60084cba749c9d9b5dab
+  metadata.gz: f9560b027aa73f921175a2b06ff6f551ed582f945b8838dd8fdd632ee2d321be89312fad8d3d0179490dbc06e1342a1b6f6973374953c797ce00b2a43f4a334b
+  data.tar.gz: efb6b2f84bfe349d2f909895d14c9291ace8c7af16179d4e1b83fc911b2216f69aa71826a7996fcdd97fa1b347f113eb976a8ca941ab2643726a6e20fa1b1aa6

data/README.md

@@ -10,6 +10,23 @@ gem install voyageai
 
 ## Usage
 
+### Generating Single Embedding
+
+```ruby
+require 'voyageai'
+
+input = 'A quick brown fox jumps over the lazy dog.'
+
+voyageai = VoyageAI::Client.new(api_key: 'pa-...') # or configure ENV['VOYAGEAI_API_KEY']
+
+embed = voyageai.emed(input)
+embed.model # "..."
+embed.usage # "#<VoyageAI::Usage total_tokens=...>"
+embed.embedding # [0.0, ...]
+```
+
+### Generating Multiple Embeddings
+
 ```ruby
 require 'voyageai'
 
@@ -22,10 +39,8 @@ input = [
 
 voyageai = VoyageAI::Client.new(api_key: 'pa-...') # or configure ENV['VOYAGEAI_API_KEY']
 
-result = voyageai.embed(input)
+embed = voyageai.embed(input)
 embed.model # "..."
 embed.usage # "#<VoyageAI::Usage total_tokens=...>"
-embed.embeddings.each do |embedding|
-  embedding.index # "#<VoyageAI::Embedding index=... embedding=...>
-end
+embed.embeddings # [[0.0, ...], ...]
 ```

data/lib/voyageai/client.rb

@@ -29,11 +29,11 @@ module VoyageAI
     end
 
     # @param model [String] optional (e.g. VoyageAI::Model::VOYAGE or "voyage-3")
-    # @param input [Array<String>] required (e.g. ["Sample 1", "Sample 2", ...])
+    # @param input [String, Array<String>] required (e.g. "Sample" or ["Sample 1", "Sample 2", ...])
     #
     # @return [Embedding]
     def embed(input, model: Model::VOYAGE)
-      payload = { input: input, model: model }
+      payload = { input: arrayify(input), model: model }
       response = HTTP
         .accept(:json)
         .auth("Bearer #{@api_key}")
@@ -43,5 +43,11 @@ module VoyageAI
 
       Embed.parse(data: response.parse)
     end
+
+    private
+
+    def arrayify(input)
+      input.is_a?(Array) ? input : [input]
+    end
   end
 end

data/lib/voyageai/embed.rb

@@ -15,7 +15,7 @@ module VoyageAI
     attr_accessor :usage
 
     # @!attribute [rw] embeddings
-    #   @return [Array<Embedding>]
+    #   @return [Array<Array<Float>>]
     attr_accessor :embeddings
 
     # @param data [Hash]
@@ -23,9 +23,7 @@ module VoyageAI
     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
+      embeddings = data["data"].map { |embedding_data| embedding_data["embedding"] }
 
       Embed.new(model: model, usage: usage, embeddings: embeddings)
     end
@@ -43,5 +41,12 @@ module VoyageAI
     def inspect
       "#<#{self.class.name} model=#{@model.inspect} embeddings=#{@embeddings.inspect} usage=#{@usage.inspect}>"
     end
+
+    # @param index [Integer] optional
+    #
+    # @return [Array<Float>]
+    def embedding(index: 0)
+      @embeddings[index]
+    end
   end
 end

data/lib/voyageai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voyageai
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A library for generating embeddings with https://voyageai.com.
+description: A library for generating embeddings with https://voyageai.com
 email:
 - kevin@ksylvest.com
 executables: []
@@ -52,16 +52,15 @@ files:
 - 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.
+homepage: https://github.com/ksylvest/voyageai
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ksylvest/voyageai.
-  changelog_uri: https://github.com/ksylvest/voyageai./releases
+  homepage_uri: https://github.com/ksylvest/voyageai
+  changelog_uri: https://github.com/ksylvest/voyageai/releases
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/lib/voyageai/embedding.rb

@@ -1,37 +0,0 @@
-# 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