Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aesthetikx/quick_openai
Convenience extensions for using OpenAI with Ruby
https://github.com/aesthetikx/quick_openai
Last synced: about 2 months ago
JSON representation
Convenience extensions for using OpenAI with Ruby
- Host: GitHub
- URL: https://github.com/aesthetikx/quick_openai
- Owner: Aesthetikx
- License: mit
- Created: 2022-12-14T15:57:55.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-13T15:12:02.000Z (12 months ago)
- Last Synced: 2024-10-31T12:55:25.981Z (2 months ago)
- Language: Ruby
- Size: 121 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# QuickOpenAI
This gem is a wrapper of [ruby-openai](https://github.com/alexrudall/ruby-openai), providing quick convenience methods for experimenting with OpenAI language and image models.
## Usage
Quickly get results from GPT3:
```ruby
puts "Hello, what is your name?".gpt3
# => My name is Aileen.
```
Quickly get images from DALLE2:
```ruby
"a drawing of a cat in a hat".dalle2.then { |tempfile|
File.write('./cat.png', tempfile.read)
}
```
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add quick_openai
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install quick_openai
## Setup
Make sure you have your OpenAI access token in ENV, and then require QuickOpenAI to include String extensions.
```ruby
ENV['OPENAI_ACCESS_TOKEN'] = '12345'
require 'quick_openai'
```
## Options
You can pass options supported by `ruby-openai` to the convenience methods:
```ruby
"a drawing of a cat in a hat".dalle2(n: 2) # => An array of two tempfiles
"count to ten in italian".gpt3(model: 'text-ada-001') # Use a different model
"write me an essay on napoleon".gpt3(max_tokens: 2048) # Produce more or less output. The default is 2048.
```
Read more about GPT3 models [here](https://beta.openai.com/docs/models/gpt-3).
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, 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/aesthetikx/quick_openai.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).