chatgpt-ruby 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e959cc78a29b94543ca4a79c21905e11296cd5933b39397a31bdd3652b5bede
-  data.tar.gz: df28d307836ff2e4827f6fa37cd68839cef2089b8418ced1d85f87b6677b98ea
+  metadata.gz: 6a246b757af45ec2b58fd7fad4cda501d6408f273f62c697705a4b85b824c07e
+  data.tar.gz: b314a13e482bf33e88d2dd7adec626850612cb1da247ed0a247492dc40bd09af
 SHA512:
-  metadata.gz: b06065d572303b32d01ce713968d9f92e582309e356061359a2e216f8afef229e7b5c00376ce805ab84d9612d038ec3f60245ed277c8b5ba24395e1ce4b6a020
-  data.tar.gz: 0a251cea4f557f855d3f515e786c875f62c2d2ea76d1c02bfbbcb85b2ed84adcc14cbf4dcd31983b3b8b1d285b3deb32cb9b9ca59dfd5165dfcdfaa3f8d863c9
+  metadata.gz: 2cd02878303337251add7d71e82bd9d29504313217dfeb6bcc2228a9d61f14abe0306523e55374465d431e65f438106b8054936b22d9d2a6de9aaa7b1d1e8a29
+  data.tar.gz: b30e1470736ccfd7ebd26c380792eb1759707bb630bbb3d4ad2dc446968d6e414c3ace6ac3164e7681ff57f07445a50d9025e72b5c497f77e6b3de949a537b79

data/.codeclimate.yml

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

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,12 +1,14 @@
 PATH
   remote: .
   specs:
-    chatgpt-ruby (0.4.0)
+    chatgpt-ruby (0.6.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)
@@ -43,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)
@@ -57,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,56 +1,173 @@
-# ChatGPTRuby
+# ChatGPT Ruby
 
-The `chatgpt-ruby` gem is a simple Ruby SDK for accessing the OpenAI ChatGPT API. This client makes it easy to integrate the ChatGPT API into your Ruby applications.
+[![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)
 
-### Bundler
+The `chatgpt-ruby` is a Ruby SDK for the OpenAI API, including methods for generating text, completing prompts, and more ❤️
+
+## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "chatgpt-ruby"
+gem 'chatgpt-ruby'
 ```
 
+
+
 And then execute:
 
+```ruby
 $ bundle install
+```
 
-### Gem install
 
-Or install with:
 
+Or install it yourself as:
+
+```ruby
 $ gem install chatgpt-ruby
+```
 
 ## Usage
 
-To use the gem in a Ruby script or application, simply require it and initialize the client:
+To use the ChatGPT API SDK, you will need an API key from OpenAI. You can obtain an API key by signing up for the [OpenAI API beta program](https://beta.openai.com/signup/) .
+
+Once you have an API key, you can create a new `ChatGPT::Client` instance with your API key:
+
+```ruby
+require 'chatgpt/client'
+
+api_key = 'your-api-key'
+client = ChatGPT::Client.new(api_key)
+```
+
+
+### Completions
+
+To generate completions given a prompt, you can use the `completions` method:
+
 ```ruby
-require 'chatgpt_client'
+prompt = 'Hello, my name is'
+completions = client.completions(prompt)
 
-client = ChatGPTClient::Client.new('your_api_key')
-response = client.chat('Please translate the following English text to French: "Hello, how are you?"')
-puts response
+# Output: an array of completion strings
 ```
 
-Replace 'your_api_key' with your actual ChatGPT API key.
 
-### Parameters
 
-The `chat` method accepts a mandatory `prompt` parameter and an optional `options` parameter.
+You can customize the generation process by passing in additional parameters as a hash:
+
+```ruby
+params = {
+  engine: 'text-davinci-002',
+  max_tokens: 50,
+  temperature: 0.7
+}
+completions = client.completions(prompt, params)
+
+# 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
+```
 
-The `prompt` parameter is a string representing the input you want to send to the ChatGPT API.
 
-The `options` parameter is a hash that can include the following keys: 
-- `max_tokens`: The maximum number of tokens
+### 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
 
@@ -58,4 +175,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,23 +1,119 @@
-# lib/chatgpt_api.rb
+# lib/chatgpt/client.rb
 
 require 'rest-client'
+require 'json'
 
-module ChatgptRuby
+module ChatGPT
   class Client
     def initialize(api_key)
       @api_key = api_key
-      @endpoint = 'https://api.chatgpt.com'
+      @endpoint = 'https://api.openai.com/v1'
     end
 
-    # Methods for accessing the API here
-    def generate_response(prompt)
-      url = "#{@endpoint}/generate"
-      params = {
+    # Helper method to prepare headers
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
+
+    # Completion-related methods
+    def completions(prompt, params = {})
+      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
+
+      url = "#{@endpoint}/engines/#{engine}/completions"
+      data = {
+        prompt: prompt,
+        max_tokens: max_tokens,
+        temperature: temperature,
+        top_p: top_p,
+        n: n
+      }
+      request_api(url, data)
+    end
+
+    # Search-related methods
+    def search(documents, query, params = {})
+      engine = params[:engine] || 'ada'
+      max_rerank = params[:max_rerank] || 200
+
+      url = "#{@endpoint}/engines/#{engine}/search"
+      data = {
+        documents: documents,
+        query: query,
+        max_rerank: max_rerank
+      }
+      response = request_api(url, data)
+      response['data']
+    end
+
+    # Classification-related methods
+    def classify(text, params = {})
+      model = params[:model] || 'text-davinci-002'
+
+      url = "#{@endpoint}/classifications/#{model}"
+      data = {
+        model: model,
+        input: text
+      }
+      response = request_api(url, data)
+      response['data'][0]['label']
+    end
+
+    # Summary-related methods
+    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"
+      data = {
+        prompt: '',
+        max_tokens: max_tokens,
+        temperature: temperature,
+        top_p: top_p,
+        frequency_penalty: frequency_penalty,
+        presence_penalty: presence_penalty,
+        documents: documents
+      }
+      response = request_api(url, data)
+      response['choices'][0]['text']
+    end
+
+    # Answer-generation-related methods
+    def generate_answers(prompt, documents, params = {})
+      model = params[:model] || 'text-davinci-002'
+      max_tokens = params[:max_tokens] || 5
+
+      url = "#{@endpoint}/engines/#{model}/answers"
+      data = {
         prompt: prompt,
-        api_key: @api_key
+        documents: documents,
+        max_tokens: max_tokens
       }
-      response = RestClient.get(url, params: params)
-      JSON.parse(response.body)
+      response = request_api(url, data)
+      response['data'][0]['answer']
+    end
+
+    private
+
+    # Helper method to make API requests
+    def request_api(url, data)
+      begin
+        response = RestClient.post(url, data.to_json, headers)
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        error_msg = JSON.parse(e.response.body)['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.1.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,22 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
-dependencies: []
-description: Write a longer description or delete this line.
+date: 2023-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a Ruby SDK for interacting with the OpenAI API, including
+  methods for generating text, completing prompts, and more.
 email:
 - nagendra.dhanakeerthi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -29,10 +45,13 @@ files:
 - lib/chatgpt/ruby.rb
 - lib/chatgpt/ruby/version.rb
 - sig/chatgpt/ruby.rbs
-homepage:
+homepage: https://github.com/nagstler/chatgpt-ruby.git
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/nagstler/chatgpt-ruby.git
+  source_code_uri: https://github.com/nagstler/chatgpt-ruby.git
+  changelog_uri: https://github.com/nagstler/chatgpt-ruby/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -51,5 +70,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A Ruby SDK for the OpenAI API
 test_files: []