voyageai 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2d6a908abb5d1383cdf74f736b5aa7eae9fc9a66634ec1fd40ce8710571763
-  data.tar.gz: 7df317f435acc60bde69219f7dc50e19952433dce8d4dee9ebda10a8a6b0ba46
+  metadata.gz: 8afba7d9e268ee2d7c8f606bb8dc13794839c960d31a0dada531dc92002d1122
+  data.tar.gz: 29a4d077a33abda9c88eb95c17abeb1e785cde693ba5a85fc2e54967028c358b
 SHA512:
-  metadata.gz: af23bbd90f54d69d912223071a4a9ca3ba9d4128c10e7d5e60ce57632c54a244f4dc656ae6dd3a923d8b8273e1836ae670401a8de7de155350d1a1a5e2e24a1b
-  data.tar.gz: a778faecde1b31e4c7a9c8955019af8ec618076dff925b3d26dce0bceeaae054174f24cfeb120d4c076750fcc730679338014c50c5ffdfe47ee2bad9a10700a4
+  metadata.gz: 3defa2dcaaee1f8da7e4fcd492d082d9ac63d1e5c22994b03ca1bff091327b84c883ef88dba1b1722bda1c7169eb6403227661fb649bac25aa2281c4188ec94a
+  data.tar.gz: 0371ccd81feb78fb19566c9be5bb71c43306c395d47002a917cd314af2985dd92967126f69179a1ca976dae750fc787393e442f74d0134a42f4e112575d3cb4f

data/README.md

@@ -1,5 +1,11 @@
 # VoyageAI
 
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/voyageai/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/voyageai)](https://rubygems.org/gems/voyageai)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/voyageai)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://voyageai.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/voyageai)](https://circleci.com/gh/ksylvest/voyageai)
+
 `voyageai` is a ruby client for [VoyageAI](https://www.voyageai.com)
 
 ## Installation
@@ -82,3 +88,81 @@ VoyageAI.configure do |config|
   config.logger = Logger.new(STDOUT)
 end
 ```
+
+## Examples
+
+```ruby
+require "voyageai"
+
+Entry = Data.define(:document, :embedding)
+
+VOYAGEAI = VoyageAI::Client.new
+
+DOCUMENTS = [
+  "John is a musician.",
+  "Paul is a plumber.",
+  "George is a teacher.",
+  "Ringo is a doctor.",
+  "Lisa is a lawyer.",
+  "Stuart is a painter.",
+  "Brian is a writer.",
+  "Jane is a chef.",
+  "Bill is a nurse.",
+  "Susan is a carpenter.",
+].freeze
+
+embeddings = VOYAGEAI.embed(DOCUMENTS, input_type: "document").embeddings
+
+ENTRIES = DOCUMENTS.zip(embeddings).map do |document, embedding|
+  Entry.new(document:, embedding:)
+end
+
+# @param src [Array<Float>]
+# @param dst [Array<Float>]
+#
+# @return [Float]
+def euclidean_distance(src, dst)
+  Math.sqrt(src.zip(dst).map { |a, b| (a - b)**2 }.reduce(:+))
+end
+
+# @param query [String]
+# @param limit [Integer]
+#
+# @return [Array<String>]
+def nearest_documents(query:, limit: 4)
+  embedding = VOYAGEAI.embed(query, input_type: "query").embedding
+
+  ENTRIES
+    .sort_by { |entry| euclidean_distance(entry.embedding, embedding) }
+    .first(limit)
+    .map(&:document)
+end
+
+# @param query [String]
+def search(query:)
+  documents = nearest_documents(query:)
+
+  results = VOYAGEAI.rerank(query:, documents:, top_k: 2).results
+
+  puts "query=#{query.inspect}"
+  results.each do |reranking|
+    document = documents[reranking.index]
+    puts("document=#{document.inspect} relevance_score=#{reranking.relevance_score}")
+  end
+end
+
+search(query: "What do George and Ringo do?")
+search(query: "Who works in the medical field?")
+```
+
+```
+query="What do George and Ringo do?"
+document="Ringo is a doctor." relevance_score=0.67968755
+document="George is a teacher." relevance_score=0.58593755
+```
+
+```
+query="Who works in the medical field?"
+document="Bill is a nurse." relevance_score=0.55078125
+document="Ringo is a doctor." relevance_score=0.50390625
+```

data/lib/voyageai/client.rb

@@ -37,12 +37,14 @@ module VoyageAI
       "#<#{self.class.name} api_key=#{masked_api_key.inspect} host=#{@host.inspect} version=#{@version.inspect}>"
     end
 
-    # @param model [String] optional (e.g. VoyageAI::Model::VOYAGE or "voyage-3")
     # @param input [String, Array<String>] required (e.g. "Sample" or ["Sample 1", "Sample 2", ...])
+    # @param model [String] optional (e.g. VoyageAI::Model::VOYAGE or "voyage-3")
+    # @param input_type [Symbol] optional (e.g. :query or :document)
+    # @param truncation [Boolean] optional
     #
     # @return [Embedding]
-    def embed(input, model: Model::VOYAGE)
-      payload = { input: arrayify(input), model: model }
+    def embed(input, model: Model::VOYAGE, input_type: nil, truncation: nil)
+      payload = { input: arrayify(input), model: model, truncation:, input_type: }.compact
       response = http.accept(:json).post("/#{@version}/embeddings", json: payload)
 
       raise RequestError.new(response:) unless response.status.ok?

data/lib/voyageai/model.rb

@@ -3,6 +3,7 @@
 module VoyageAI
   module Model
     VOYAGE_3 = "voyage-3"
+    VOYAGE_3_LARGE = "voyage-3-large"
     VOYAGE_3_LITE = "voyage-3-lite"
     VOYAGE_FINANCE_2 = "voyage-finance-2"
     VOYAGE_MULTILINGUAL_2 = "age-multilingual-2"

data/lib/voyageai/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: voyageai
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -63,10 +62,11 @@ 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: 
+  homepage_uri: https://github.com/ksylvest/voyageai
+  source_code_uri: https://github.com/ksylvest/voyageai/tree/v1.6.0
+  changelog_uri: https://github.com/ksylvest/voyageai/releases/tag/v1.6.0
+  documentation_uri: https://voyageai.ksylvest.com/
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A client for voyageai.com.
 test_files: []