chatgpt-ruby 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab25c3c1b76e0b3249dbeba1c4b0772c4c6f7d34580005f3888ff09c2829453
-  data.tar.gz: 3feffdb2bed24d6464bdd945b6a94abb1a752567fac19d2866b5430dfffda019
+  metadata.gz: adc49f5bb5b5d4862838cbb111ecd00bccf7a4adc3b7edb23b8f4e5157da2a8b
+  data.tar.gz: f4ec243a9aeeb0ee03c82b58241d9df097a2985ca7ba15a77707645b3922ff13
 SHA512:
-  metadata.gz: d42c42272c0f17cecc040f2796f08181cc858b744a5fbf33d6a26c31aa8990352b6f022832a6b9b61d25cf9b8577939783a93ce6e250a3c4458dfec16d4d43f1
-  data.tar.gz: f9a3cd15ff2901c09361ba53dd71d3ea7263669069126672b390444b11a8d660805cb34a7ea71b792afd5208c6971c3d374d58e3bb74fe2cccbc4af3a23baa5d
+  metadata.gz: 8b7edafba1fdf4d46adada02994ea92ced8c510b11bfe03fadcf4445e39813b169a594f4baae6ae5cddb44d2146d8111827a328f5e424174826ab4eecbb2d0c0
+  data.tar.gz: d5c1d54f84fe5c478bbffc2d85571e9f139072a460272152088dc85e84bbbfa8b24a5b53df3030602ba22de0cbcdad019fef0f7a5ef99f718c8d1e89d18bfbf5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [2.0.0] - 2023-07-08
+
+### Added
+
+- Added support for chat interactions with the GPT-3.5-turbo model.
+- Introduced a new `chat` method to the `ChatGPT::Client` class, which sends an array of chat messages to the API and receives the generated messages in return.
+- Updated the README to provide usage instructions for the new `chat` method.
+
 ## [1.0.0] - 2023-04-30
 
 ### Added
@@ -6,8 +14,6 @@
 - Implements ChatGPT Client with methods for completions, search, classification, summary, and answer generation.
 - Includes unit tests for each method.
 
-## [Unreleased]
-
 ## [0.1.0] - 2023-03-22
 
-- Initial release
+- Initial release

data/README.md

@@ -62,6 +62,56 @@ puts completions["choices"].map { |c| c["text"] }
 # Output: an array of completion strings
 ```
 
+## Chat
+
+The `chat` method allows for a dynamic conversation with the GPT model. It requires an array of messages where each message is a hash with two properties: `role` and `content`.
+
+`role` can be: 
+- `'system'`: Used for instructions that guide the conversation. 
+- `'user'`: Represents the user's input. 
+- `'assistant'`: Represents the model's output.
+
+`content` contains the text message from the corresponding role.
+
+Here is how you would start a chat:
+
+```ruby
+
+# Define the conversation messages
+messages = [
+  {
+    role: "system",
+    content: "You are a helpful assistant."
+  },
+  {
+    role: "user",
+    content: "Who won the world series in 2020?"
+  }
+]
+
+# Start a chat
+response = client.chat(messages)
+```
+
+The response will be a hash containing the model's message(s). You can extract the assistant's message like this:
+
+```ruby
+
+puts response['choices'][0]['message']['content'] # Outputs the assistant's message
+```
+
+The conversation can be continued by extending the `messages` array and calling the `chat` method again:
+
+```ruby
+
+messages << {role: "user", content: "Tell me more about it."}
+
+response = client.chat(messages)
+puts response['choices'][0]['message']['content'] # Outputs the assistant's new message
+```
+
+With this method, you can build an ongoing conversation with the model.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/chatgpt/client.rb

@@ -52,6 +52,35 @@ module ChatGPT
       request_api(url, data)
     end
 
+
+    # This method sends a chat message to the API
+    #
+    # @param messages [Array<Hash>] The array of messages for the conversation. 
+    # Each message is a hash with a `role` and `content` key. The `role` key can be 'system', 'user', or 'assistant',
+    # and the `content` key contains the text of the message.
+    #
+    # @param params [Hash] Optional parameters for the chat request. This can include the 'model' key to specify 
+    # the model to be used for the chat. If no 'model' key is provided, 'gpt-3.5-turbo' is used by default.
+    #
+    # @return [Hash] The response from the API.
+    def chat(messages, params = {})
+      # Set default parameters
+      model = params[:model] || 'gpt-3.5-turbo'
+
+      # Construct the URL for the chat request
+      url = "#{@endpoint}/chat/completions"
+
+      # Prepare the data for the request. The data is a hash with 'model' and 'messages' keys.
+      data = {
+        model: model,
+        messages: messages
+      }
+      
+      # Make the API request and return the response.
+      request_api(url, data)
+    end
+
+
     private
     # Make a request to the API
     #

data/lib/chatgpt/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module Chatgpt
   module Ruby
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client