openai.rb 0.0.0 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e53fab536aad4674f7e0f4fee4dd5943ca9c89842a7c497e4385721d2f8b906c
-  data.tar.gz: 876e5736c390a376f886a4dfc214645c94ccf7b54f067f0f969c6fd6890a28d6
+  metadata.gz: f049bfa7ff5419acf81a7cabc6e34b6bd223b8f9fcb634008544d93d87170c2f
+  data.tar.gz: d614701b82eaf3ec84e9ddb432505bbbd786f71d75378534b23400446ddb8e7b
 SHA512:
-  metadata.gz: 162a9491e48177404cfcd7f0f962765c2adc5ae83dd913a5aa99b08c4cdcfa9a4ceb6975ff7dc52241b7c2874d67888acc4bd7750ca50e10325f981be94e7787
-  data.tar.gz: 0ea4ed08887bf15d62db2a8393e8268cd5002011957c5268b93be44fac1e45c8fbd067ab0ef3493c5e9e22e3fac9e36b00b53980dd84975fe0dee6065556ca25
+  metadata.gz: c321d0184079826648569ab13b04675d9cbfb04027fed85b191d462c6585cc375d9144dede8ecf6d9995e48be935bf6879dba969e17492cb9c4ffe100f468fea
+  data.tar.gz: 3fd0d70f0007e3900e6df1f39ef18dcbd618b7e3384de229b50936924bb4bf80e79d19bd7a531be6caade2b915c03581cccabc32f01b5921c79bd88e224c27a0

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby Gem CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        http_version: ['~> 4.4', '~> 5.1']
+        ruby_version: ['2.7.8']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Update .ruby-version
+      run: echo "${{ matrix.ruby_version }}" > .ruby-version
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: |
+        echo "gem 'http', '${{ matrix.http_version }}'" >> Gemfile.local
+        bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  SafeAutoCorrect: true
+  Enabled: true

data/.ruby-version

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

data/Gemfile

@@ -11,13 +11,17 @@ 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 'pry-byebug', '3.9.0'
 
-gem "dotenv", "~> 2.8"
+gem 'dotenv', '~> 2.8'
 
-gem "slop", "~> 4.10"
+gem 'slop', '~> 4.10'
+
+gem 'http', '~> 4.4' # For testing the older version of HTTP.rb
+
+gem 'rb_sys', '~> 0.9.70'

data/Gemfile.lock

@@ -1,10 +1,14 @@
 PATH
   remote: .
   specs:
-    openai.rb (0.0.0)
+    openai.rb (0.0.3)
+      abstract_type (~> 0.0.7)
       anima (~> 0.3)
       concord (~> 0.1)
-      http (~> 5.1)
+      http (>= 4.4, < 6.0)
+      ice_nine (~> 0.11.x)
+      memoizable (~> 0.4.2)
+      tiktoken_ruby (~> 0.0.3)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +17,7 @@ GEM
     adamantium (0.2.0)
       ice_nine (~> 0.11.0)
       memoizable (~> 0.4.0)
-    addressable (2.8.1)
+    addressable (2.8.2)
       public_suffix (>= 2.0.2, < 6.0)
     anima (0.3.2)
       abstract_type (~> 0.0.7)
@@ -34,24 +38,23 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (5.1.1)
-      addressable (~> 2.8)
+    http (4.4.1)
+      addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.4.0)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
     ice_nine (0.11.2)
     json (2.6.3)
-    llhttp-ffi (0.4.0)
-      ffi-compiler (~> 1.0)
-      rake (~> 13.0)
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.2.1.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -62,6 +65,7 @@ GEM
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb_sys (0.9.70)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -73,30 +77,28 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
+    rspec-mocks (3.12.5)
       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.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
@@ -104,19 +106,22 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
 
 DEPENDENCIES
   dotenv (~> 2.8)
+  http (~> 4.4)
   openai.rb!
   pry (~> 0.13.1)
-  pry-byebug (~> 3.9)
+  pry-byebug (= 3.9.0)
+  rb_sys (~> 0.9.70)
   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/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'openai'
@@ -8,9 +9,13 @@ require 'pry-byebug'
 
 Dotenv.load
 
-def start_repl
-  api = OpenAI.new(ENV.fetch('OPENAI_API_KEY'))
-  binding.pry
-end
+cache_dir = Pathname.new(__dir__).parent.join('tmp/console_cache')
+cache_dir.mkpath unless cache_dir.exist?
+openai = OpenAI.create(
+  ENV.fetch('OPENAI_API_KEY'),
+  cache: cache_dir
+)
+
+Pry.start_without_pry_byebug(binding, quiet: true)
 
 start_repl