openai.rb 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e53fab536aad4674f7e0f4fee4dd5943ca9c89842a7c497e4385721d2f8b906c
-  data.tar.gz: 876e5736c390a376f886a4dfc214645c94ccf7b54f067f0f969c6fd6890a28d6
+  metadata.gz: e4cc9dca4191bdbae2964d7389c67e7d43ce756481c66c5059721f0ff2404c16
+  data.tar.gz: 727d12a574d750d050073547699aa0b837e96982e3c660ded4be9434d0bacc80
 SHA512:
-  metadata.gz: 162a9491e48177404cfcd7f0f962765c2adc5ae83dd913a5aa99b08c4cdcfa9a4ceb6975ff7dc52241b7c2874d67888acc4bd7750ca50e10325f981be94e7787
-  data.tar.gz: 0ea4ed08887bf15d62db2a8393e8268cd5002011957c5268b93be44fac1e45c8fbd067ab0ef3493c5e9e22e3fac9e36b00b53980dd84975fe0dee6065556ca25
+  metadata.gz: 2d5415f3d67872d7b57bed8e1f8101873aee5b80559c8079c6ee7b450517a913b1d6f637bc5bae70ecb5ad9207d065f22459db699d65bf3d9217e124079dc32d
+  data.tar.gz: d4d6364fbcaf8534e2743f3f6056285731642474d8006a436c43cac0bb011c3c5fe25d75410649d8fe18ed85a634dca5fcf41bfba8dfefe9da595d1d44dd1e79

data/.ruby-version

@@ -1 +1 @@
-2.6.9
+2.7.7

data/Gemfile

@@ -11,13 +11,13 @@ group :test do
 end
 
 group :lint do
-  gem 'rubocop'
-  gem 'rubocop-rspec'
+  gem 'rubocop', '~> 1.31.1'
+  gem 'rubocop-rspec', '~> 2.11.1'
 end
 
 gem 'pry', '~> 0.13.1'
 gem 'pry-byebug', '~> 3.9'
 
-gem "dotenv", "~> 2.8"
+gem 'dotenv', '~> 2.8'
 
-gem "slop", "~> 4.10"
+gem 'slop', '~> 4.10'

data/Gemfile.lock

@@ -1,10 +1,14 @@
 PATH
   remote: .
   specs:
-    openai.rb (0.0.0)
+    openai.rb (0.0.1)
+      abstract_type (~> 0.0.7)
       anima (~> 0.3)
       concord (~> 0.1)
       http (~> 5.1)
+      ice_nine (~> 0.11.x)
+      memoizable (~> 0.4.2)
+      tiktoken_ruby (~> 0.0.3)
 
 GEM
   remote: https://rubygems.org/
@@ -62,7 +66,7 @@ GEM
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -77,26 +81,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rubocop (1.31.2)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
-      rubocop (~> 1.41)
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.13.0)
     slop (4.10.1)
     thread_safe (0.3.6)
+    tiktoken_ruby (0.0.3-arm64-darwin)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
@@ -104,6 +106,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
 
 DEPENDENCIES
   dotenv (~> 2.8)
@@ -111,12 +114,12 @@ DEPENDENCIES
   pry (~> 0.13.1)
   pry-byebug (~> 3.9)
   rspec (~> 3.12)
-  rubocop
-  rubocop-rspec
+  rubocop (~> 1.31.1)
+  rubocop-rspec (~> 2.11.1)
   slop (~> 4.10)
 
 RUBY VERSION
-   ruby 2.6.9p207
+   ruby 2.7.7p221
 
 BUNDLED WITH
    2.3.9

data/README.md

@@ -0,0 +1,401 @@
+# OpenAI.rb
+
+A comprehensive (as of March 25th, 2023) OpenAI API wrapper with built-in support for:
+
+* caching
+* tokenization
+* response streaming
+* a simple chainable abstraction for chats
+
+## Install and Setup
+
+To install, you should be able to do:
+
+```sh
+$ gem install openai.rb
+```
+
+Usage:
+
+```ruby
+require 'openai'
+
+openai = OpenAI.create(ENV.fetch('OPENAI_API_KEY'))
+openai.api.chat_completions.create(...)
+openai.api.embeddings.create(...)
+openai.api.models.list
+# etc
+```
+
+### Caching
+
+Caching for requests is built-in. The supported caching strategy writes response files in a directory you
+specify (I chose to write as separate files since I often want to dig around and see the raw data I'm getting
+back).
+
+To enable caching:
+
+```ruby
+require 'openai'
+
+# This directory should already exist
+cache_dir = Pathname.new('~/.cache/openai')
+
+openai = OpenAI.create(ENV.fetch('OPENAI_API_KEY'), cache: cache_dir)
+
+# Will hit the API:
+openai.api.completions.create(model: 'text-davinci-002', prompt: 'Say hi')
+# Will reuse the cached response:
+openai.api.completions.create(model: 'text-davinci-002', prompt: 'Say hi')
+```
+
+NOTE: Delete requests are not cached
+
+### Tokens
+
+```ruby
+# Get encoder for a model and encode
+openai.tokens.for_model('gpt-4').encode('Hello world')
+
+# Get encoder by name
+openai.tokens.get('cl100k_base').encode('Hello world')
+
+# Get number of tokens
+openai.tokens.for_model('gpt-4').num_tokens('Hello, world!') # => 4
+```
+
+### Chat Abstraction
+
+You can use `openai.chat` in order to create a simple chainable chat interface with a model:
+
+```ruby
+openai = OpenAI.create(ENV.fetch('OPENAI_API_KEY'))
+
+chat = openai.chat(model: 'gpt-3.5-turbo')
+
+chat =
+  chat
+  .system('You are a chatbot that talks and acts like scooby doo.')
+  .user('Hi how are you doing today?')
+  .submit # API call
+  .user('Nice. What kind of snacks do you like?')
+  .submit # API call
+
+puts chat.to_log_format
+```
+
+Which results in this output:
+
+> SYSTEM: You are a chatbot that talks and acts like scooby doo.
+>
+> USER: Hi how are you doing today?
+>
+> ASSISTANT: Ruh-roh! Hello there, buddy! Scooby-Dooby-Doo is doing great! How about you, pal?
+>
+> USER: Nice. What kind of snacks do you like?
+>
+> ASSISTANT: Ruh-roh! Scooby-Dooby-Doo loves all kinds of snacks, especially Scooby Snacks! They are my favorite! But I also love bones, pizza, hamburgers, and any kind of food that's tasty and yummy. How about you, buddy? Do you have a favorite snack?
+
+## API
+
+### Audio
+
+Transcribing audio:
+
+```ruby
+transcription = openai.api.audio.transcribe(
+  file: '/path/to/sample.mp3',
+  model: 'model-id'
+)
+
+transcription.text # => "Imagine the wildest idea that you've ever had..."
+```
+
+Translating audio:
+
+```ruby
+translation = openai.api.audio.translate(
+  file: '/path/to/french/sample.mp3',
+  model: 'model-id',
+)
+
+translation.text # => "Hello, my name is Wolfgang and I come from Germany. Where are you heading today?"
+```
+
+### Chat completions
+
+Generating a chat completion:
+
+```ruby
+completion = openai.api.chat_completions.create(
+  model: 'gpt-3.5-turbo',
+  messages: [
+    { role: "user", content: "Hello" }
+  ]
+)
+
+completion.choices.first.message.content   # => "\n\nHello there, how may I assist you today?"
+```
+
+Streaming chat completion responses:
+
+```ruby
+completion = openai.api.chat_completions.create(
+  model: 'gpt-3.5-turbo',
+  messages: [{ role: "user", content: "Hello" }],
+  stream: true
+) do |completion|
+  print completion.choices.first.delta.content
+end
+
+# >> "\n\nHello there, how may I assist you today?"
+```
+
+### Completions
+
+Generating a completion:
+
+```ruby
+completion = openai.api.completions.create(
+  model: 'text-davinci-002',
+  prompt: 'Hello, world!'
+)
+
+completion.id                 # => "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7"
+completion.model              # => "text-davinci-003"
+completion.choices.first.text # => "\n\nThis is indeed a test"
+```
+
+Streaming responses:
+
+```ruby
+completion = openai.api.completions.create(
+  model: 'text-davinci-002',
+  prompt: 'Say hello world',
+  stream: true
+) do |completion|
+  puts completion.choices.first.text
+end
+
+# >> "He"
+# >> "llo,"
+# >> " world"
+# >> "!"
+```
+
+### Edits
+
+Creating an edit:
+
+```ruby
+edit = openai.api.edits.create(
+  model: 'text-davinci-002',
+  input: "What day of the wek is it?",
+  instruction: "Fix the spelling mistake"
+)
+
+edit.object             # => "edit"
+edit.choices.first.text # => "What day of the week is it?"
+```
+
+### Embeddings
+
+Creating an embedding vector for a given input text:
+
+```ruby
+embedding = openai.api.embeddings.create(
+  model: 'text-embedding-ada-002',
+  input: 'Hello, world!'
+)
+
+embedding.object                    # => 'list'
+embedding.data.first.object         # => 'embedding'
+embedding.data.first.embedding.size # => 1536
+```
+
+### Files
+
+Upload a file:
+
+```ruby
+
+file = openai.api.files.create(
+  file: '/path/to/file.jsonl',
+  purpose: 'fine-tune'
+)
+
+file.id        # => 'file-XjGxS3KTG0uNmNOK362iJua3'
+file.filename  # => 'sample.jsonl'
+file.purpose   # => 'fine-tune'
+file.deleted?  # => nil
+```
+
+Get a list of files:
+
+```ruby
+
+files = openai.api.files.list
+
+files.data.size   # => 2
+files.data.first.filename  # => 'train.jsonl'
+```
+
+Fetch a specific file’s information:
+
+```ruby
+
+file = openai.api.files.fetch('file-XjGxS3KTG0uNmNOK362iJua3')
+
+file.filename          # => 'mydata.jsonl'
+file.bytes              # => 140
+file.created_at         # => 1613779657
+file.purpose            # => 'fine-tune'
+file.object             # => 'file'
+```
+
+Get the contents of a file:
+
+```ruby
+
+response = openai.api.files.get_content('file-XjGxS3KTG0uNmNOK362iJua3')
+
+puts response # => (whatever you uploaded)
+```
+
+Delete a file:
+
+```ruby
+
+file = openai.api.files.delete('file-XjGxS3KTG0uNmNOK362iJua3')
+
+file.deleted? # => true
+```
+
+### Fine-tunes
+
+Creating a fine tune:
+
+```ruby
+fine_tune = openai.api.fine_tunes.create(training_file: 'file-XGinujblHPwGLSztz8cPS8XY')
+
+details.id              # => "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
+```
+
+Listing fine tunes:
+
+```ruby
+fine_tunes = openai.api.fine_tunes.list
+
+fine_tunes.data.first.id     # => "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
+fine_tunes.data.first.status # => "pending"
+```
+
+
+Fetching a fine tune:
+
+```ruby
+fine_tune = openai.api.fine_tunes.fetch('ft-AF1WoRqd3aJAHsqc9NY7iL8F')
+fine_tune.id                        # => "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
+```
+
+Canceling a fine tune:
+
+```ruby
+
+# Canceling a fine tune
+fine_tune = openai.api.fine_tunes.cancel('ft-xhrpBbvVUzYGo8oUO1FY4nI7')
+fine_tune.id     # => "ft-xhrpBbvVUzYGo8oUO1FY4nI7"
+fine_tune.status # => "cancelled"
+```
+
+Listing fine tune events:
+
+```ruby
+events = openai.api.fine_tunes.list_events('fine-tune-id')
+```
+
+### Images
+
+#### Generating Images
+
+Create an image with the specified prompt and size:
+
+```ruby
+images = openai.api.images.create(prompt: 'a bird in the forest', size: '512x512')
+
+images.data.first.url # => "https://example.com/image1.png"
+```
+
+#### Editing Images
+
+Edit an image with the specified parameters:
+
+```ruby
+response = openai.api.images.edit(
+  image: '/path/to/some_rgba.png',
+  mask: '/path/to/some_rgba_mask.png',
+  prompt: 'Draw a red hat on the person in the image',
+  n: 1,
+  size: '512x512',
+  response_format: 'url',
+  user: 'user-123'
+)
+
+response.created # => 1589478378
+response.data.first.url # => "https://..."
+```
+
+#### Creating Image Variations
+
+Create image variations of the specified image with the specified parameters:
+
+```ruby
+image_variations = openai.api.images.create_variation(
+  image: '/path/to/some_rgba.png',
+  n: 2,
+  size: '512x512',
+  response_format: 'url',
+  user: 'user123'
+)
+
+image_variations.created # => 1589478378
+image_variations.data.map(&:url) # => ["https://...", "https://..."]
+```
+
+### Models
+
+Listing all models:
+
+```ruby
+models = api.models.list
+
+models.data.first.id # => "model-id-0"
+models.data.size     # => 3
+```
+
+Retrieving a model:
+
+```ruby
+model = api.models.fetch('text-davinci-002')
+
+model.id           # => "text-davinci-002"
+model.object       # => "model"
+model.owned_by     # => "openai"
+model.permission   # => ["query", "completions", "models:read", "models:write", "engine:read", "engine:write"]
+```
+
+### Moderations
+
+Moderate text:
+
+```ruby
+moderation = openai.api.moderations.create(
+  input: 'This is a test',
+  model: 'text-moderation-001'
+)
+
+moderation.id                                        # => "modr-5MWoLO"
+moderation.model                                     # => "text-moderation-001"
+moderation.results.first.categories.hate             # => false
+moderation.results.first.categories.hate_threatening # => true
+```

data/bin/codegen

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'openai'
@@ -139,10 +140,12 @@ MSG
 
 assistant_response_json_example = <<~RUBY
   # api call
-  def create_completion(model:, **kwargs)
-    Response::Completion.from_json(
-      post('/v1/completions', model: model, **kwargs)
-    )
+  class Completion < self
+    def create(model:, **kwargs)
+      Response::Completion.from_json(
+        post('/v1/completions', model: model, **kwargs)
+      )
+    end
   end
 
   # wrapper
@@ -169,7 +172,11 @@ assistant_response_json_example = <<~RUBY
   end
 
   # test
-  describe '#create_completion' do
+  RSpec.describe OpenAI::API, '#completions' do
+    include_context 'an API Resource'
+
+    let(:resource) { api.completions }
+
     let(:response_body) do
       {
         "id": 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7',
@@ -192,16 +199,8 @@ assistant_response_json_example = <<~RUBY
       }
     end
 
-    let(:response) do
-      instance_double(
-        HTTP::Response,
-        status: HTTP::Response::Status.new(200),
-        body: JSON.dump(response_body)
-      )
-    end
-
     it 'can create a completion' do
-      completion = client.create_completion(model: 'text-davinci-002', prompt: 'Hello, world!')
+      completion = resource.create(model: 'text-davinci-002', prompt: 'Hello, world!')
 
       expect(http)
         .to have_received(:post)
@@ -222,12 +221,12 @@ RUBY
 
 assistant_response_form_example = <<~RUBY
   # api call
-  def create_file(file:, purpose:)
-    absolute_path = Pathname.new(file).expand_path.to_s
-    form_file = HTTP::FormData::File.new(absolute_path)
-    Response::File.from_json(
-      post_form_multipart('/v1/files', file: form_file, purpose: purpose)
-    )
+  class File < self
+    def create(file:, purpose:)
+      Response::File.from_json(
+        post_form_multipart('/v1/files', file: form_file(file), purpose: purpose)
+      )
+    end
   end
 
   # wrapper
@@ -241,48 +240,58 @@ assistant_response_form_example = <<~RUBY
     optional_field :deleted?, path: :deleted
   end
 
+  class FileList < JSONPayload
+    field :data, wrapper: File
+    field :object
+  end
+
   # test
-  describe '#create_file' do
+  RSpec.describe OpenAI::API, '#files' do
+    include_context 'an API Resource'
+
+    let(:resource) { api.files }
     let(:sample_file) { OpenAISpec::SPEC_ROOT.join('data/sample.jsonl') }
 
-    let(:response_body) do
-      {
-        "id": 'file-XjGxS3KTG0uNmNOK362iJua3',
-        "object": 'file',
-        "bytes": 140,
-        "created_at": 1_613_779_121,
-        "filename": 'sample.jsonl',
-        "purpose": 'fine-tune'
-      }
-    end
+    context 'when creating a file' do
+      let(:response_body) do
+        {
+          "id": 'file-XjGxS3KTG0uNmNOK362iJua3',
+          "object": 'file',
+          "bytes": 140,
+          "created_at": 1_613_779_121,
+          "filename": 'sample.jsonl',
+          "purpose": 'fine-tune'
+        }
+      end
 
-    it 'can create a file' do
-      file = client.create_file(
-        file: sample_file,
-        purpose: 'fine-tune'
-      )
+      it 'can create a file' do
+        file = resource.create(
+          file: sample_file,
+          purpose: 'fine-tune'
+        )
 
-      expect(http)
-        .to have_received(:post)
-        .with(
-          'https://api.openai.com/v1/files',
-          hash_including(
-            form: hash_including(
-              {
-                file: instance_of(HTTP::FormData::File),
-                purpose: 'fine-tune'
-              }
+        expect(http)
+          .to have_received(:post)
+          .with(
+            'https://api.openai.com/v1/files',
+            hash_including(
+              form: hash_including(
+                {
+                  file: instance_of(HTTP::FormData::File),
+                  purpose: 'fine-tune'
+                }
+              )
             )
           )
-        )
 
-      expect(file.id).to eql('file-XjGxS3KTG0uNmNOK362iJua3')
-      expect(file.object).to eql('file')
-      expect(file.bytes).to eql(140)
-      expect(file.created_at).to eql(1_613_779_121)
-      expect(file.filename).to eql('sample.jsonl')
-      expect(file.purpose).to eql('fine-tune')
-      expect(file.deleted?).to be(nil)
+        expect(file.id).to eql('file-XjGxS3KTG0uNmNOK362iJua3')
+        expect(file.object).to eql('file')
+        expect(file.bytes).to eql(140)
+        expect(file.created_at).to eql(1_613_779_121)
+        expect(file.filename).to eql('sample.jsonl')
+        expect(file.purpose).to eql('fine-tune')
+        expect(file.deleted?).to be(nil)
+      end
     end
   end
 RUBY
@@ -359,7 +368,7 @@ cache_file = cache_dir.join("#{codegen.verb}_#{codegen.route.gsub('/', '_')}.txt
 if cache_file.file?
   puts cache_file.read
 else
-  completion = api.create_chat_completion(
+  completion = api.chat_completions.create(
     model: 'gpt-3.5-turbo',
     messages: history,
     max_tokens: 2000,