openai.rb 0.0.0 → 0.0.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.3
 platform: ruby
 authors:
 - John
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: abstract_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: anima
   requirement: !ruby/object:Gem::Requirement
@@ -41,18 +55,66 @@ dependencies:
         version: '0.1'
 - !ruby/object:Gem::Dependency
   name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ice_nine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 0.11.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 0.11.x
+- !ruby/object:Gem::Dependency
+  name: memoizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: tiktoken_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 description: OpenAI Ruby Wrapper
 email:
 - johncbackus@gmail.com
@@ -60,19 +122,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
-- bin/codegen
+- README.md
 - bin/console
 - lib/openai.rb
+- lib/openai/api.rb
+- lib/openai/api/cache.rb
+- lib/openai/api/client.rb
+- lib/openai/api/resource.rb
+- 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
 - spec/data/sample.mp3
+- spec/data/sample_french.mp3
+- spec/data/sample_image.png
+- spec/data/sample_image_mask.png
+- spec/shared/api_resource_context.rb
 - spec/spec_helper.rb
+- spec/unit/openai/api/audio_spec.rb
+- spec/unit/openai/api/cache_spec.rb
+- spec/unit/openai/api/chat_completions_spec.rb
+- spec/unit/openai/api/completions_spec.rb
+- spec/unit/openai/api/edits_spec.rb
+- spec/unit/openai/api/embeddings_spec.rb
+- spec/unit/openai/api/files_spec.rb
+- spec/unit/openai/api/fine_tunes_spec.rb
+- spec/unit/openai/api/images_spec.rb
+- 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
 licenses: []
@@ -85,14 +175,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: OpenAI Ruby Wrapper

data/bin/codegen

@@ -1,371 +0,0 @@
-#!/usr/bin/env ruby
-
-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
-  def create_completion(model:, **kwargs)
-    Response::Completion.from_json(
-      post('/v1/completions', model: model, **kwargs)
-    )
-  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
-  describe '#create_completion' do
-    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
-
-    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!')
-
-      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
-  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)
-    )
-  end
-
-  # wrapper
-  class File < JSONPayload
-    field :id
-    field :object
-    field :bytes
-    field :created_at
-    field :filename
-    field :purpose
-    optional_field :deleted?, path: :deleted
-  end
-
-  # test
-  describe '#create_file' do
-    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
-
-    it 'can create a file' do
-      file = client.create_file(
-        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
-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.create_chat_completion(
-    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