openai.rb 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4cc9dca4191bdbae2964d7389c67e7d43ce756481c66c5059721f0ff2404c16
-  data.tar.gz: 727d12a574d750d050073547699aa0b837e96982e3c660ded4be9434d0bacc80
+  metadata.gz: 96f82f97fa18d7fc75b7efd8e01fe015b50c0d4e33c06894b37b2f807315138b
+  data.tar.gz: b563a01a6b737282477a7e47c29f1d514b0bcecd806f0b3d9b0ad3f9394fb605
 SHA512:
-  metadata.gz: 2d5415f3d67872d7b57bed8e1f8101873aee5b80559c8079c6ee7b450517a913b1d6f637bc5bae70ecb5ad9207d065f22459db699d65bf3d9217e124079dc32d
-  data.tar.gz: d4d6364fbcaf8534e2743f3f6056285731642474d8006a436c43cac0bb011c3c5fe25d75410649d8fe18ed85a634dca5fcf41bfba8dfefe9da595d1d44dd1e79
+  metadata.gz: a51cc63b3023d1bd0ca33e3ab6325ea8bd9d8a64fbff301b2e044b113e656c0245fdcb891a2633fb0d9edd18a59073e02ff4ca14fd5d32a571f71e43948402c8
+  data.tar.gz: 8eea70ae9c26df48a0b0651354bf6aa4cf7996e348bc6a6e5714aaa239a6815e1831a063c9c3efe912f283aeacaf794908189709f4ebd34209192ab42942af55

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/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.0.4
+
+* Added support for specifying `OpenAI.new(api_key, organization: 'org-123')`

data/Gemfile

@@ -16,8 +16,12 @@ group :lint do
 end
 
 gem 'pry', '~> 0.13.1'
-gem 'pry-byebug', '~> 3.9'
+gem 'pry-byebug', '3.9.0'
 
 gem 'dotenv', '~> 2.8'
 
 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,11 +1,11 @@
 PATH
   remote: .
   specs:
-    openai.rb (0.0.1)
+    openai.rb (0.0.4)
       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)
@@ -17,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)
@@ -38,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)
@@ -66,7 +65,8 @@ GEM
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.2)
+    rb_sys (0.9.70)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -77,7 +77,7 @@ 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)
@@ -98,7 +98,7 @@ GEM
     ruby-progressbar (1.13.0)
     slop (4.10.1)
     thread_safe (0.3.6)
-    tiktoken_ruby (0.0.3-arm64-darwin)
+    tiktoken_ruby (0.0.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
@@ -110,9 +110,11 @@ PLATFORMS
 
 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 (~> 1.31.1)
   rubocop-rspec (~> 2.11.1)

data/bin/console

@@ -9,14 +9,11 @@ require 'pry-byebug'
 
 Dotenv.load
 
-def start_repl
-  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
-  )
-  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
+)
 
-start_repl
+Pry.start_without_pry_byebug(binding, quiet: true)

data/lib/openai/api/client.rb

@@ -3,18 +3,18 @@
 class OpenAI
   class API
     class Client
-      include Concord.new(:api_key, :http)
+      include Concord.new(:api_key, :organization_id, :http)
 
       public :api_key
 
       HOST = Addressable::URI.parse('https://api.openai.com/v1')
 
-      def initialize(api_key, http: HTTP)
-        super(api_key, http)
+      def initialize(api_key, organization_id: nil, http: HTTP)
+        super(api_key, organization_id, http)
       end
 
       def inspect
-        "#<#{self.class}>"
+        "#<#{self.class} organization_id=#{organization_id.inspect}>"
       end
 
       def get(route)
@@ -69,7 +69,7 @@ class OpenAI
       end
 
       def unwrap_response(response)
-        raise API::Error, response unless response.status.success?
+        raise API::Error.parse(response) unless response.status.success?
 
         response.body.to_str
       end
@@ -79,7 +79,9 @@ class OpenAI
       end
 
       def http_client
-        http.headers('Authorization' => "Bearer #{api_key}")
+        headers = { 'Authorization' => "Bearer #{api_key}" }
+        headers['OpenAI-Organization'] = organization_id if organization_id
+        http.headers(headers)
       end
     end
   end

data/lib/openai/api/resource.rb

@@ -33,11 +33,8 @@ class OpenAI
       )
         payload = kwargs.merge(stream: stream)
 
-        if stream && !block_given?
-          raise 'Streaming responses require a block'
-        elsif !stream && block_given?
-          raise 'Non-streaming responses do not support blocks'
-        end
+        raise 'Streaming responses require a block' if stream && !block_given?
+        raise 'Non-streaming responses do not support blocks' if !stream && block_given?
 
         if stream
           post(endpoint, **payload) do |chunk|

data/lib/openai/api/response.rb

@@ -106,6 +106,12 @@ class OpenAI
         end
       end
 
+      class Usage < Response
+        field :prompt_tokens
+        field :completion_tokens
+        field :total_tokens
+      end
+
       class Completion < Response
         class Choice < Response
           field :text
@@ -114,18 +120,24 @@ class OpenAI
           field :finish_reason
         end
 
-        class Usage < Response
-          field :prompt_tokens
-          field :completion_tokens
-          field :total_tokens
-        end
-
         field :id
         field :object
         field :created
         field :model
         field :choices, wrapper: Choice
         optional_field :usage, wrapper: Usage
+
+        def choice
+          Util.one(choices)
+        end
+
+        # This is a convenience method for getting the response text when there is exactly
+        # one choice.
+        #
+        # @see #response
+        def response_text
+          choice.text
+        end
       end
 
       class ChatCompletion < Response
@@ -140,17 +152,27 @@ class OpenAI
           field :finish_reason
         end
 
-        class Usage < Response
-          field :prompt_tokens
-          field :completion_tokens
-          field :total_tokens
-        end
-
         field :id
         field :object
         field :created
         field :choices, wrapper: Choice
         field :usage, wrapper: Usage
+
+        # This is a convenience method for the common use case where you have exactly
+        # one choice and you want to get the message out.
+        #
+        # @see #response_text
+        def response
+          Util.one(choices).message
+        end
+
+        # This is a convenience method for getting the response text when there is exactly
+        # one choice.
+        #
+        # @see #response
+        def response_text
+          response.content
+        end
       end
 
       class ChatCompletionChunk < Response
@@ -172,6 +194,22 @@ class OpenAI
         field :created
         field :model
         field :choices, wrapper: Choice
+
+        # This is a convenience method for the common use case where you have exactly
+        # one choice and you want to get the message out.
+        #
+        # @see #response_text
+        def response
+          Util.one(choices).delta
+        end
+
+        # This is a convenience method for getting the response text when there is exactly
+        # one choice.
+        #
+        # @see #response
+        def response_text
+          response.content
+        end
       end
 
       class Embedding < Response
@@ -241,12 +279,6 @@ class OpenAI
           field :index
         end
 
-        class Usage < Response
-          field :prompt_tokens
-          field :completion_tokens
-          field :total_tokens
-        end
-
         field :object
         field :created
         field :choices, wrapper: Choice

data/lib/openai/api.rb

@@ -7,6 +7,17 @@ class OpenAI
     class Error < StandardError
       include Concord::Public.new(:http_response)
 
+      def self.parse(http_response)
+        data = JSON.parse(http_response.body.to_s, symbolize_names: true)
+        if data.dig(:error, :code) == 'context_length_exceeded'
+          Error::ContextLengthExceeded.new(http_response)
+        else
+          new(http_response)
+        end
+      rescue JSON::ParserError
+        new(http_response)
+      end
+
       def message
         <<~ERROR
           Unexpected response status! Expected 2xx but got: #{http_response.status}
@@ -16,6 +27,9 @@ class OpenAI
           #{http_response.body}
         ERROR
       end
+
+      class ContextLengthExceeded < self
+      end
     end
 
     def completions

data/lib/openai/chat.rb

@@ -2,9 +2,10 @@
 
 class OpenAI
   class Chat
-    include Anima.new(:messages, :settings, :api)
+    include Anima.new(:messages, :api_settings, :openai, :config)
+    using Util::Colorize
 
-    def initialize(messages:, **kwargs)
+    def initialize(messages:, settings: {}, config: Config.create, **kwargs)
       messages = messages.map do |msg|
         if msg.is_a?(Hash)
           Message.new(msg)
@@ -13,7 +14,16 @@ class OpenAI
         end
       end
 
-      super(messages: messages, **kwargs)
+      super(
+        messages: messages,
+        api_settings: settings,
+        config: config,
+        **kwargs
+      )
+    end
+
+    def configure(**configuration)
+      with(config: config.with(configuration))
     end
 
     def add_user_message(message)
@@ -32,26 +42,49 @@ class OpenAI
     alias assistant add_assistant_message
 
     def submit
-      response = api.chat_completions.create(
-        **settings,
-        messages: raw_messages
-      )
+      openai.logger.info("[Chat] [tokens=#{total_tokens}] Submitting messages:\n\n#{to_log_format}")
+
+      begin
+        response = openai.api.chat_completions.create(
+          **api_settings,
+          messages: raw_messages
+        )
+      rescue OpenAI::API::Error::ContextLengthExceeded
+        raise 'Context length exceeded.'
+        openai.logger.warn('[Chat] Context length exceeded. Shifting chat')
+        return shift_history.submit
+      end
 
       msg = response.choices.first.message
 
-      add_message(msg.role, msg.content)
+      add_message(msg.role, msg.content).tap do |new_chat|
+        openai.logger.info("[Chat] Response:\n\n#{new_chat.last_message.to_log_format(config)}")
+      end
     end
 
     def last_message
-      API::Response::ChatCompletion::Choice::Message.new(messages.last)
+      messages.last
     end
 
     def to_log_format
-      messages.map(&:to_log_format).join("\n\n")
+      messages.map do |msg|
+        msg.to_log_format(config)
+      end.join("\n\n")
     end
 
     private
 
+    def shift_history
+      drop_index = messages.index { |msg| msg.role != 'system' }
+      new_messages = messages.slice(0...drop_index) + messages.slice((drop_index + 1)..)
+
+      with(messages: new_messages)
+    end
+
+    def total_tokens
+      openai.tokens.for_model(api_settings.fetch(:model)).num_tokens(messages.map(&:content).join(' '))
+    end
+
     def raw_messages
       messages.map(&:to_h)
     end
@@ -64,11 +97,28 @@ class OpenAI
       with(messages: messages + [message])
     end
 
+    class Config
+      include Anima.new(:assistant_name)
+
+      def self.create
+        new(assistant_name: 'assistant')
+      end
+    end
+
     class Message
       include Anima.new(:role, :content)
 
-      def to_log_format
-        "#{role.upcase}: #{content}"
+      def to_log_format(config)
+        prefix =
+          case role
+          when 'user' then "#{role}:".upcase.green
+          when 'system' then "#{role}:".upcase.yellow
+          when 'assistant' then "#{config.assistant_name}:".upcase.red
+          else
+            raise "Unknown role: #{role}"
+          end
+
+        "#{prefix} #{content}"
       end
     end
   end

data/lib/openai/util.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class OpenAI
+  module Util
+    OneError = Class.new(ArgumentError)
+
+    def self.one(list)
+      raise OneError, "Expected exactly one element, got #{list.size}" unless list.size == 1
+
+      list.first
+    end
+
+    module Colorize
+      refine String do
+        def red
+          colorize(31)
+        end
+
+        def green
+          colorize(32)
+        end
+
+        def yellow
+          colorize(33)
+        end
+
+        def blue
+          colorize(34)
+        end
+
+        def magenta
+          colorize(35)
+        end
+
+        def cyan
+          colorize(36)
+        end
+
+        private
+
+        def colorize(color_code)
+          "\e[#{color_code}m#{self}\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class OpenAI
-  VERSION = '0.0.1'
+  VERSION = '0.0.4'
 end

data/lib/openai.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'pathname'
+require 'logger'
+
 require 'concord'
 require 'anima'
 require 'abstract_type'
@@ -8,6 +11,7 @@ require 'addressable'
 require 'ice_nine'
 require 'tiktoken_ruby'
 
+require 'openai/util'
 require 'openai/tokenizer'
 require 'openai/chat'
 require 'openai/api'
@@ -18,12 +22,14 @@ require 'openai/api/response'
 require 'openai/version'
 
 class OpenAI
-  include Concord.new(:api_client)
+  include Concord.new(:api_client, :logger)
+
+  public :logger
 
   ROOT = Pathname.new(__dir__).parent.expand_path.freeze
 
-  def self.create(api_key, cache: nil)
-    client = API::Client.new(api_key)
+  def self.create(api_key, cache: nil, organization: nil, logger: Logger.new('/dev/null'))
+    client = API::Client.new(api_key, organization_id: organization)
 
     if cache.is_a?(Pathname) && cache.directory?
       client = API::Cache.new(
@@ -32,7 +38,7 @@ class OpenAI
       )
     end
 
-    new(client)
+    new(client, logger)
   end
 
   private_class_method :new
@@ -47,6 +53,10 @@ class OpenAI
   alias tokens tokenizer
 
   def chat(model:, history: [], **kwargs)
-    Chat.new(api: api, settings: kwargs.merge(model: model), messages: history)
+    Chat.new(
+      openai: self,
+      settings: kwargs.merge(model: model),
+      messages: history
+    )
   end
 end

data/openai.gemspec

@@ -16,11 +16,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
   spec.executables   = []
 
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_dependency 'abstract_type', '~> 0.0.7'
   spec.add_dependency 'anima',         '~> 0.3'
   spec.add_dependency 'concord',       '~> 0.1'
-  spec.add_dependency 'http',          '~> 5.1'
-  spec.add_dependency 'memoizable',    '~> 0.4.2'
-  spec.add_dependency 'abstract_type', '~> 0.0.7'
+  spec.add_dependency 'http',          '>= 4.4', '< 6.0'
   spec.add_dependency 'ice_nine',      '~> 0.11.x'
+  spec.add_dependency 'memoizable',    '~> 0.4.2'
   spec.add_dependency 'tiktoken_ruby', '~> 0.0.3'
 end

data/spec/unit/openai/api/chat_completions_spec.rb

@@ -27,14 +27,16 @@ RSpec.describe OpenAI::API, '#chat_completions' do
     }
   end
 
-  it 'can create a chat completion' do
+  let(:completion) do
     messages = [
       { "text": 'Hello there!', "user": 'customer' },
       { "text": 'Can you help me with my order?', "user": 'customer' },
       { "text": 'Sure, what would you like to do?', "user": 'assistant' }
     ]
-    completion = resource.create(model: 'text-davinci-002', messages: messages)
+    resource.create(model: 'text-davinci-002', messages: messages)
+  end
 
+  it 'can create a chat completion' do
     expect(completion.id).to eql('chatcmpl-123')
     expect(completion.choices.first.index).to eql(0)
     expect(completion.choices.first.message.role).to eql('assistant')
@@ -45,6 +47,15 @@ RSpec.describe OpenAI::API, '#chat_completions' do
     expect(completion.usage.total_tokens).to eql(21)
   end
 
+  it 'exposes a #response_text helper method' do
+    expect(completion.response_text).to eql("\n\nHello there, how may I assist you today?")
+  end
+
+  it 'exposes a #response helper method' do
+    expect(completion.response.content).to eql("\n\nHello there, how may I assist you today?")
+    expect(completion.response.role).to eql('assistant')
+  end
+
   it 'raises when a block is given for a non-streaming request' do
     expect { resource.create(model: 'text-davinci-002', messages: []) { print 'noop' } }
       .to raise_error('Non-streaming responses do not support blocks')
@@ -106,6 +117,9 @@ RSpec.describe OpenAI::API, '#chat_completions' do
       expect(chunks).to all(be_an_instance_of(OpenAI::API::Response::ChatCompletionChunk))
       texts = chunks.map { |chunk| chunk.choices.first.delta.content }
       expect(texts.join('')).to eql('Hello, world!')
+
+      expect(chunks[0].response.role).to eql('assistant')
+      expect(chunks[1].response_text).to eql('He')
     end
 
     it 'raises when a block is not given' do

data/spec/unit/openai/api/completions_spec.rb

@@ -27,8 +27,10 @@ RSpec.describe OpenAI::API, '#completions' do
     }
   end
 
+  let(:completion) { resource.create(model: 'text-davinci-002', prompt: 'Hello, world!') }
+
   it 'can create a completion' do
-    completion = resource.create(model: 'text-davinci-002', prompt: 'Hello, world!')
+    completion
 
     expect(http)
       .to have_received(:post)
@@ -50,6 +52,10 @@ RSpec.describe OpenAI::API, '#completions' do
       .to raise_error('Non-streaming responses do not support blocks')
   end
 
+  it 'exposes a #response_text helper method' do
+    expect(completion.response_text).to eql("\n\nThis is indeed a test")
+  end
+
   context 'when streaming is enabled' do
     let(:response_chunks) do
       [

data/spec/unit/openai/api/moderations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe OpenAI::API, '#moderations' do
   include_context 'an API Resource'
 

data/spec/unit/openai/api/response_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe OpenAI::API::Response do
     {
       meta: {
         birth: {
-          created: Time.new(2023).to_i
+          created: Time.utc(2023).to_i
         }
       },
       text: 'This is a post',
@@ -126,7 +126,7 @@ RSpec.describe OpenAI::API::Response do
   describe '.field' do
     it 'exposes the field' do
       expect(sample_response.text).to eql('This is a post')
-      expect(sample_response.created_at).to eql(1_672_549_200)
+      expect(sample_response.created_at).to eql(1_672_531_200)
     end
 
     it 'can expose fields under a different name than the key path' do

data/spec/unit/openai/chat_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe OpenAI::Chat do
+  let(:messages) { [{ role: 'user', content: 'Hello' }] }
+  let(:settings) { { model: 'gpt-3' } }
+  let(:openai) { double('OpenAI') }
+
+  describe 'initialization and adding messages' do
+    it 'initializes with messages and adds user, system, and assistant messages' do
+      chat = OpenAI::Chat.new(messages: messages, settings: settings, openai: openai)
+
+      expect(chat.messages.count).to eq(1)
+      expect(chat.messages.first.role).to eq('user')
+      expect(chat.messages.first.content).to eq('Hello')
+
+      chat = chat.add_user_message('How are you?')
+      expect(chat.messages.count).to eq(2)
+      expect(chat.messages.last.role).to eq('user')
+      expect(chat.messages.last.content).to eq('How are you?')
+
+      chat = chat.add_system_message('System message')
+      expect(chat.messages.count).to eq(3)
+      expect(chat.messages.last.role).to eq('system')
+      expect(chat.messages.last.content).to eq('System message')
+
+      chat = chat.add_assistant_message('I am fine, thank you.')
+      expect(chat.messages.count).to eq(4)
+      expect(chat.messages.last.role).to eq('assistant')
+      expect(chat.messages.last.content).to eq('I am fine, thank you.')
+    end
+  end
+end

data/spec/unit/openai_spec.rb

@@ -37,6 +37,25 @@ RSpec.describe OpenAI do
     )
   end
 
+  context 'when the organization ID is given to the client' do
+    let(:api_client) do
+      OpenAI::API::Client.new(
+        'sk-123',
+        organization_id: 'org-123',
+        http: http
+      )
+    end
+
+    it 'authenticates the request and includes the organization id' do
+      resource.create(model: 'text-davinci-002', prompt: 'Hello, world!')
+
+      expect(http).to have_received(:headers).with(
+        'OpenAI-Organization' => 'org-123',
+        'Authorization' => 'Bearer sk-123'
+      )
+    end
+  end
+
   context 'when the request is not 2xx' do
     let(:response_body) do
       {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - John
@@ -9,92 +9,98 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: anima
+  name: abstract_type
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
-  name: concord
+  name: anima
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: concord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: memoizable
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: abstract_type
+  name: ice_nine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.11.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.11.x
 - !ruby/object:Gem::Dependency
-  name: ice_nine
+  name: memoizable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.x
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.x
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: tiktoken_ruby
   requirement: !ruby/object:Gem::Requirement
@@ -116,13 +122,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
-- bin/codegen
 - bin/console
 - lib/openai.rb
 - lib/openai/api.rb
@@ -132,6 +140,7 @@ files:
 - lib/openai/api/response.rb
 - lib/openai/chat.rb
 - lib/openai/tokenizer.rb
+- lib/openai/util.rb
 - lib/openai/version.rb
 - openai.gemspec
 - spec/data/sample.jsonl
@@ -153,6 +162,7 @@ files:
 - spec/unit/openai/api/models_spec.rb
 - spec/unit/openai/api/moderations_spec.rb
 - spec/unit/openai/api/response_spec.rb
+- spec/unit/openai/chat_spec.rb
 - spec/unit/openai/tokenizer_spec.rb
 - spec/unit/openai_spec.rb
 homepage: https://github.com/backus/openai-ruby
@@ -166,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/codegen

@@ -1,380 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'openai'
-require 'dotenv'
-require 'pry'
-require 'pry-byebug'
-require 'slop'
-require 'yaml'
-
-Dotenv.load
-api = OpenAI.new(ENV.fetch('OPENAI_API_KEY'))
-
-class Codegen
-  include Anima.new(:openapi_file, :route, :verb, :mime)
-  include Memoizable
-
-  def self.parse_cli(argv)
-    opts = Slop.parse(argv) do |o|
-      o.string '--openapi-file', 'Path to OpenAPI file', required: true
-      o.string '--route', 'API route', required: true
-      o.string '--verb', 'HTTP verb', required: true
-      o.string '--mime', 'Mime type', default: 'application/json'
-    end
-
-    openapi_file = Pathname.new(opts[:openapi_file])
-    raise ArgumentError, "OpenAPI file #{openapi_file} does not exist" unless openapi_file.exist?
-
-    route = opts[:route]
-    verb = opts[:verb]
-    mime = opts[:mime]
-
-    new(openapi_file: openapi_file, route: route, verb: verb, mime: mime)
-  end
-
-  def validate!
-    paths = doc.fetch('paths')
-    unless paths.key?(route)
-
-      raise <<~ERR
-        Invalid route!
-
-        Given: #{route}
-
-        Valid routes:
-
-        #{paths.keys.sort.join("\n")}
-      ERR
-
-    end
-
-    path_def = paths.fetch(route)
-
-    return if path_def.key?(verb)
-
-    raise <<~ERR
-      Invalid verb!
-
-      Given: #{verb}
-
-      Valid verbs: #{path_def.keys.sort.join(', ')}
-    ERR
-  end
-
-  def get?
-    verb == 'get'
-  end
-
-  def no_request_body?
-    !action.key?('requestBody')
-  end
-
-  def sample_response
-    action.fetch('x-oaiMeta').fetch('response')
-  end
-
-  def request_body_summary
-    fields = request_body.fetch('properties').keys
-    required = request_body.fetch('required')
-
-    { field: fields, required: required }
-  end
-
-  def request_body
-    ref =
-      if mime == 'application/json'
-        deep_fetch(action, ['requestBody', 'content', 'application/json', 'schema', '$ref'])
-      elsif mime == 'multipart/form-data'
-        deep_fetch(action, ['requestBody', 'content', 'multipart/form-data', 'schema', '$ref'])
-      else
-        raise "Unknown mime type #{mime}"
-      end
-    get_ref(ref)
-  end
-  memoize :request_body
-
-  def response_body
-    response = action.fetch('responses').first.last
-    ref = deep_fetch(response, %w[content application/json schema $ref])
-    get_ref(ref)
-  end
-
-  def get_ref(ref)
-    ref_path = ref.delete_prefix('#/').split('/')
-    deep_fetch(doc, ref_path)
-  end
-
-  def action
-    doc.fetch('paths').fetch(route).fetch(verb)
-  end
-
-  def doc
-    @doc ||= YAML.load_file(openapi_file)
-  end
-
-  def deep_fetch(obj, path)
-    path.reduce(obj) do |acc, key|
-      acc.fetch(key) do
-        raise "No key #{key} in #{acc.inspect}"
-      end
-    end
-  end
-end
-
-codegen = Codegen.parse_cli(ARGV)
-codegen.validate!
-
-user_message_template = <<~MSG
-  Please create an API call, a response wrapper, and a test for this request.
-  OpenAPI context in JSON:
-
-  ACTION: %<verb>s %<route>s
-  REQUEST MIME TYPE: %<mime>s
-
-  REQUEST SUMMARY: %<summary>s
-
-  SAMPLE RESPONSE: %<response>s
-MSG
-
-assistant_response_json_example = <<~RUBY
-  # api call
-  class Completion < self
-    def create(model:, **kwargs)
-      Response::Completion.from_json(
-        post('/v1/completions', model: model, **kwargs)
-      )
-    end
-  end
-
-  # wrapper
-  class Completion < JSONPayload
-    class Choice < JSONPayload
-      field :text
-      field :index
-      field :logprobs
-      field :finish_reason
-    end
-
-    class Usage < JSONPayload
-      field :prompt_tokens
-      field :completion_tokens
-      field :total_tokens
-    end
-
-    field :id
-    field :object
-    field :created
-    field :model
-    field :choices, wrapper: Choice
-    field :usage, wrapper: Usage
-  end
-
-  # test
-  RSpec.describe OpenAI::API, '#completions' do
-    include_context 'an API Resource'
-
-    let(:resource) { api.completions }
-
-    let(:response_body) do
-      {
-        "id": 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7',
-        "object": 'text_completion',
-        "created": 1_589_478_378,
-        "model": 'text-davinci-003',
-        "choices": [
-          {
-            "text": "\n\nThis is indeed a test",
-            "index": 0,
-            "logprobs": nil,
-            "finish_reason": 'length'
-          }
-        ],
-        "usage": {
-          "prompt_tokens": 5,
-          "completion_tokens": 7,
-          "total_tokens": 12
-        }
-      }
-    end
-
-    it 'can create a completion' do
-      completion = resource.create(model: 'text-davinci-002', prompt: 'Hello, world!')
-
-      expect(http)
-        .to have_received(:post)
-        .with('https://api.openai.com/v1/completions', hash_including(:json))
-
-      expect(completion.id).to eql('cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7')
-      expect(completion.model).to eql('text-davinci-003')
-      expect(completion.choices.first.text).to eql("\n\nThis is indeed a test")
-      expect(completion.choices.first.index).to eql(0)
-      expect(completion.choices.first.logprobs).to be_nil
-      expect(completion.choices.first.finish_reason).to eql('length')
-      expect(completion.usage.prompt_tokens).to eql(5)
-      expect(completion.usage.completion_tokens).to eql(7)
-      expect(completion.usage.total_tokens).to eql(12)
-    end
-  end
-RUBY
-
-assistant_response_form_example = <<~RUBY
-  # api call
-  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
-  class File < JSONPayload
-    field :id
-    field :object
-    field :bytes
-    field :created_at
-    field :filename
-    field :purpose
-    optional_field :deleted?, path: :deleted
-  end
-
-  class FileList < JSONPayload
-    field :data, wrapper: File
-    field :object
-  end
-
-  # test
-  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') }
-
-    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 = 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(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
-
-create_completion_example =
-  codegen.with(
-    route: '/completions',
-    verb: 'post',
-    mime: 'application/json'
-  )
-
-history_json_example = [
-  {
-    role: 'user',
-    content: format(
-      user_message_template,
-      mime: create_completion_example.mime,
-      verb: create_completion_example.verb,
-      route: create_completion_example.route,
-      summary: create_completion_example.request_body_summary,
-      response: create_completion_example.sample_response
-    )
-  },
-  {
-    role: 'assistant',
-    content: assistant_response_json_example
-  }
-]
-
-create_file_example =
-  codegen.with(
-    route: '/files',
-    verb: 'post',
-    mime: 'multipart/form-data'
-  )
-
-history_form_example = [
-  {
-    role: 'user',
-    content: format(
-      user_message_template,
-      mime: create_file_example.mime,
-      verb: create_file_example.verb,
-      route: create_file_example.route,
-      summary: create_file_example.request_body_summary,
-      response: create_file_example.sample_response
-    )
-  },
-  {
-    role: 'assistant',
-    content: assistant_response_form_example
-  }
-]
-
-history = [
-  *(codegen.mime == 'application/json' ? history_json_example : history_form_example),
-  {
-    role: 'user',
-    content: format(
-      user_message_template,
-      mime: codegen.mime,
-      verb: codegen.verb,
-      route: codegen.route,
-      summary: codegen.no_request_body? ? '(none)' : codegen.request_body_summary,
-      response: codegen.sample_response
-    )
-  }
-]
-
-cache_dir = Pathname.new(__dir__).parent.join('tmp/codegen')
-cache_dir.mkpath unless cache_dir.directory?
-cache_file = cache_dir.join("#{codegen.verb}_#{codegen.route.gsub('/', '_')}.txt")
-
-if cache_file.file?
-  puts cache_file.read
-else
-  completion = api.chat_completions.create(
-    model: 'gpt-3.5-turbo',
-    messages: history,
-    max_tokens: 2000,
-    temperature: 0
-  )
-  output = completion.choices[0].message.content
-  cache_file.write(output)
-  puts output
-end