ask_gpt 1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3617b3a4bd76d7a04665514a8958be6d058ccd58b05c091df148f534c656852
+  data.tar.gz: 5d79758f574cbd413dfcaef528dafdf1f4f7ddf70d3ec6f41cd34ca731cd37be
+SHA512:
+  metadata.gz: 645366bfc3b049e401d347912ca8f46795d8309fd91bd95dc8f9ea122de1a5813f47ce17fe5611ea9b507055f0d43e584fb03f10db355b97d44df2a4a601e37b
+  data.tar.gz: 29ac53931e22b55ffd1fad968896bc324fd41622015c2b2bb412273c785cc8c469c7a980a8b44622a3a5e83b5bb915ab324f8fa1854d7561a0efc7f8ee0162a6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ask_gpt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    ask_gpt (1.2)
+      ruby-openai
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    rake (13.0.6)
+    ruby-openai (3.5.0)
+      httparty (>= 0.18.1)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  ask_gpt!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Nuzair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# AskGpt
+
+[![Gem Version](https://badge.fury.io/rb/ask_gpt.svg)](https://badge.fury.io/rb/ask_gpt)
+
+## Introduction
+
+AskGpt is a Ruby Gem that enables users to ask questions to ChatGPT with context.
+
+## Installation
+
+To install AskGpt, add the following line to your Gemfile:
+
+```ruby
+gem 'ask_gpt'
+```
+
+Then run `bundle install` to install the gem.
+
+## Usage
+
+After installation, import AskGpt into your Ruby program:
+
+```ruby
+require 'ask_gpt'
+```
+
+Next, create a new instance of the `AskGpt::GPT` class:
+
+```ruby
+gpt = AskGpt::GPT.new(api_key)
+```
+
+- The `api_key` parameter is required and represents your OpenAI API key. You can get it from [here](https://platform.openai.com/account/api-keys).
+
+- The `model` parameter is optional and represents the GPT model that you want to use. The default value is `gpt-3.5-turbo`. You can use `gpt-4` if you have access to it.
+
+- The `temperature` parameter is also optional and represents the "creativity" of the model's responses. The default value is `0.7`, which should provide a good balance between creativity and accuracy. Value ranges from `0.0 - 1.0` and the higher the value, the more creative the model's responses will be.
+
+- The `unable_to_get_answer_text` parameter is optional and represents the message that will be returned if the model is unable to generate a response. The default value is 'Unable to get answer from ChatGPT. Make sure API key is valid and has enough credits.'
+
+Once you have created a new instance of the GPT class, you can ask questions by calling the `ask` method:
+
+```ruby
+answer = gpt.ask("What is the capital of France?")
+```
+
+The `ask` method takes a single parameter, which is the question that you want to ask the model. If the question is empty, the method will return `nil`. Otherwise, it will use the context of previous questions and answers to generate a response. If the model is unable to generate a response, the `ask` method will return the `unable_to_get_answer_text` message.
+
+If the model is able to generate a response, the `ask` method will return the answer as a string.
+
+## Example
+
+Here's an example of how you can use AskGpt to ask a series of questions and get answers:
+
+```ruby
+require 'ask_gpt'
+
+api_key = 'your_api_key_here'
+gpt = AskGpt::GPT.new(api_key)
+
+questions = [
+  "What is the capital of France?",
+  "Who was the first president of the United States?",
+  "What is the tallest mountain in the world?"
+]
+
+questions.each do |question|
+  answer = gpt.ask(question)
+  puts "Q: #{question}\nA: #{answer}\n\n"
+end
+
+```
+
+In this example, we first create a new instance of the GPT class using our API key. We then define an array of questions that we want to ask the model. Finally, we loop through each question, ask the model for an answer, and print the question and answer to the console.
+
+### Remarks
+
+This readme was generated by ChatGPT with some guidance and modifications.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/ask_gpt.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ask_gpt/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ask_gpt'
+  spec.version = AskGpt::VERSION
+  spec.authors = ['Nuzair46']
+  spec.email = ['nuzer501@gmail.com']
+
+  spec.summary = 'A ruby gem to Interact with OpenAI GPT API with context and history'
+  spec.homepage = 'https://github.com/Nuzair46/ask_gpt'
+
+  spec.license = 'MIT'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Nuzair46/ask_gpt'
+  spec.required_ruby_version = '>= 3.1'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby-openai'
+end

data/lib/ask_gpt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AskGpt
+  VERSION = '1.2'
+end

data/lib/ask_gpt.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'ask_gpt/version'
+require 'ruby/openai'
+
+module AskGpt
+  class GPT
+    attr_accessor :messages, :history, :model, :temperature, :unable_to_get_answer_text, :api_key
+
+    def initialize(api_key, model: 'gpt-3.5-turbo', temperature: 0.7, unable_to_get_answer_text: nil)
+      @api_key = api_key
+      @model = model
+      @temperature = temperature
+      @messages = []
+      @history = []
+      @unable_to_get_answer_text = unable_to_get_answer_text || 'Unable to get answer from ChatGPT. Make sure API key is valid and has enough credits.'
+    end
+
+    def ask(question)
+      return if question.empty?
+
+      replay_history
+      update_messages(question)
+      answer = get_completion
+
+      return unable_to_get_answer_text unless answer
+
+      update_history(question, answer)
+      answer
+    end
+
+    private
+
+    def get_completion
+      response = openai_client.chat(
+        parameters: {
+          model: model,
+          temperature: temperature,
+          messages: messages
+        }
+      )
+      raise StandardError, response['error'] if response['error']
+
+      response.dig('choices', 0, 'message', 'content')
+    end
+
+    def replay_history
+      history.each do |input_text, completion_text|
+        messages.push({ role: 'user', content: input_text })
+        messages.push({ role: 'assistant', content: completion_text })
+      end
+    end
+
+    def update_messages(question)
+      messages.push({ role: 'user', content: question })
+    end
+
+    def update_history(question, answer)
+      history.push([question, answer])
+    end
+
+    def openai_client
+      @_openai_client ||= OpenAI::Client.new(access_token: api_key)
+    end
+  end
+end

data/sig/ask_gpt.rbs

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: ask_gpt
+version: !ruby/object:Gem::Version
+  version: '1.2'
+platform: ruby
+authors:
+- Nuzair46
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  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:
+email:
+- nuzer501@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ask_gpt.gemspec
+- lib/ask_gpt.rb
+- lib/ask_gpt/version.rb
+- sig/ask_gpt.rbs
+homepage: https://github.com/Nuzair46/ask_gpt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Nuzair46/ask_gpt
+  source_code_uri: https://github.com/Nuzair46/ask_gpt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A ruby gem to Interact with OpenAI GPT API with context and history
+test_files: []