chat_gpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ca65fccf7955b7187454c88484a5e1d252767a5349789bf2c8597bc7764f088
+  data.tar.gz: 7ab863283c180354d8aee8aa1d1a2c9a809f4fda77e716f489b5ac8eee954c94
+SHA512:
+  metadata.gz: 4be0031f7a0ea028fafd2cce4eab9c99c562235a14f5f5c3a0bef816e8628b89e54f2c8b47aaf310fcf1fbdbe69a5bba4108a23068e04aff3dea469750afc242
+  data.tar.gz: 6176884544c505114e43d9c8fb580bfc8357599ea379bc23e2d3af42f652531a67bc81a0f6edc23426f746fe44dd8629339630bf37a29ba79da6ed24b25390a9

data/README.md

@@ -0,0 +1,94 @@
+# Chat GPT
+
+This is OpenAI Chat GPT ruby wrapper (beta). Read more <https://beta.openai.com/docs/introduction>
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+  `bundle add chat_gpt`
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+  `gem install chat_gpt`
+
+## Usage
+
+Visit <https://openai.com> to get an API key for the ChatGPT API
+
+```ruby
+# config/initializers/chat_gpt.rb
+ChatGpt.configure do |config|
+  config.key = 'API_KEY'
+end
+```
+
+```ruby
+# Create a new ChatGPT instance with your API key
+chat_gpt = ChatGpt::Api.new
+
+# Send a message to ChatGPT and output the response
+response = chat_gpt.send("Hello, how are you?")
+puts response.inspect
+
+# Send a subsequent message to ChatGPT and connect it to the parent message
+response = chat_gpt.send("That's good to hear. What have you been up to lately?", conversation_id: 'abc123')
+puts response.inspect
+```
+
+The response:
+
+```ruby
+{
+  conversation_id: 'unique_conversation_id',
+  responses: [
+    'An array of messages from ChatGPT'
+  ]
+}
+```
+
+### Parameter: `max_tokens`
+
+In the context of using the ChatGPT API, `max_tokens` refers to the maximum number of tokens (i.e. individual words or punctuation marks) that can be included in each response generated by ChatGPT. This parameter is used to limit the length of the responses generated by ChatGPT and to prevent the API from generating excessively long responses.
+
+By default, the `max_tokens` parameter is set to **100**, which means that ChatGPT will generate responses with a maximum of 100 tokens each. However, you can adjust this parameter when making a request to the API in order to generate longer or shorter responses, depending on your needs.
+
+It's important to note that setting a higher value for max_tokens will not necessarily result in longer responses from ChatGPT. The length of the responses generated by ChatGPT will also depend on the input prompt and the model being used. Additionally, the max_tokens parameter is subject to certain limitations imposed by the API provider, so you should be aware of these limitations when setting this parameter.
+
+### Parameter: `temperature`
+
+In the context of a language model such as ChatGPT, the `temperature` parameter is a value that controls the level of randomness in the model's responses. A higher temperature value will cause the model to generate more diverse and unpredictable responses, while a lower temperature value will cause the model to generate more predictable and repetitive responses.
+
+For example, if you set the temperature parameter to a high value, such as **0.8**, the ChatGPT model will be more likely to generate unique and creative responses to your prompts. This can be useful if you want to explore different ideas or possibilities, or if you want the model to generate more interesting and varied responses.
+
+On the other hand, if you set the temperature parameter to a low value, such as 0.2, the ChatGPT model will be more likely to generate responses that are similar to previous responses and follow predictable patterns. This can be useful if you want the model to generate more consistent and coherent responses, or if you want to control the content of the responses more closely.
+
+Overall, the `temperature` parameter allows you to adjust the level of randomness in the ChatGPT model's responses and fine-tune the output to suit your needs.
+
+### ChatGPT models
+
+The ChatGPT API offers several different models to choose from, each with its own unique characteristics and capabilities. The available models are:
+
+1. `curie`: This model is named after Marie Curie, a famous scientist known for her pioneering work in the field of radioactivity. This model is well-suited for generating responses to scientific or technical prompts.
+2. `ada`: This model is named after Ada Lovelace, a 19th-century mathematician who is considered to be the world's first computer programmer. This model is well-suited for generating responses to mathematical or computational prompts.
+3. `grace`: This model is named after Grace Hopper, a pioneering computer scientist and United States Navy Rear Admiral. This model is well-suited for generating responses to prompts related to computers, technology, or the military.
+4. `flora`: This model is named after Flora Stieglitz, a pioneering photographer who was known for her portraits and landscapes. This model is well-suited for generating responses to prompts related to photography or the arts.
+5. `davinci`: This model is named after Leonardo da Vinci, a famous artist, scientist, and inventor.This model is well-suited for generating responses to prompts that are broad or open-ended in nature.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/dpaluy/chat_gpt. 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/dpaluy/chat_gpt/blob/master/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 chatGpt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dpaluy/chat_gpt/blob/master/CODE_OF_CONDUCT.md).

data/lib/chat_gpt/api.rb

@@ -0,0 +1,37 @@
+module ChatGpt
+  class Api
+    MODELS = %w[
+      curie
+      ada
+      grace
+      flora
+      davinci
+    ].freeze
+
+    attr_reader :connection
+
+    def initialize(params)
+      @connection = ChatGpt::Client.new(params)
+    end
+
+    # rubocop:disable Layout/ArgumentAlignment
+    def send(prompt, model: "curie", num_responses: 1, max_tokens: 100,
+             temperature: 0.5, conversation_id: nil)
+      response = connection.send_message(prompt,
+        model: model, num_responses: num_responses, max_tokens: max_tokens,
+        temperature: temperature, conversation_id: conversation_id)
+
+      parse_resonse(JSON.parse(response.body)["data"])
+    end
+    # rubocop:enable Layout/ArgumentAlignment
+
+    private
+
+    def parse_resonse(response)
+      {
+        conversation_id: response[0]["conversation_id"],
+        responses: response.map { |r| r["response"] }
+      }
+    end
+  end
+end

data/lib/chat_gpt/client.rb

@@ -0,0 +1,34 @@
+require "json"
+require "net/http"
+
+module ChatGpt
+  class Client
+    # Set the URL for the ChatGPT API
+    API_URL = "https://api.openai.com/v1/chatgpt/generate".freeze
+
+    attr_reader :api_key
+
+    # Initialize the class with the API key
+    def initialize(params = {})
+      @api_key = params.fetch(:api_key, ChatGpt.config.key)
+    end
+
+    # Send a message to ChatGPT and return the response and conversation ID
+    def send_message(prompt,
+                     model: "curie", num_responses: 1, max_tokens: 100,
+                     temperature: 0.5, conversation_id: nil)
+      headers = {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{api_key}"
+      }
+
+      body = {
+        prompt: prompt, model: model,
+        num_responses: num_responses, max_tokens: max_tokens,
+        temperature: temperature, conversation_id: conversation_id
+      }.to_json
+
+      Net::HTTP.post(URI(API_URL), body, headers)
+    end
+  end
+end

data/lib/chat_gpt/config.rb

@@ -0,0 +1,20 @@
+require "logger"
+
+module ChatGpt
+  class Config
+    attr_accessor :key
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stderr)
+    end
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/chat_gpt/engine.rb

@@ -0,0 +1,5 @@
+module ChatGpt
+  class Engine < Rails::Engine
+    isolate_namespace ChatGpt
+  end
+end

data/lib/chat_gpt/version.rb

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

data/lib/chat_gpt.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "chat_gpt/config"
+require_relative "chat_gpt/api"
+require_relative "chat_gpt/client"
+require_relative "chat_gpt/engine" if defined?(Rails)
+require_relative "chat_gpt/version"
+
+module ChatGpt
+  class Error < StandardError; end
+
+  def self.logger
+    config.logger
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: chat_gpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dpaluy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-05 00:00:00.000000000 Z
+dependencies: []
+description: This is OpenAI's ChatGPT API wrapper for Ruby.
+email:
+- dpaluy@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/chat_gpt.rb
+- lib/chat_gpt/api.rb
+- lib/chat_gpt/client.rb
+- lib/chat_gpt/config.rb
+- lib/chat_gpt/engine.rb
+- lib/chat_gpt/version.rb
+homepage: https://github.com/dpaluy/chat_gpt
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dpaluy/chat_gpt
+  source_code_uri: https://github.com/dpaluy/chat_gpt
+  changelog_uri: https://github.com/dpaluy/chat_gpt/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: This is OpenAI's ChatGPT API wrapper for Ruby.
+test_files: []