Merge pull request alexrudall#197 from alexrudall/chat

Add ChatGPT endpoint

Author: alexrudall

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.4.0] - 2023-03-01
+
+### Added
+
+- Add Client#chat endpoint - ChatGPT over the wire!
+
 ## [3.3.0] - 2023-02-15
 
 ### Changed

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.3.0)
+    ruby-openai (3.4.0)
       httparty (>= 0.18.1)
 
 GEM

README.md

@@ -7,7 +7,7 @@
 
 Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
-Generate text with GPT-3, create images with DALL·E, or write code with Codex...
+Generate text with ChatGPT, create images with DALL·E, or write code with Codex...
 
 ## Installation
 
@@ -89,9 +89,24 @@ There are different models that can be used to generate text. For a full list an
   - code-davinci-002
   - code-cushman-001
 
+### ChatGPT
+
+ChatGPT is a model that can be used to generate text in a conversational style. You can use it to generate a response to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+
+```ruby
+    response = client.chat(
+        parameters: {
+            model: "gpt-3.5-turbo",
+            messages: [{ role: "user", content: "Hello!"}],
+        })
+    puts response.dig("choices", 0, "message", "content")
+    => "Hello! How may I assist you today?"
+
+```
+
 ### Completions
 
-Hit the OpenAI API for a completion:
+Hit the OpenAI API for a completion using other GPT-3 models:
 
 ```ruby
     response = client.completions(

lib/openai/client.rb

@@ -7,6 +7,10 @@ def initialize(access_token: nil, organization_id: nil)
       OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
+    def chat(parameters: {})
+      OpenAI::Client.json_post(path: "/chat/completions", parameters: parameters)
+    end
+
     def completions(parameters: {})
       OpenAI::Client.json_post(path: "/completions", parameters: parameters)
     end

lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "3.3.0".freeze
+  VERSION = "3.4.0".freeze
 end

spec/fixtures/cassettes/gpt-3_5-turbo-0301_chat.yml

@@ -0,0 +1,38 @@
+RSpec.describe OpenAI::Client do
+  describe "#chat" do
+    context "with messages", :vcr do
+      let(:messages) { [{ role: "user", content: "Hello!" }] }
+
+      let(:response) do
+        OpenAI::Client.new.chat(
+          parameters: {
+            model: model,
+            messages: messages
+          }
+        )
+      end
+      let(:content) { JSON.parse(response.body).dig("choices", 0, "message", "content") }
+      let(:cassette) { "#{model} chat".downcase }
+
+      context "with model: gpt-3.5-turbo" do
+        let(:model) { "gpt-3.5-turbo" }
+
+        it "succeeds" do
+          VCR.use_cassette(cassette) do
+            expect(content.split.empty?).to eq(false)
+          end
+        end
+      end
+
+      context "with model: gpt-3.5-turbo-0301" do
+        let(:model) { "gpt-3.5-turbo-0301" }
+
+        it "succeeds" do
+          VCR.use_cassette(cassette) do
+            expect(content.split.empty?).to eq(false)
+          end
+        end
+      end
+    end
+  end
+end