Skip to content

chunky-metro/voyageai-ruby

Repository files navigation

Gem Version Build

VoyageAI Ruby

Ruby wrapper for the VoyageAI API.

Installation

Adding to a gem:

Gem::Specification.new do |spec|
  # ...
  spec.add_dependency "voyageai-ruby"
  # ...
end

Or adding to your project:

# Gemfile
gem "voyageai-ruby"

Supported Ruby versions

  • Ruby (MRI) >= 2.7.0

Usage

First, require the gem in your Ruby file:

require "voyageai-ruby"

Then, configure the VoyageAI client with your API key:

VoyageAI.configure do |config|
  config.api_key = "your_api_key_here"
end

Now you can use the VoyageAI client to interact with the API. For example:

# Example usage (replace with actual VoyageAI API methods)
response = VoyageAI::Client.new.create_embedding("Your text here")
puts response

For more detailed information on available methods and their usage, please refer to the VoyageAI API documentation.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mculp/voyageai-ruby.

Credits

This gem is generated via newgem template by @palkan.

License

The gem is available as open source under the terms of the MIT License.

Releases

No releases published

Packages

No packages published

Languages