openai-client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beca324f47af00b9a3783c51af2b17c37ffe9334ab604e0843f2c07d6b637014
-  data.tar.gz: fe550ad70a671ffd2b1bb7dfecdfbbeffa303f6b5201ce6379e1b663230bebd5
+  metadata.gz: 374775f26834baae35b6799f23ebc4c1f82379292c7b67fb0529a85a3dbee23b
+  data.tar.gz: 00a67ee196ac3f0b6e52f377605c76273c968d3aec03a47820f75ed6955907eb
 SHA512:
-  metadata.gz: cc43ebb61aaf697ba274b39dd838a30c6d79c1fe4e46a3618e49c0f2a82ae0d8809c26ce3ac6d8835d260be73487883d53c1842385cddc098eadd4ba44d2e0a0
-  data.tar.gz: 8fb583dacd100893af86455720c121450bd574af12f5afd7f4bd1f3b21da14461ea5fca0ee4a4a4f402ca8fb197f8c0ef5359c99d46d45222d0abadb55d634d0
+  metadata.gz: ddd4d92869f64c240c45924ea43b6b9acda29ec97f57c5e3f54d5b5602ec4b43e754247b53407758c20fa10abb54a8399324a59e85437d0869bd4f4e6c448a36
+  data.tar.gz: 24ec9056e95a781ed5d0f6c18c205738a375b3fb990168f41f6a1be6fec34769772403fff93d531b900d67be217a0acc6c6ff84737ef54a47dd4f23956c84354

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai-client (0.1.0)
+    openai-client (0.3.0)
       faraday (~> 1.8)
       faraday_middleware (~> 1.2)
 

data/README.md

@@ -26,16 +26,46 @@ Openai::Client.configure do |c|
   c.access_token    = 'access_token'
   c.organization_id = 'organization_id' # optional
 end
+```
 
+## OpenAI Models API
+```ruby
 # Models
 Openai::Client.models.list
 
 # Find a Model
 Openai::Client.models.find(model_id)
 ```
+## OpenAI Completions API
+```ruby
+request_body = {
+  model: 'text-davinci-003',
+  prompt: 'Say this is a test',
+  max_tokens: 7,
+  temperature: 0,
+  top_p: 1,
+  n: 1,
+  stream: false,
+  logprobs: nil,
+  stop: "\n"
+}
+Openai::Client.completions.create(request_body)
+```
+[Completions request body documentation](https://platform.openai.com/docs/api-reference/completions/create)
+
+## OpenAI Edits API
+```ruby
+request_body = {
+  model: 'text-davinci-edit-001',
+  input: 'What day of the wek is it?',
+  instruction: 'Fix the spelling mistakes'
+}
+Openai::Client.edits.create(request_body)
+```
+[Edits request body documentation](https://platform.openai.com/docs/api-reference/edits/create)
 
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/itikhonenko/openai-client.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/openai/client/completions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Completions
+      PATH = 'completions'
+
+      # @api public
+      # Public: Makes an API call to create a completion.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] a hash with a completion
+      def create(body)
+        Http.new.post(PATH, body).body
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/edits.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Edits
+      PATH = 'edits'
+
+      # @api public
+      # Public: Makes an API call to create edit.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] a hash with edit
+      def create(body)
+        Http.new.post(PATH, body).body
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   module Client
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/openai/client.rb

@@ -9,12 +9,14 @@ require 'openai/client/configuration'
 require 'openai/client/configurable'
 require 'openai/client/http'
 require 'openai/client/models'
+require 'openai/client/edits'
+require 'openai/client/completions'
 
 module Openai
   module Client
     extend Configurable
 
-    ATTRS = ['models'].freeze
+    ATTRS = ['models', 'edits', 'completions'].freeze
 
     class << self
       ATTRS.each do |attr|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ihor Tykhonenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -54,12 +54,13 @@ files:
 - README.md
 - Rakefile
 - lib/openai/client.rb
+- lib/openai/client/completions.rb
 - lib/openai/client/configurable.rb
 - lib/openai/client/configuration.rb
+- lib/openai/client/edits.rb
 - lib/openai/client/http.rb
 - lib/openai/client/models.rb
 - lib/openai/client/version.rb
-- openai-client-0.1.0.gem
 - sig/openai/client.rbs
 homepage: https://github.com/itikhonenko/openai-client
 licenses: