openai_ruby 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c166c6a904ae2e24c863aa5fc906f92ae6be0a01b239524c5f6ceb9f1db125
-  data.tar.gz: ce98d485c2a40eda5dd2139721bd4507e7eb9b7e947757cfe790e6061c4534a6
+  metadata.gz: 33013deb6a09941565ac13e9b3ee5de96d220b54c5c18f691201312237625ed1
+  data.tar.gz: f0e635b8af085b9111f83e3575e125a6de7a931793df2f75cca27f84abb6ccac
 SHA512:
-  metadata.gz: e3e938b3e14930e9c12f5b4aa68e1f56e528e298a48089a6a0e96a2ae0dddff6ce6a54b66cfeec0f09512dc7d62a65117f889606bfe9570d133c629e022853c0
-  data.tar.gz: acad979520949c2d763f3834f97411b44a0532795451af51f63e72737957cae79bc219b421ed41187f3352232600914cf52e9e79fbc7f1dc1bc9234a741ce276
+  metadata.gz: e8b07aafb4694d054618c56808fd8e9fd12d246f24003c5d8ad1672dff02a75e9c91c2d656f0e537e9f25dfe2d1402a84ec3f0d0f8491a1310b06c936b483b09
+  data.tar.gz: f32b7a3a048742c1d2ec478ede1082176ad00a7351ee7b9de094ab2e2315e7153b2de3c641d5474ba85109b21eddbe334209c4800060dd87bb89e8433e553765

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/renny-ren/openai_ruby.svg?branch=main)](https://travis-ci.org/renny-ren/openai_ruby)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/renny-ren/openai_ruby/blob/main/LICENSE)
 
-This is a Ruby wrapper for [OpenAI API](https://openai.com/api/), which provides convenient access to the OpenAI API from applications written in Ruby.
+This is a Ruby wrapper for [OpenAI API](https://platform.openai.com/docs/api-reference), which provides convenient access to the OpenAI API from applications written in Ruby.
 
 Let's build next-gen apps with OpenAI’s powerful models.
 
@@ -30,27 +30,52 @@ create a client like this:
 client = OpenAI::Client.new("your OpenAI key here")
 ```
 
-### Completion
+### Completion 
+https://platform.openai.com/docs/api-reference/completions
 
 ```ruby
-res = client.create_completion(
-  model: "text-davinci-003", # The model which will generate the completion
-  prompt: "Hello, who are you?",
-  max_tokens: 100 # The maximum number of tokens to generate
-  temperature: 0.5, # Control randomness
-  top_p: 1,
-  frequency_penalty: 0,
-  presence_penalty: 0,
-  stop: "\n"
-)
-p res.status  # 200
+# params = {
+#   model: "text-davinci-003",
+#   prompt: "Hello, who are you?",
+#   max_tokens: 100,
+#   temperature: 0.5,
+#   frequency_penalty: 0,
+#   presence_penalty: 0,
+# }
+res = client.create_completion(params)
 response = JSON.parse(res.body)
 
 p response.dig("choices", 0, "text")  # "I am an AI created by OpenAI."
 p response.dig('usage', 'total_tokens')  # 18
 ```
 
+### Chat Completion 
+https://platform.openai.com/docs/api-reference/chat/create
+
+If you set `stream` param to `true`, a block will be called with the chunk data:
+
+```ruby
+# params = {
+#   model: "gpt-3.5-turbo",
+#   prompt: "Hello",
+#   max_tokens: 100,
+#   temperature: 1,
+#   stream: true,
+# }
+res = client.create_chat_completion(params) do |chunk, overall_received_bytes, env|
+  data = chunk[/data: (.*)\n\n$/, 1]
+  p data # {"id":"chatcmpl-6xcOWMQcilJUwJiosi7Rht6Fvuu3D","object":"chat.completion.chunk","created":1679666960,"model":"gpt-3.5-turbo-0301","choices":[{"delta":{"content":"Hello"},"index":0,"finish_reason":null}]}
+  if data == "[DONE]"
+    # the stream is end
+  else
+    response = JSON.parse(data)
+    p response.dig("choices", 0, "text")  # "Hello"
+  end
+end
+```
+
 ### Edit
+https://platform.openai.com/docs/api-reference/edits
 
 ```ruby
 res = client.create_edit(

data/lib/openai_ruby/client.rb

@@ -18,6 +18,21 @@ module OpenAI
       )
     end
 
+    def create_chat_completion(params = {})
+      if params[:stream]
+        connection.post("/v1/chat/completions") do |req|
+          req.body = params.to_json
+          req.options.on_data = proc do |chunk, overall_received_bytes, env|
+            if block_given?
+              yield(chunk, overall_received_bytes, env)
+            end
+          end
+        end
+      else
+        connection.post("/v1/chat/completions", params.to_json, headers)
+      end
+    end
+
     def create_edit(params = {})
       Faraday.post(
         "#{BASE_URL}/v1/edits",
@@ -28,6 +43,10 @@ module OpenAI
 
     private
 
+    def connection
+      Faraday.new(url: BASE_URL, headers: headers)
+    end
+
     def headers
       {
         "Content-Type" => "application/json",

data/lib/openai_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Renny Ren
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -42,7 +42,6 @@ files:
 - lib/openai_ruby.rb
 - lib/openai_ruby/client.rb
 - lib/openai_ruby/version.rb
-- openai_ruby.gemspec
 - sig/openai_ruby/ruby.rbs
 homepage: https://github.com/renny-ren/openai_ruby
 licenses:

data/openai_ruby.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/openai_ruby/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "openai_ruby"
-  spec.version = OpenAI::VERSION
-  spec.authors = ["Renny Ren"]
-  spec.email = ["rennyrjh@gmail.com"]
-
-  spec.summary = "A Ruby wrapper for OpenAI API"
-  spec.homepage = "https://github.com/renny-ren/openai_ruby"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/renny-ren/openai_ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/renny-ren/openai_ruby/blob/main/CHANGELOG.md"
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 2.7"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end