openai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc9304025c682d75de3129464936ea78f4dd4557eede83d2d7991c5eff42fc12
-  data.tar.gz: 75a67fb05f17a2c21b6e4921ee4c182148b0946bcbe759943d8ffb1a60198f89
+  metadata.gz: 72e52493a36fa127172247c0db2f53153cdbb9ff1f3025d007fe9638e9298a77
+  data.tar.gz: 011f3c8fd9b2704f57a65bd406d7ea62efcfe17637c90a95ce3db97c02cfc3a5
 SHA512:
-  metadata.gz: dcfa0890195ceaf0518f43383e3b7e1816a3fcba9872f90f2cd9b1966bf67b386c9020363bc43c3958a40caa085d5a1a23517cb8284e556cd0622a9471554e3b
-  data.tar.gz: 4fac147f449433f8e483646407ea4cba9b3b467b8c0b6e29bc986612f68b20e9adf83964898639f9fdbd3ac0232375d69046c3eb7207ebc9d7052f97c91b4317
+  metadata.gz: 7a3dcb467a183d8d7c73b0a3cdc1026e26e07f84957044c4dd7d2ba586fefb68af85aacf092f460005f99191e2ec609b545bf987cec3511538423e4fdcbad768
+  data.tar.gz: b71e17545c81c4399bcb485e750f6222d8ca43c1744452e7477aadb988f8eec4dfbfb9aa4b28308d930153f336a77dd4b916add2c4c454c4c78da399cd658848

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 TODO: Nilesh Trivedi
+Copyright (c) 2020 Nilesh Trivedi, Erik Berlin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-# Openai
+# OpenAI API client library to access GPT-3 in Ruby
 
 This is a wrapper for calling OpenAI and GPT-3's HTTP APIs. API docs are available here: https://beta.openai.com/api-docs
 
@@ -20,19 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-```
-require 'openai'
-client = Openai::Client.new(pk: "your_public_key", sk: "your_secret_key")
-completions = client.completions(prompt: "Have you wondered why", max_tokens: 10)
-```
+```ruby
+require "openai"
 
-This should return a Hash which is something like:
+openai_client = OpenAI::Client.new(api_key: ENV.fetch("OPENAI_API_KEY"), default_engine: "ada")
 
-```
-=> {"id"=>"cmpl-LMDA7GAlzSHvB6ZEUeFwvipv", "object"=>"text_completion", "created"=>1595276408, "model"=>"davinci:2020-05-03", "choices"=>[{"text"=>" airlines charge more for certain seats?\n\nOne", "index"=>0, "logprobs"=>nil, "finish_reason"=>"length"}]}
+# List Engines
+openai_client.engines
 
+# Retrieve Engine
+openai_client.engine("babbage")
+
+# Search
+openai_client.search(documents: ["White House", "hospital", "school"], query: "the president")
+
+# Create Completion
+openai_client.completions(prompt: "Once upon a time", max_tokens: 5)
 ```
 
+## TODO
+
+* Stream Completion
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/openai.rb

@@ -1,29 +1,7 @@
+require "openai/choice"
+require "openai/client"
+require "openai/completion"
+require "openai/engine"
+require "openai/logprobs"
+require "openai/search_result"
 require "openai/version"
-require "httparty"
-
-module Openai
-  class Client
-    BASE_URL = "https://api.openai.com/v1/engines/davinci"
-
-    attr_accessor :pk, :sk
-
-    def initialize(pk:, sk:)
-      @pk, @sk = pk, sk
-    end
-
-    def completions(prompt:, max_tokens: 5)
-      response = HTTParty.post(BASE_URL + "/completions", headers: self.headers, body: {
-        prompt: prompt,
-        max_tokens: max_tokens
-      }.to_json)
-      return JSON.parse(response.body)
-    end
-
-    def headers
-      {
-        "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{@sk}"
-      }
-    end
-  end
-end

data/lib/openai/choice.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  Choice = Struct.new(:finish_reason, :index, :logprobs, :text, keyword_init: true)
+end

data/lib/openai/client.rb

@@ -0,0 +1,139 @@
+require "json"
+require "net/http"
+require "time"
+require "uri"
+
+module OpenAI
+  class Client
+    class Error < RuntimeError
+    end
+
+    LastResponse = Struct.new(:date, :organization, :processing_ms, :request_id, :status_code, :status_message, keyword_init: true)
+
+    attr_reader :last_response
+    attr_writer :api_key
+    attr_accessor :default_engine
+
+    def initialize(api_key:, default_engine: "davinci")
+      @api_key = api_key
+      @default_engine = default_engine
+    end
+
+    def engine(id = default_engine)
+      engine = get("/v1/engines/#{id}")
+      Engine.new(**engine)
+    end
+
+    def engines
+      engines = get("/v1/engines")
+      engines[:data].map do |engine|
+        Engine.new(**engine)
+      end
+    end
+
+    def completions(prompt: nil, max_tokens: nil, temperature: nil, top_p: nil, n: nil, logprobs: nil, echo: nil, stop: nil, presence_penalty: nil, frequency_penalty: nil, engine: default_engine)
+      body = {
+        "prompt"            => prompt,
+        "max_tokens"        => max_tokens,
+        "temperature"       => temperature,
+        "top_p"             => top_p,
+        "n"                 => n,
+        "logprobs"          => logprobs,
+        "echo"              => echo,
+        "stop"              => stop,
+        "presence_penalty"  => presence_penalty,
+        "frequency_penalty" => frequency_penalty,
+      }.compact
+
+      completion = post("/v1/engines/#{engine}/completions", body: body)
+
+      choices = completion[:choices]&.map do |choice|
+        Choice.new(
+          finish_reason: choice[:finish_reason],
+          index: choice[:index],
+          text: choice[:text],
+          logprobs: choice[:logprobs]&.tap do |logprob|
+            Logprobs.new(
+              text_offset: logprob[:text_offset],
+              token_logprobs: logprob[:token_logprobs],
+              tokens: logprob[:tokens],
+              top_logprobs: logprob[:top_logprobs]
+            )
+          end
+        )
+      end
+
+      Completion.new(
+        choices: choices,
+        created: completion[:created],
+        id: completion[:id],
+        model: completion[:model],
+        object: completion[:object]
+      )
+    end
+
+    def search(documents:, query:, engine: default_engine)
+      body = {
+        "documents" => documents,
+        "query"     => query,
+      }.compact
+
+      search_results = post("/v1/engines/#{engine}/search", body: body)
+      search_results[:data].map.with_index do |datum, index|
+        SearchResult.new(**datum).tap do |result|
+          result.text = documents[index]
+        end
+      end
+    end
+
+    private def get(path)
+      uri = URI.parse("https://api.openai.com#{path}")
+      req = Net::HTTP::Get.new(uri)
+      headers.each do |name, value|
+        req[name] = value
+      end
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+      handle_response(response)
+    end
+
+    private def post(path, body: nil)
+      uri = URI.parse("https://api.openai.com#{path}")
+      req = Net::HTTP::Post.new(uri)
+      req.body = body.to_json
+      headers.each do |name, value|
+        req[name] = value
+      end
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+      handle_response(response)
+    end
+
+    private def handle_response(response)
+      date = Time.httpdate(response["date"]) if response["date"]
+      organization = response["openai-organization"]
+      processing_ms = response["openai-processing-ms"]&.to_i
+      request_id = response["x-request-id"]
+      status_code = response.code&.to_i
+      status_message = response.message
+      @last_response = LastResponse.new(date: date, organization: organization, processing_ms: processing_ms, request_id: request_id, status_code: status_code, status_message: status_message)
+
+      response_body = JSON.parse(response.body, symbolize_names: true)
+      case response
+      when Net::HTTPSuccess
+        response_body
+      else
+        raise Error, response_body[:error][:message].to_s
+      end
+    end
+
+    private def headers
+      @headers ||= {
+        "Authorization" => "Bearer #{@api_key}",
+        "Content-Type"  => "application/json",
+      }
+    end
+  end
+end

data/lib/openai/completion.rb

@@ -0,0 +1,7 @@
+module OpenAI
+  Completion = Struct.new(:choices, :created, :id, :model, :object, keyword_init: true) do
+    def created_at
+      Time.at(created)
+    end
+  end
+end

data/lib/openai/engine.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  Engine = Struct.new(:id, :object, :owner, :ready, keyword_init: true)
+end

data/lib/openai/logprobs.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  Logprobs = Struct.new(:tokens, :token_logprobs, :top_logprobs, :text_offset, keyword_init: true)
+end

data/lib/openai/search_result.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  SearchResult = Struct.new(:document, :object, :score, :text, keyword_init: true)
+end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
-module Openai
-  VERSION = "0.1.0"
+module OpenAI
+  VERSION = "0.2.0".freeze
 end

data/openai.gemspec

@@ -1,17 +1,16 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "openai/version"
+require_relative "lib/openai/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "openai"
-  spec.version       = Openai::VERSION
-  spec.authors       = ["Nilesh Trivedi"]
-  spec.email         = ["git@nileshtrivedi.com"]
+  spec.version       = OpenAI::VERSION
+  spec.authors       = ["Nilesh Trivedi", "Erik Berlin"]
+  spec.email         = ["git@nileshtrivedi.com", "sferik@gmail.com"]
 
-  spec.summary       = %q{Wrapper for OpenAI / GPT-3's HTTP APIs}
-  spec.description       = %q{Wrapper for OpenAI / GPT-3's HTTP APIs}
+  spec.summary       = "OpenAI API client library to access GPT-3 in Ruby"
+  spec.description   = "OpenAI API client library to access GPT-3 in Ruby"
   spec.homepage      = "https://github.com/nileshtrivedi/openai"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/nileshtrivedi/openai"
@@ -19,14 +18,15 @@ Gem::Specification.new do |spec|
 
   # 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(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "httparty", ">= 0.17.0"
+  spec.add_development_dependency "bundler", ">= 2"
+  spec.add_development_dependency "rake", ">= 10"
+  spec.add_development_dependency "rspec", ">= 3.9"
+  spec.add_development_dependency "webmock", ">= 3.8"
 end

metadata

@@ -1,65 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nilesh Trivedi
-autorequire: 
+- Erik Berlin
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
-  type: :runtime
+        version: '3.9'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
-description: Wrapper for OpenAI / GPT-3's HTTP APIs
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: OpenAI API client library to access GPT-3 in Ruby
 email:
 - git@nileshtrivedi.com
+- sferik@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,6 +84,12 @@ files:
 - bin/console
 - bin/setup
 - lib/openai.rb
+- lib/openai/choice.rb
+- lib/openai/client.rb
+- lib/openai/completion.rb
+- lib/openai/engine.rb
+- lib/openai/logprobs.rb
+- lib/openai/search_result.rb
 - lib/openai/version.rb
 - openai.gemspec
 homepage: https://github.com/nileshtrivedi/openai
@@ -76,7 +99,7 @@ metadata:
   homepage_uri: https://github.com/nileshtrivedi/openai
   source_code_uri: https://github.com/nileshtrivedi/openai
   changelog_uri: https://github.com/nileshtrivedi/openai/blob/master/changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,15 +107,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Wrapper for OpenAI / GPT-3's HTTP APIs
+summary: OpenAI API client library to access GPT-3 in Ruby
 test_files: []