rubygpt 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d7d5153895b17a6dc4bd74f3a55ad90a80e8b1a991256d270dbce2813c46af
-  data.tar.gz: 0aee0ce7e85e9a93f05bd26c114bd5cd536cd0bdf70c07e587e5bd751735d82a
+  metadata.gz: 341d3c4631e9e3f821bbcda5d1d29e0b0bbabd9310f8c24a78aa5c4ebaa6f1bc
+  data.tar.gz: c07408238baa0cd2d103faa2c89853ff2ab79f2f1739ae98e6e031a22cf1856c
 SHA512:
-  metadata.gz: ec76d8aa68dffa1584357eac6a8ebf8c75fef4238a9413f190abd688cf095a8d4cc9e1cf5588f6c11fb9f333e88c8325f2b26f698311d63232ea9830cb9e58ed
-  data.tar.gz: 8b128b1f7901e72369d3323d521b9c49b00260fa92a2ac1ccca11b36bce72f0f7e78c0f3876bdb2c01d2cc8e491032599cefc2cd7e022749c25040a11b6948d0
+  metadata.gz: 4a996047c56be2ac33c2000aa8056cdb8905d7c79902d4e5c2a531db24dea3bd39308dd2ae09c2b8d33ed9259761beb0a409cf139c9681a5f477a06bd0053fb0
+  data.tar.gz: a0061994955323c6b4e6ddd89ac588e807adfcb5be02159e4a385daa6a213607190406893e4d932be2c88b38fd61051ccb7574196200a81f26a0c6ebc89aae99

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## [Unreleased]
+## RubyGPT
+
+## [0.1.2] - 2024-08-28
+
+- Fixed unexpected EOF error message when running gem
+- Gem dependency updates
+
+## [0.1.1] - 2024-03-13
+
+- Fixed cost reader in response object
+- Fixed standard response generation from faraday response
+- Fixed a bug in message building from hash contents
+- Gemspec configuration adjustments (license)
 
 ## [0.1.0] - 2024-03-08
 

data/README.md

@@ -94,10 +94,10 @@ After configuring the Rubygpt client, you can perform requests to the Chat Compl
 
 ```ruby
 # Send a message to GPT
-Rubygpt.chat.create("A system of cells interlinked.") # any message you'd like to send
+Rubygpt.chat.create("Where is London?.") # any message you'd like to send
 
 # Send multiple messages
-Rubygpt.chat.create(["Within cells interlinked", "Within cells interlinked", "Within one stem"])
+Rubygpt.chat.create(["Where is UK?", "What Continent?", "What timezone?"])
 ```
 
 To use the received responses, refer to the [Using Chat Completion Responses](#using-chat-completion-responses) section.
@@ -142,14 +142,13 @@ You can send any available request body parameter supported by OpenAI Chat Compl
 
 ```ruby
 Rubygpt.chat.create(
-    n: 5,
-    messages: ["What time is it?"],
+    n: 3,
+    messages: ["Explain the history of Istanbul."],
     model: 'gpt-4-turbo-preview', # overrides your client config when provided explicity here
     max_tokens: 100,
     frequency_penalty: 1.0,
-    tempature: 1,
-    user: 'feapaydin',
-    json: true # DO NOT provide response_format for JSON mode, use this flag
+    temperature: 1,
+    user: 'feapaydin'
 )
 ```
 
@@ -165,16 +164,18 @@ To send a message in JSON mode, you can simply send `json: true` option along wi
 
 ```ruby
 # Single message with JSON mode
-Rubygpt.chat.create(content: "List all programming languages by their creation date.", json: true)
+Rubygpt.chat.create(content: "List all programming languages by their creation date in a json.", json: true)
 
 # Multiple messages with JSON mode
 messages = [
-    { role: 'user', content: "List all programming languages by their creation date." },
-    { role: 'user', content: "Also add their creator's name to the objects." }
+    { role: 'user', content: "List all programming languages by their creation date as JSON." },
+    { role: 'user', content: "Also add their creator's name to the objects to JSON attributes." }
 ]
 Rubygpt.chat.create(messages:, json: true)
 ```
 
+An important note is that the `messages` data must contain the keyword `json` ("explain in JSON format...") when using the JSON mode. This is required by ChatGPT APIs.
+
 ### Stream Mode
 
 Streaming mode is a feature of the Chat Completions API that allows the model to generate a continuous stream of messages. This is useful for chat applications where the model is expected to generate multiple or longer responses to a single prompt.
@@ -202,7 +203,7 @@ Each Choice in the response is an instance of `Response::ChatCompletion::Choice`
 
 ```ruby
 response = Rubygpt.chat.create("What time is it?", "Also tell me the date.")
-response.choices # => [Response::ChatCompletion::Choice, Response::ChatCompletion::Choice]
+response.choices # => [Response::ChatCompletion::Choice]
 response.choices.first.index # => 0
 response.choices.first.message # => <#Common::Message>
 response.choices.first.content # => "It's 12:00 PM." - delegated from message

data/lib/rubygpt/common/message.rb

@@ -6,6 +6,9 @@ module Common
   # Represents a Message object that is used in OpenAI Chat API requests
   # This object is referenced by both ChatRequester and ChatCompletion objects
   class Message
+    # The keys that are used in the request body for messages
+    MESSAGE_REQUEST_KEYS = %i[role content name tool_calls tool_call_id].freeze
+
     # The role of the author of this message.
     # One of: user, assistant, system
     # Default: system

data/lib/rubygpt/connection/faraday.rb

@@ -23,7 +23,9 @@ module Rubygpt
         faraday_response = super(*args)
         Rubygpt::Response::StandardApiResponse.new(
           adapter_response: faraday_response,
-          **faraday_response.slice(:status, :body, :headers)
+          status: faraday_response.status,
+          body: faraday_response.body,
+          headers: faraday_response.headers
         )
       end
     end

data/lib/rubygpt/requester/chat_requester.rb

@@ -37,7 +37,7 @@ module Rubygpt
           # https://platform.openai.com/docs/guides/text-generation/json-mode
           request_body[:response_format] = { type: "json_object" } if args[:json]
           request_body[:messages] = messages_from_hash(args)
-          request_body.merge! args.except(:messages, :json)
+          request_body.merge! args.except(:messages, :json, *Common::Message::MESSAGE_REQUEST_KEYS)
         else
           request_body[:messages] = messages_from_args(args)
         end

data/lib/rubygpt/response/chat_completion.rb

@@ -48,9 +48,6 @@ module Rubygpt
         end
       end
 
-      # Readers for the standard attributes of the ChatCompletion object
-      attr_reader :id, :object, :created, :model, :system_fingerprint, :usage, :choices
-
       # Initializes the ChatCompletion object
       #
       # @param [StandardApiResponse] api_response The response from the API, standardized by the connection object
@@ -76,7 +73,7 @@ module Rubygpt
       end
 
       def cost
-        usage[:total_tokens]
+        usage["total_tokens"] || usage[:total_tokens]
       end
 
       def to_h

data/lib/rubygpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubygpt
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubygpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Furkan Enes Apaydin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,7 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.23.0
-description: ''
+description: |
+  This gem aims to provide an easy-to-use Ruby wrapper for all modules of OpenAI's GPT API.
+  It is designed to be simple and easy to use, while also providing a high level of customization.
+  It is also aiming to work efficiently in Ruby on Rails applications.
 email:
 - feapaydin@gmail.com
 executables: []
@@ -95,7 +98,8 @@ files:
 - lib/rubygpt/version.rb
 - sig/rubygpt.rbs
 homepage: https://github.com/feapaydin/rubygpt
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/feapaydin/rubygpt
   source_code_uri: https://github.com/feapaydin/rubygpt
@@ -115,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for OpenAI's ChatGPT APIs.