ruby-gemini

Gemini

Use the Gemini API with Ruby!

You can apply for access to the API here.

Massive thanks

This gem is built off the hard work of Alex Rudall and his work on the ruby-openai and anthropic gems. Thanks Alex!

Bundler

Add this line to your application's Gemfile:

gem "ruby-gemini"

And then execute:

$ bundle install

Gem install

Or install with:

$ gem install gemini

and require with:

require "gemini"

Usage

• Get your API key from https://makersuite.google.com/

Quickstart

For a quick test you can pass your token directly to a new client:

client = Gemini::Client.new(access_token: "access_token_goes_here")

With Config

For a more robust setup, you can configure the gem with your API keys, for example in an gemini.rb initializer file. Never hardcode secrets into your codebase - instead use something like dotenv to pass the keys safely into your environments.

Gemini.configure do |config|
    config.access_token = ENV.fetch("GEMINI_API_KEY")
end

Then you can create a client like this:

client = Gemini::Client.new

Text content

Hit the Gemini API for text content:

response = client.generate_content(
    parameters: {
        model: "gemini-pro",
        prompt: "How high is the sky?"
    })
puts response

{ "parts"=> [ { "text"=>"The sky does not have a definite height..." } ] }

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can 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`.

### Warning

If you have an `GEMINI_API_KEY` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.

## Release

First run the specs without VCR so they actually hit the API. This will cost 2 cents or more. Set GEMINI_API_KEY in your environment or pass it in like this:

GEMINI_API_KEY=123abc bundle exec rspec

Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, 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/thechrisoshow/gemini>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thechrisoshow/gemini/blob/main/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Ruby Gemini project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thechrisoshow/gemini/blob/main/CODE_OF_CONDUCT.md).