openrouter_client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98e5959581fadc509a596c15ef862b8432d5355605e3c36c0fdefb0cb4dcf28
-  data.tar.gz: 04e7534567aa13c34c26a159a2df648a69cd13e1233f7c3e8ecb137f56935986
+  metadata.gz: a13939cbccbd1e6a70514d6d422987b702c313d3db1c7226e61966da6c858acb
+  data.tar.gz: edfcd5e0eb7f703b91ca93a04de8f3cf33b0ae219119a65064acbed22c1ce731
 SHA512:
-  metadata.gz: d4d992b00d394aefb85553611fbce0e3d516f3ae93c35aeb243e171bf0f5493672fae79a8ee79666145a691a3aef14f68a40bda609a115bec058a48d86348e31
-  data.tar.gz: 164ee4e2f29f5991c872ad79cfeadd3496744f6c729d911eb3e42e7430a009a33b6fd8adaf8a6abe21aa87647d8fc8fe664a395a287fcbb523070c2341bc6d50
+  metadata.gz: 5edd0c39d7b2a1c57db82dcd4ab0d5b1e44042b496e54ff1c5b8b79b6268c2b5964b443a7297735e2692ed4388fff70a26d357c4cbabfd2b47eee502ca5422ba
+  data.tar.gz: 86724cc812f08258dd292cd467887c2a94d5866bb670e8394345ed8da2bdd5d596e98760d4a14f432be3d41c9e4a8f5b1585f58ee88ff2874c5eb515fbb672ac

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openrouter_client (0.1.2)
+    openrouter_client (0.1.3)
       faraday (>= 1)
 
 GEM

data/README.md

@@ -242,6 +242,44 @@ model = OpenRouter::Model.find("openai/gpt-4")
 completion = model.complete(messages: [{ role: "user", content: "Hello!" }])
 ```
 
+### Embeddings
+
+Generate vector embeddings from text for semantic search, RAG, and more:
+
+```ruby
+# Single text embedding
+embedding = OpenRouter::Embedding.create!(
+  model: "openai/text-embedding-3-small",
+  input: "The quick brown fox jumps over the lazy dog"
+)
+
+puts embedding.vector       # => [0.123, -0.456, ...]
+puts embedding.dimensions   # => 1536
+puts embedding.total_tokens # => 9
+
+# Batch embedding (multiple texts)
+embedding = OpenRouter::Embedding.create!(
+  model: "openai/text-embedding-3-small",
+  input: [
+    "Machine learning is a subset of AI",
+    "Deep learning uses neural networks"
+  ]
+)
+
+embedding.vectors.each_with_index do |vector, i|
+  puts "Text #{i}: #{vector.length} dimensions"
+end
+
+# Access individual embedding data
+embedding.data.each do |item|
+  puts "Index: #{item.index}, Dimensions: #{item.dimensions}"
+end
+
+# List available embedding models
+models = OpenRouter::Embedding.models
+models.each { |m| puts m["id"] }
+```
+
 ### Generation Stats
 
 Query detailed usage information for a completion:

data/lib/openrouter/embedding.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module OpenRouter
+  # Generate vector embeddings from text using OpenRouter's unified embeddings API.
+  # Embeddings transform text into high-dimensional vectors where semantically similar
+  # texts are positioned closer together in vector space.
+  class Embedding
+    EMBEDDINGS_PATH = "/embeddings"
+    EMBEDDING_MODELS_PATH = "/embeddings/models"
+
+    # @return [String] The model used for embedding
+    attr_reader :model
+    # @return [Array<EmbeddingData>] The embedding data objects
+    attr_reader :data
+    # @return [Hash, nil] Usage statistics
+    attr_reader :usage
+
+    # @param attributes [Hash] Raw response from OpenRouter API
+    def initialize(attributes)
+      @model = attributes["model"]
+      @usage = attributes["usage"]
+      @data = build_data(attributes["data"])
+    end
+
+    # Generate embeddings for the given input.
+    # @param model [String] The embedding model to use (e.g., "openai/text-embedding-3-small")
+    # @param input [String, Array<String>] Text or array of texts to embed
+    # @param client [OpenRouter::Client] HTTP client
+    # @param options [Hash] Additional options (e.g., provider preferences)
+    # @return [OpenRouter::Embedding]
+    def self.create!(model:, input:, client: OpenRouter.client, **options)
+      payload = {
+        model: model,
+        input: input,
+        **options
+      }
+
+      response = client.post(EMBEDDINGS_PATH, payload)
+      new(response)
+    end
+
+    # List available embedding models.
+    # @param client [OpenRouter::Client] HTTP client
+    # @return [Array<Hash>] Array of model information
+    def self.models(client: OpenRouter.client)
+      response = client.get(EMBEDDING_MODELS_PATH)
+      Array(response && response["data"])
+    end
+
+    # Get the first embedding vector (convenience method for single input).
+    # @return [Array<Float>, nil]
+    def vector
+      @data&.first&.embedding
+    end
+
+    # Get all embedding vectors.
+    # @return [Array<Array<Float>>]
+    def vectors
+      @data&.map(&:embedding) || []
+    end
+
+    # Get the dimension of the embedding vectors.
+    # @return [Integer, nil]
+    def dimensions
+      vector&.length
+    end
+
+    # Get the total tokens used.
+    # @return [Integer, nil]
+    def total_tokens
+      @usage&.dig("total_tokens")
+    end
+
+    # Get the prompt tokens used.
+    # @return [Integer, nil]
+    def prompt_tokens
+      @usage&.dig("prompt_tokens")
+    end
+
+    private
+
+    def build_data(data_array)
+      return [] unless data_array
+
+      data_array.map { |attrs| EmbeddingData.new(attrs) }
+    end
+  end
+
+  # Represents a single embedding result within an Embedding response.
+  class EmbeddingData
+    # @return [Integer] Index of this embedding in the batch
+    attr_reader :index
+    # @return [Array<Float>] The embedding vector
+    attr_reader :embedding
+
+    # @param attributes [Hash] Raw attributes from API response
+    def initialize(attributes)
+      @index = attributes["index"]
+      @embedding = attributes["embedding"]
+    end
+
+    # Get the dimension of this embedding vector.
+    # @return [Integer]
+    def dimensions
+      @embedding&.length || 0
+    end
+  end
+end

data/lib/openrouter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenRouter
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/openrouter.rb

@@ -115,6 +115,7 @@ require_relative "openrouter/completion"
 require_relative "openrouter/stream"
 require_relative "openrouter/endpoint"
 require_relative "openrouter/model"
+require_relative "openrouter/embedding"
 require_relative "openrouter/generation"
 require_relative "openrouter/credit"
 require_relative "openrouter/api_key"

data/rbi/openrouter/embedding.rbi

@@ -0,0 +1,68 @@
+# typed: strict
+# frozen_string_literal: true
+
+module OpenRouter
+  class Embedding
+    EMBEDDINGS_PATH = T.let(T.unsafe(nil), String)
+    EMBEDDING_MODELS_PATH = T.let(T.unsafe(nil), String)
+
+    sig { returns(String) }
+    def model; end
+
+    sig { returns(T::Array[OpenRouter::EmbeddingData]) }
+    def data; end
+
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    def usage; end
+
+    sig { params(attributes: T.untyped).void }
+    def initialize(attributes); end
+
+    sig do
+      params(
+        model: String,
+        input: T.any(String, T::Array[String]),
+        client: OpenRouter::Client,
+        options: T.untyped
+      ).returns(OpenRouter::Embedding)
+    end
+    def self.create!(model:, input:, client: OpenRouter.client, **options); end
+
+    sig { params(client: OpenRouter::Client).returns(T::Array[T::Hash[T.untyped, T.untyped]]) }
+    def self.models(client: OpenRouter.client); end
+
+    sig { returns(T.nilable(T::Array[Float])) }
+    def vector; end
+
+    sig { returns(T::Array[T::Array[Float]]) }
+    def vectors; end
+
+    sig { returns(T.nilable(Integer)) }
+    def dimensions; end
+
+    sig { returns(T.nilable(Integer)) }
+    def total_tokens; end
+
+    sig { returns(T.nilable(Integer)) }
+    def prompt_tokens; end
+
+    private
+
+    sig { params(data_array: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])).returns(T::Array[OpenRouter::EmbeddingData]) }
+    def build_data(data_array); end
+  end
+
+  class EmbeddingData
+    sig { returns(Integer) }
+    def index; end
+
+    sig { returns(T::Array[Float]) }
+    def embedding; end
+
+    sig { params(attributes: T.untyped).void }
+    def initialize(attributes); end
+
+    sig { returns(Integer) }
+    def dimensions; end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openrouter_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dylan Player
 bindir: exe
 cert_chain: []
-date: 2026-01-06 00:00:00.000000000 Z
+date: 2026-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,7 @@ files:
 - lib/openrouter/client.rb
 - lib/openrouter/completion.rb
 - lib/openrouter/credit.rb
+- lib/openrouter/embedding.rb
 - lib/openrouter/endpoint.rb
 - lib/openrouter/generation.rb
 - lib/openrouter/model.rb
@@ -54,6 +55,7 @@ files:
 - rbi/openrouter/client.rbi
 - rbi/openrouter/completion.rbi
 - rbi/openrouter/credit.rbi
+- rbi/openrouter/embedding.rbi
 - rbi/openrouter/endpoint.rbi
 - rbi/openrouter/generation.rbi
 - rbi/openrouter/model.rbi