openai_ruby 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b5c8133ce4d085c9c54fc61ce8d9dea0432f9bdae4b8ac0edd4d6fb4dc00e12
-  data.tar.gz: 8a228ca58c6e52ca44896e647312dd0dcf3de7a35aea6cbf2fafe42ce1121bc7
+  metadata.gz: a4c166c6a904ae2e24c863aa5fc906f92ae6be0a01b239524c5f6ceb9f1db125
+  data.tar.gz: ce98d485c2a40eda5dd2139721bd4507e7eb9b7e947757cfe790e6061c4534a6
 SHA512:
-  metadata.gz: 214ffe83d487d1121ed9055cf0ffd8b62eddd68fc963f2fa613f932a0e2c04b47b4bf8bedbf1047b0b6c453845f0b1229102eb61252e07ce52a14295c376cf07
-  data.tar.gz: c845dd68da6d20878b439c6451d59ee681eb53ad3a2b5ef8a421c500c7532fb7c42552eeb872e333358d3d7b36eedf5961e6acb8cbf65121b003e39c5d65fa7d
+  metadata.gz: e3e938b3e14930e9c12f5b4aa68e1f56e528e298a48089a6a0e96a2ae0dddff6ce6a54b66cfeec0f09512dc7d62a65117f889606bfe9570d133c629e022853c0
+  data.tar.gz: acad979520949c2d763f3834f97411b44a0532795451af51f63e72737957cae79bc219b421ed41187f3352232600914cf52e9e79fbc7f1dc1bc9234a741ce276

data/README.md

@@ -1,8 +1,12 @@
 # OpenAI Ruby library
 
 [![Gem Version](https://badge.fury.io/rb/openai_ruby.svg)](https://badge.fury.io/rb/openai_ruby)
+[![Build Status](https://travis-ci.org/renny-ren/openai_ruby.svg?branch=main)](https://travis-ci.org/renny-ren/openai_ruby)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/renny-ren/openai_ruby/blob/main/LICENSE)
 
-This is a Ruby wrapper for [OpenAI API](https://openai.com/api/), which provides convenient access to the OpenAI API from applications written in Ruby, helps us to build next-gen apps with OpenAI’s powerful models.
+This is a Ruby wrapper for [OpenAI API](https://openai.com/api/), which provides convenient access to the OpenAI API from applications written in Ruby.
+
+Let's build next-gen apps with OpenAI’s powerful models.
 
 ## Installation
 
@@ -18,24 +22,65 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Before starting, you need to have an API key, if not, create one [here](https://platform.openai.com/account/api-keys)
+
+create a client like this:
+
+```ruby
+client = OpenAI::Client.new("your OpenAI key here")
+```
+
+### Completion
+
+```ruby
+res = client.create_completion(
+  model: "text-davinci-003", # The model which will generate the completion
+  prompt: "Hello, who are you?",
+  max_tokens: 100 # The maximum number of tokens to generate
+  temperature: 0.5, # Control randomness
+  top_p: 1,
+  frequency_penalty: 0,
+  presence_penalty: 0,
+  stop: "\n"
+)
+p res.status  # 200
+response = JSON.parse(res.body)
+
+p response.dig("choices", 0, "text")  # "I am an AI created by OpenAI."
+p response.dig('usage', 'total_tokens')  # 18
+```
+
+### Edit
+
 ```ruby
-client = OpenAI::Client.new("your openai key here")
-client.create_completion(
-  model: "text-davinci-003",
-  prompt: "What is the date today?",
-  max_tokens: 100
+res = client.create_edit(
+  model: "text-davinci-edit-001",
+  input: "What are the date today?",
+  instruction: "Fix the grammer."
 )
+response = JSON.parse(res.body)
+p response.dig("choices", 0, "text")  # "What is the date today?\n"
+```
+
+### Image
+
+```ruby
+
 ```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+You can 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/renny-ren/openai-ruby. 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/renny-ren/openai-ruby/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/renny-ren/openai_ruby. 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/renny-ren/openai_ruby/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -43,4 +88,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Openai::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/renny-ren/openai-ruby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Openai::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/renny-ren/openai_ruby/blob/main/CODE_OF_CONDUCT.md).

data/lib/openai_ruby/client.rb

@@ -10,7 +10,7 @@ module OpenAI
       @api_key = api_key
     end
 
-    def create_completion(params)
+    def create_completion(params = {})
       Faraday.post(
         "#{BASE_URL}/v1/completions",
         params.to_json,
@@ -18,6 +18,14 @@ module OpenAI
       )
     end
 
+    def create_edit(params = {})
+      Faraday.post(
+        "#{BASE_URL}/v1/edits",
+        params.to_json,
+        headers
+      )
+    end
+
     private
 
     def headers

data/lib/openai_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/openai_ruby.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "faraday"
 require "openai_ruby/client"
 require "openai_ruby/version"
 

data/openai_ruby.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/openai_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openai_ruby"
+  spec.version = OpenAI::VERSION
+  spec.authors = ["Renny Ren"]
+  spec.email = ["rennyrjh@gmail.com"]
+
+  spec.summary = "A Ruby wrapper for OpenAI API"
+  spec.homepage = "https://github.com/renny-ren/openai_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/renny-ren/openai_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/renny-ren/openai_ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.7"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Renny Ren
@@ -32,18 +32,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".rspec_status"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/openai_ruby.rb
 - lib/openai_ruby/client.rb
 - lib/openai_ruby/version.rb
+- openai_ruby.gemspec
 - sig/openai_ruby/ruby.rbs
 homepage: https://github.com/renny-ren/openai_ruby
 licenses:

data/.rspec_status

@@ -1,3 +0,0 @@
-example_id                           | status | run_time        |
------------------------------------- | ------ | --------------- |
-./spec/openai_ruby/ruby_spec.rb[1:1] | passed | 0.00026 seconds |

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    oepnai_ruby (0.2.1)
-      faraday (~> 2.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.45.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  oepnai_ruby!
-  rake (~> 13.0)
-  rspec (~> 3.12)
-  rubocop (~> 1.45)
-
-BUNDLED WITH
-   2.3.16