chatgpt-ruby 0.6.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa91296be7cab7d9f1f5f1b2b6e55fa784c4a8760fabebbaac3cf903268da1d
-  data.tar.gz: cd8a13397002dec2a38da0ad766ce3b9301ca3d6bc5efa2669b30851d3ebc4ca
+  metadata.gz: 9ab25c3c1b76e0b3249dbeba1c4b0772c4c6f7d34580005f3888ff09c2829453
+  data.tar.gz: 3feffdb2bed24d6464bdd945b6a94abb1a752567fac19d2866b5430dfffda019
 SHA512:
-  metadata.gz: adf9e9cdc0e6b3e834d86e388b2c6319a42292c302333cc4a039817c9b4136e1394e00dff859c9f2359674728bf550171a22d64387089accdf48aed2d023658f
-  data.tar.gz: f1d0932b4ad810440543fa9b538a52190f6355ef892356519373748eb002f94a4d3de35f234fbd120c0bcd959b1f609fd6f35bbd27cd2125009a0b84e11dd8bd
+  metadata.gz: d42c42272c0f17cecc040f2796f08181cc858b744a5fbf33d6a26c31aa8990352b6f022832a6b9b61d25cf9b8577939783a93ce6e250a3c4458dfec16d4d43f1
+  data.tar.gz: f9a3cd15ff2901c09361ba53dd71d3ea7263669069126672b390444b11a8d660805cb34a7ea71b792afd5208c6971c3d374d58e3bb74fe2cccbc4af3a23baa5d

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+version: "2"
+checks:
+  rubocop:
+    enabled: true
+    channel: "stable"
+plugins:
+  test-reporter:
+    enabled: true

data/CHANGELOG.md

@@ -1,5 +1,13 @@
+## [1.0.0] - 2023-04-30
+
+### Added
+
+- Initial release of the `chatgpt-ruby` gem.
+- 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/Gemfile

@@ -11,4 +11,11 @@ gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
 
-gem 'rest-client'
+gem 'rest-client'
+
+group :test do
+    gem 'simplecov', require: false
+    gem 'simplecov_json_formatter', require: false
+end
+  
+  

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    chatgpt-ruby (0.6.0)
+    chatgpt-ruby (1.0.0)
       rest-client
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     http-accept (1.7.0)
@@ -44,6 +45,12 @@ GEM
     rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
@@ -58,6 +65,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rest-client
   rubocop (~> 1.21)
+  simplecov
+  simplecov_json_formatter
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -1,6 +1,8 @@
-# ChatGPTRuby
+# ChatGPT Ruby
 
-The `chatgpt-ruby` is a Ruby SDK for the OpenAI API, including methods for generating text, completing prompts, and more.
+[![Gem Version](https://badge.fury.io/rb/chatgpt-ruby.svg)](https://badge.fury.io/rb/chatgpt-ruby) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Maintainability](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/maintainability)](https://codeclimate.com/github/nagstler/chatgpt-ruby/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/test_coverage)](https://codeclimate.com/github/nagstler/chatgpt-ruby/test_coverage) [![CI](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml) [![GitHub contributors](https://img.shields.io/github/contributors/nagstler/chatgpt-ruby)](https://github.com/nagstler/chatgpt-ruby/graphs/contributors)
+
+The `chatgpt-ruby` is a Ruby SDK for the OpenAI API, providing methods for generating text and completing prompts using the ChatGPT model.
 
 ## Installation
 
@@ -10,16 +12,12 @@ Add this line to your application's Gemfile:
 gem 'chatgpt-ruby'
 ```
 
-
-
 And then execute:
 
 ```ruby
 $ bundle install
 ```
 
-
-
 Or install it yourself as:
 
 ```ruby
@@ -33,14 +31,13 @@ To use the ChatGPT API SDK, you will need an API key from OpenAI. You can obtain
 Once you have an API key, you can create a new `ChatGPT::Client` instance with your API key:
 
 ```ruby
-require 'chatgpt_api'
+require 'chatgpt/client'
 
 api_key = 'your-api-key'
 client = ChatGPT::Client.new(api_key)
 ```
 
-
-### Completions
+## Completions
 
 To generate completions given a prompt, you can use the `completions` method:
 
@@ -51,8 +48,6 @@ completions = client.completions(prompt)
 # Output: an array of completion strings
 ```
 
-
-
 You can customize the generation process by passing in additional parameters as a hash:
 
 ```ruby
@@ -63,109 +58,19 @@ params = {
 }
 completions = client.completions(prompt, params)
 
+puts completions["choices"].map { |c| c["text"] }
 # Output: an array of completion strings
 ```
 
-
-### Search
-
-To perform a search query given a set of documents and a search query, you can use the `search` method:
-
-```ruby
-documents = ['Document 1', 'Document 2', 'Document 3']
-query = 'Search query'
-results = client.search(documents, query)
-
-# Output: an array of search result objects
-```
-
-
-
-You can customize the search process by passing in additional parameters as a hash:
-
-```ruby
-params = {
-  engine: 'ada',
-  max_rerank: 100
-}
-results = client.search(documents, query, params)
-
-# Output: an array of search result objects
-```
-
-
-### Classify
-
-To classify a given text, you can use the `classify` method:
-
-```ruby
-text = 'This is a sample text'
-label = client.classify(text)
-
-# Output: a string representing the classified label
-```
-
-
-
-You can customize the classification process by passing in additional parameters as a hash:
-
-```ruby
-params = {
-  model: 'text-davinci-002'
-}
-label = client.classify(text, params)
-
-# Output: a string representing the classified label
-```
-
-
-### Generate Summaries
-
-To generate summaries given a set of documents, you can use the `generate_summaries` method:
-
-```ruby
-documents = ['Document 1', 'Document 2', 'Document 3']
-summary = client.generate_summaries(documents)
-
-# Output: a string representing the generated summary
-```
-
-
-
-You can customize the summary generation process by passing in additional parameters as a hash:
-
-```ruby
-params = {
-  model: 'text-davinci-002',
-  max_tokens: 100
-}
-summary = client.generate_summaries(documents, params)
-
-# Output: a string representing the generated summary
-```
-
-
-### Generate Answers
-
-To generate answers given a prompt and a set of documents, you can use the `generate_answers` method:
-
-```ruby
-prompt = 'What is the capital of France?'
-documents = ['France is a country in Europe', 'Paris is the capital of France']
-answer = client.generate_answers(prompt, documents)
-
-# Output
-```
-
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chatgpt-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nagstler/chatgpt-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nagstler/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -173,4 +78,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Chatgpt::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Chatgpt::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nagstler/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -3,8 +3,10 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
   t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
 end
@@ -14,3 +16,4 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]
+

data/lib/chatgpt/client.rb

@@ -1,27 +1,45 @@
-# lib/chatgpt/client.rb
-
 require 'rest-client'
 require 'json'
 
 module ChatGPT
   class Client
+    # Initialize the client with the API key
+    #
+    # @param api_key [String] The API key for the GPT-3 service
     def initialize(api_key)
       @api_key = api_key
+      # Base endpoint for the OpenAI API
       @endpoint = 'https://api.openai.com/v1'
     end
 
+    # Prepare headers for the API request
+    #
+    # @return [Hash] The headers for the API request
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
+
+    # Generate completions based on a given prompt
+    #
+    # @param prompt [String] The prompt to be completed
+    # @param params [Hash] Additional parameters for the completion request
+    #
+    # @return [Hash] The completion results from the API
     def completions(prompt, params = {})
+      # Set default parameters
       engine = params[:engine] || 'text-davinci-002'
       max_tokens = params[:max_tokens] || 16
       temperature = params[:temperature] || 0.5
       top_p = params[:top_p] || 1.0
       n = params[:n] || 1
 
+      # Construct the URL for the completion request
       url = "#{@endpoint}/engines/#{engine}/completions"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
+      
+      # Prepare the data for the request
       data = {
         prompt: prompt,
         max_tokens: max_tokens,
@@ -29,86 +47,36 @@ module ChatGPT
         top_p: top_p,
         n: n
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)
+      
+      # Make the request to the API
+      request_api(url, data)
     end
 
-    def search(documents, query, params = {})
-      engine = params[:engine] || 'ada'
-      max_rerank = params[:max_rerank] || 200
-
-      url = "#{@endpoint}/engines/#{engine}/search"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
-      data = {
-        documents: documents,
-        query: query,
-        max_rerank: max_rerank
-      }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data']
-    end
-
-    def classify(text, params = {})
-      model = params[:model] || 'text-davinci-002'
-
-      url = "#{@endpoint}/classifications/#{model}"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
-      data = {
-        model: model,
-        input: text
-      }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data'][0]['label']
-    end
-
-    def generate_summaries(documents, params = {})
-      model = params[:model] || 'text-davinci-002'
-      max_tokens = params[:max_tokens] || 60
-      temperature = params[:temperature] || 0.5
-      top_p = params[:top_p] || 1.0
-      frequency_penalty = params[:frequency_penalty] || 0.0
-      presence_penalty = params[:presence_penalty] || 0.0
-
-      url = "#{@endpoint}/engines/#{model}/generate"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
-      data = {
-        prompt: '',
-        max_tokens: max_tokens,
-        temperature: temperature,
-        top_p: top_p,
-        frequency_penalty: frequency_penalty,
-        presence_penalty: presence_penalty,
-        documents: documents
-      }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['choices'][0]['text']
-    end
-
-    def generate_answers(prompt, documents, params = {})
-      model = params[:model] || 'text-davinci-002'
-      max_tokens = params[:max_tokens] || 5
-
-      url = "#{@endpoint}/engines/#{model}/answers"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
-      data = {
-        prompt: prompt,
-        documents: documents,
-        max_tokens: max_tokens
-      }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data'][0]['answer']
+    private
+    # Make a request to the API
+    #
+    # @param url [String] The URL for the request
+    # @param data [Hash] The data to be sent in the request
+    # @param method [Symbol] The HTTP method for the request (:post by default)
+    #
+    # @return [Hash] The response from the API
+    #
+    # @raise [RestClient::ExceptionWithResponse] If the API request fails
+    def request_api(url, data, method = :post)
+      begin
+        # Execute the request
+        response = RestClient::Request.execute(method: method, url: url, payload: data.to_json, headers: headers)
+        
+        # Parse and return the response body
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        # Parse the error message from the API response
+        error_msg = JSON.parse(e.response.body)['error']['message']
+        
+        # Raise an exception with the API error message
+        raise RestClient::ExceptionWithResponse.new("#{e.message}: #{error_msg} (#{e.http_code})"), nil, e.backtrace
+      end
     end
+  
   end
 end

data/lib/chatgpt/ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md