openai_chatgpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a7ddb611ab54537073b7230cd837cba5baa8db5a604a188cdddeda168638d3
+  data.tar.gz: da5d5bfc63d3065eedaa0380de6bbeb6948744ea611c5597efb84bfce8e8e5a8
+SHA512:
+  metadata.gz: e4dc88f770b1d259922afa8c4136f69db7996374a0fa85befad81b9a3864f353f13eb9cc8eef507c244660112a368cec1ff69df83be021b5b3185312aef5c53d
+  data.tar.gz: 0cc811e6103078c8ba3a950f7c76cc25273a20b818a932d185c6e7dfe903375fea3c02f5fbea07e3858e67780d392eae08c0aa3f7e6470af8fa10b36c2010f6c

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Lint/RedundantCopDisableDirective:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [0.1.0] - 2022-03-06
+
+- Initial release
+- added `completions` method

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sulman@hey.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openai-chatgpt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    openai_chatgpt (0.1.0)
+      faraday (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.47.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.12.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  openai_chatgpt!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,108 @@
+# OpenaiChatgpt
+
+OpenAI ChatGPT API is a light-weight Ruby wrapper for the Rubyists. It gives nice struct objects for adresses, even the raw responses are returned in nice open struct objects. It uses Faraday for HTTP requests.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add openai_chatgpt
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install openai_chatgpt
+
+---
+
+## Usage
+
+### API Documentation
+
+The API documentation can be found at [https://platform.openai.com/docs/api-reference/chat/create](https://platform.openai.com/docs/api-reference/chat/create).
+
+### Get an API key
+You can get API for the chatgpt by doing the following [here](https://platform.openai.com/account/api-keys).
+
+### Configuration
+
+```ruby
+require 'openai_chatgpt'
+client = OpenaiChatgpt::Client.new(api_key: ENV['CHATGPT_API_KEY'])
+```
+Params:
+- `api_key`: String - Required - The API key for the openai chatgpt api.
+
+Response:
+```ruby
+#<OpenaiChatgpt::Client:0x00000001055fc318 @adapter=:net_http, @api_key="YOUR_API_KEY", @stubs=nil>
+```
+
+### Get completion text
+
+```ruby
+resp = OpenaiChatgpt::Client.new(api_key: "fake").completions(
+  messages: [
+    {role: "user", content: "Hello, how are you?"},
+    {role: "assistant", content: "I am good, how are you?"},
+    {role: "user", content: "What is your name?"},
+  ]
+)
+```
+Params:
+- messages: Array[String] - Required - Messages to generate response for
+   `[{role: "user", text: "Hello"}, {role: "bot", text: "Hi"}]`
+- model: String - Optional - Default: "gpt-3.5-turbo" - Model to use for generating response
+   ["gpt-3.5-turbo", "gpt-3.5-turbo-0301"]
+- temperature: Float - Optional - Default: 1.0 - Temperature for response generation between 0.0 and 2.0
+- top_p: Float - Optional - Default: 1.0 - Top p for response generation between 0.0 and 1.0
+- n: Integer - Optional - Default: 1 - Number of responses to generate
+- stream: Boolean - Optional - Default: false - Stream response
+- stop: Array[String] - Optional - Default: nil - Stop sequence for response generation
+- max_tokens: Integer - Optional - Default: 4096 - Maximum number of tokens to generate
+- presence_penalty: Float - Optional - Default: 0.0 - Presence penalty for response generation between -2.0 and 2.0
+- frequency_penalty: Float - Optional - Default: 0.0 - Frequency penalty for response generation between
+   -2.0 and 2.0
+- logit_bias: Hash - Optional - Default: nil - Logit bias for response generation
+- user: String - Optional - Default: nil - User for response generation
+
+Response:
+```ruby
+resp.results
+=> [#<OpenaiChatgpt::Choice:0x0000000107abca68 @content="I am an AI language model created by Open", @index=0, @role="assistant">]
+```
+```ruby
+resp.usage
+=> #<OpenaiChatgpt::Usage:0x0000000107aba808 @completion_tokens=10, @prompt_tokens=36, @total_tokens=46>
+```
+
+> Also `raw_response` is available if you want the raw response from the API. This is useful if you want to do something with the raw response. Also that response is in OpenStruct Object which is a nice wrapper for the raw response and you can use 'dot' notation.
+
+### Error Handling
+
+```ruby
+begin
+  client.completions(messages: [{role: "user", text: "Hello, how are you?"}]) # this should be content instead of text
+rescue OpenaiChatgpt::Error => e
+  puts e.message
+end
+```
+
+---
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openai_chatgpt. 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]/openai_chatgpt/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenaiChatgpt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openai_chatgpt/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :console do
+  exec "irb -I lib -r openai_chatgpt.rb"
+end
+
+task default: %i[test rubocop]

data/lib/openai_chatgpt/choice.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenaiChatgpt
+  # @note: This class is the choice response object.
+  class Choice
+    attr_reader :content, :index, :role
+
+    def initialize(obj)
+      @content = obj.message.content
+      @index = obj.index
+      @role = obj.message.role
+    end
+  end
+end

data/lib/openai_chatgpt/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OpenaiChatgpt
+  # Client having API methods and api_key
+  class Client
+    # Base url for OpenAI ChatGPT API
+    BASE_URL = "https://api.openai.com/v1/chat/completions"
+    attr_reader :api_key, :adapter
+
+    # #### Params:
+    # api_key: String - Required - API key for OpenAI ChatGPT API (https://platform.openai.com/account/api-keys)
+    # adapter: Symbol - Optional - Default: :net_http - Adapter for Faraday connection
+    # stubs: Faraday::Adapter::Test::Stubs - Optional - Default: nil - Stubs for Faraday connection
+    # #### Example:
+    # client = OpenaiChatgpt::Client.new api_key: "test"
+    # #### Description:
+    # Client for OpenAI ChatGPT API
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    # #### Params:
+    # messages: Array[String] - Required - Messages to generate response for
+    #   [{role: "user", text: "Hello"}, {role: "bot", text: "Hi"}]
+    # model: String - Optional - Default: "gpt-3.5-turbo" - Model to use for generating response
+    #   ["gpt-3.5-turbo", "gpt-3.5-turbo-0301"]
+    # temperature: Float - Optional - Default: 1.0 - Temperature for response generation between 0.0 and 2.0
+    # top_p: Float - Optional - Default: 1.0 - Top p for response generation between 0.0 and 1.0
+    # n: Integer - Optional - Default: 1 - Number of responses to generate
+    # stream: Boolean - Optional - Default: false - Stream response
+    # stop: Array[String] - Optional - Default: nil - Stop sequence for response generation
+    # max_tokens: Integer - Optional - Default: 4096 - Maximum number of tokens to generate
+    # presence_penalty: Float - Optional - Default: 0.0 - Presence penalty for response generation between -2.0 and 2.0
+    # frequency_penalty: Float - Optional - Default: 0.0 - Frequency penalty for response generation between
+    #   -2.0 and 2.0
+    # logit_bias: Hash - Optional - Default: nil - Logit bias for response generation
+    # user: String - Optional - Default: nil - User for response generation
+    # #### Example:
+    # OpenaiChatgpt::Client.new(api_key: "fake")
+    #   .completions(messages: [{role: "user", content: "Hello"}, {role: "assistant", content: "Hi"}])
+
+    # #### Description:
+    # completions method for OpenAI ChatGPT API
+    # #### Response:
+    # Response object with choices
+    # #### Error:
+    # OpenaiChatgpt::Error
+    def completions( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      messages:,
+      model: "gpt-3.5-turbo",
+      temperature: 1.0,
+      top_p: 1.0,
+      n: 1, # rubocop:disable Naming/MethodParameterName
+      stream: false,
+      stop: nil,
+      max_tokens: 2000,
+      presence_penalty: 0,
+      frequency_penalty: 0,
+      logit_bias: {},
+      user: ""
+    )
+      Response.new post("", {
+        model: model,
+        messages: messages,
+        temperature: temperature,
+        top_p: top_p,
+        n: n,
+        stream: stream,
+        stop: stop,
+        max_tokens: max_tokens,
+        presence_penalty: presence_penalty,
+        frequency_penalty: frequency_penalty,
+        logit_bias: logit_bias,
+        user: user
+      }.to_json)
+    end
+
+    private
+
+    # makes a get request to the given path with params
+    def post(path, params = {})
+      handle_response connection.post(path, params)
+    end
+
+    # handles the response from the api and raises error if any
+    # returns the response if no error
+    # Error codes: https://platform.openai.com/docs/guides/error-codes/api-errors
+    def handle_response(response)
+      return response if response.status == 200
+
+      raise Error, "#{response.status}: #{response.body["error"]["message"]}"
+    end
+
+    # creates a faraday connection with base url and api_key
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers["Authorization"] = "Bearer #{@api_key}"
+        conn.headers["Content-Type"] = "application/json"
+
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/openai_chatgpt/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenaiChatgpt
+  class Error < StandardError; end
+end

data/lib/openai_chatgpt/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module OpenaiChatgpt
+  # OpenStruct object for OpenaiChatgpt
+  class Object < OpenStruct # rubocop:disable Style/OpenStructUse
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash) # rubocop:disable Style/CaseLikeIf
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h) # rubocop:disable Style/HashTransformValues, Style/OpenStructUse, Style/MapToHash
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/openai_chatgpt/response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenaiChatgpt
+  # Response object formatted from OpenaiChatgpt response
+  class Response
+    attr_reader :raw_response, :results, :usage
+
+    def initialize(response)
+      @raw_response = Object.new response.body
+      @results = @raw_response.choices.map { |choice| Choice.new choice }
+      @usage = Usage.new @raw_response.usage
+    end
+  end
+end

data/lib/openai_chatgpt/usage.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenaiChatgpt
+  # Address object
+  class Usage
+    attr_reader :prompt_tokens, :completion_tokens, :total_tokens
+
+    def initialize(obj)
+      @prompt_tokens = obj.prompt_tokens
+      @completion_tokens = obj.completion_tokens
+      @total_tokens = obj.total_tokens
+    end
+  end
+end

data/lib/openai_chatgpt/version.rb

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

data/lib/openai_chatgpt.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "openai_chatgpt/version"
+require "faraday"
+
+# @note: This is a wrapper for the OpenAI Chat GPT API.
+module OpenaiChatgpt
+  autoload :Error, "openai_chatgpt/error"
+  autoload :Client, "openai_chatgpt/client"
+  autoload :Object, "openai_chatgpt/object"
+  autoload :Response, "openai_chatgpt/response"
+  autoload :Usage, "openai_chatgpt/usage"
+  autoload :Choice, "openai_chatgpt/choice"
+end

data/sig/openai_chatgpt.rbs

@@ -0,0 +1,4 @@
+module OpenaiChatgpt
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: openai_chatgpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sulman Baig
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+description: OpenAI ChatGPT API is a light-weight Ruby wrapper for the Rubyists. gpt-3.5-turbo,  gpt-3.5-turbo-0301.
+  You can use this gem to generate text using OpenAI's ChatGPT chat responses API.
+email:
+- sulman@hey.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/openai_chatgpt.rb
+- lib/openai_chatgpt/choice.rb
+- lib/openai_chatgpt/client.rb
+- lib/openai_chatgpt/error.rb
+- lib/openai_chatgpt/object.rb
+- lib/openai_chatgpt/response.rb
+- lib/openai_chatgpt/usage.rb
+- lib/openai_chatgpt/version.rb
+- sig/openai_chatgpt.rbs
+homepage: https://github.com/sulmanweb/openai_chatgpt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sulmanweb/openai_chatgpt
+  source_code_uri: https://github.com/sulmanweb/openai_chatgpt
+  changelog_uri: https://github.com/sulmanweb/openai_chatgpt/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: OpenAI ChatGPT API is a light-weight Ruby wrapper for the Rubyists. gpt-3.5-turbo,
+  gpt-3.5-turbo-0301
+test_files: []