rubyai 0.3.1 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387f6d1b2686f5605793b342f64de039e2510d2678f33568216e80db7ea48582
-  data.tar.gz: 3224788966e4af7d6ed44987616561bfde72f649cde944a0dab594c64f50c88a
+  metadata.gz: 4b9da34a736ede8391653fcbd4cb79915f7bca92453e643a9cba365805170053
+  data.tar.gz: db62c0c8fd350117bdfd4f612ab884a741d7253932e649ce8b66e5c61418d09b
 SHA512:
-  metadata.gz: 84c4e0354f8aa8c30322c088dae333104068ea23aff9530a7ff222b30f4d5c14b563da13ddee527ce989512d8b2296f8239ad384d9cd7df38295348eb3a1961e
-  data.tar.gz: 506a3f86bf010e48d2b4e8c7567d948664a5bda8eb9e7f743bab11d5b324850802161a8967d10575d7872da7ef0437ef2ac5cdf663b80d988cc1e60043dfcf76
+  metadata.gz: 056ecb00899c57c51bbf65c8846cf6dc089025963e5693edc2b6722a6ff0c7e0338fb71034490c8254de8df169e9bd70d66daea3ef95d0a6b99fdc95520152aa
+  data.tar.gz: f4ee20d2aa5fa24b9071108b37d81d40fca9e055531f20a4297c8dab80da47cc37e62da2365c8870d2210b2cb850178db15a42f3ea018afde814bf3e8eb12fbe

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.3.2] - 2024-11-21
+
+### Added
+
+- Update Gemspec and dependencies
+
+## [0.3] - 2024-11-21
+
+### Added
+
+- gpt-4-turbo
+- gpt-4o-mini
+- o1-mini
+- o1-preview
+
+- Remove outdated GPT 3.5 models
+
+## [0.2] - 2024-04-20
+
+### Added
+
+- New version
+
+## [0.1.0] - 2024-01-21
+
+### Added
+
+- Github Action
+- Faraday gem
+
+## [0.0.3] - 2024-02-22
+
+### Added
+
+- Rubocop gem
+
+## [0.0.2] - 2024-02-23
+
+### Added
+
+- Models GPT-4
+
+## [0.0.1] - 2023-03-20
+
+### Added
+
+- Initialise repository.
+- Add RubyAI::Client to connect to OpenAI API using user credentials.
+
+
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Shapalov
+
+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,107 @@
+# RubyAI - OpenAI integration Ruby gem
+
+[![Gem Version](https://badge.fury.io/rb/rubyai.svg)](https://badge.fury.io/rb/rubyai)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexshapalov/rubyai/blob/main/LICENSE)
+
+## Use the [OpenAI API 🤖 ](https://openai.com/blog/openai-api/) with Ruby! ❤️
+
+Generate text with ChatGPT (Generative Pre-trained Transformer)
+
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rubyai"
+```
+
+And then execute:
+
+    $ bundle install
+
+
+Or install with:
+
+    $ gem install rubyai
+
+and require with:
+
+```ruby
+require "rubyai"
+```
+
+# Usage
+
+- Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
+
+- If you belong to multiple organizations, you can get your Organization ID from [https://beta.openai.com/account/org-settings](https://beta.openai.com/account/org-settings)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+result = RubyAI::Client.new(access_token, messages).call
+```
+
+### ChatGPT
+
+ChatGPT is a conversational-style text generation model.
+You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+
+```ruby
+api_key = "YOUR API KEY"
+messages = "Who is the best chess player in history?"
+
+result = RubyAI::Client.new(api_key, messages, model: "gpt-4").call
+puts result.dig("choices", 0, "message", "content")
+
+# => As an AI language model, I do not have personal opinions, but according to historical records, Garry Kasparov is often considered as one of the best chess players in history. Other notable players include Magnus Carlsen, Bobby Fischer, and Jose Capablanca.
+```
+
+You can also pass client variables using the configuration file.
+Create configruation file like on example:
+```ruby
+configuration = RubyAI::Configuration.new("YOUR API KEY", "Who is the best chess player in history?")
+client = RubyAI::Client.new(configuration)
+result = client.call
+puts result.dig("choices", 0, "message", "content")
+```
+
+Also (mostly) if you are using Rails you can use configure method:
+```ruby
+RubyAI.configure do |config|
+  config.api_key = "YOUR API KEY"
+  config.messages = "Who is the best chess player in history?"
+  config.model = "gpt-4o-mini"
+end
+```
+
+## Models 
+
+We support all popular GPT models:
+
+gpt-4-turbo: A powerful variant of GPT-4 optimized for efficiency and speed, perfect for high-demand tasks.
+
+gpt-4o-mini: A streamlined version of GPT-4, designed to provide a balance between performance and resource efficiency.
+
+o1-mini: A compact, yet effective model that is well-suited for lightweight tasks.
+
+o1-preview: A preview version of the o1 model, offering insights into upcoming advancements and features.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can 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`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/alexshapalov/rubyai>. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rubyai/client.rb

@@ -0,0 +1,27 @@
+module RubyAI
+  class Client
+    attr_reader :configuration
+
+    def initialize(config_hash = {})
+      @configuration = Configuration.new(config_hash)
+    end
+
+    def call
+      response = connection.post do |req|
+        req.url Configuration::BASE_URL
+        req.headers.merge!(HTTP.build_headers(configuration.api_key))
+        req.body = HTTP.build_body(configuration.messages, configuration.model, configuration.temperature).to_json
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/rubyai/configuration.rb

@@ -0,0 +1,34 @@
+module RubyAI
+  class Configuration
+    BASE_URL = "https://api.openai.com/v1/chat/completions"
+
+    MODELS = {
+      "gpt-4" => "gpt-4",
+      "gpt-4-32k" => "gpt-4-32k",
+      "gpt-4-turbo" => "gpt-4-turbo",
+      "gpt-4o-mini" => "gpt-4o-mini",
+      "o1-mini" => "o1-mini",
+      "o1-preview" => "o1-preview",
+      "text-davinci-003" => "text-davinci-003"
+    }
+
+    DEFAULT_MODEL = "gpt-3.5-turbo"
+
+    attr_accessor :api_key, :model, :messages, :temperature
+
+    def initialize(config = {})
+      @api_key = config[:api_key]
+      @model = config.fetch(:model, DEFAULT_MODEL)
+      @messages = config.fetch(:messages, nil)
+      @temperature = config.fetch(:temperature, 0.7)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/rubyai/http.rb

@@ -0,0 +1,20 @@
+module RubyAI
+  module HTTP
+    extend self
+
+    def build_body(messages, model, temperature)
+      {
+        'model': Configuration::MODELS[model],
+        'messages': [{ "role": "user", "content": messages }],
+        'temperature': temperature
+      }
+    end
+
+    def build_headers(api_key)
+      {
+        'Content-Type': 'application/json',
+        'Authorization': "Bearer #{api_key}"
+      }
+    end
+  end
+end

data/lib/rubyai/version.rb

@@ -0,0 +1,3 @@
+module RubyAI
+  VERSION = "0.1.0".freeze
+end

data/lib/rubyai.rb

@@ -1,6 +1,10 @@
 require_relative "rubyai/client"
 require_relative "rubyai/configuration"
+require_relative "rubyai/http"
+require_relative "rubyai/version"
+
+require 'faraday'
 
 module RubyAI
   class Error < StandardError; end
-end
+end

metadata

@@ -1,35 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: rubyai
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: '0.4'
 platform: ruby
 authors:
 - Alex Shapalov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2024-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: RubyAI is a wrapper for the OpenAI API that allows you to interact with
+  GPT-3 and GPT-4 from within Ruby applications. It provides simple methods for integrating
+  language model capabilities into your Ruby projects.
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - lib/rubyai.rb
+- lib/rubyai/client.rb
+- lib/rubyai/configuration.rb
+- lib/rubyai/http.rb
+- lib/rubyai/version.rb
 homepage: https://github.com/alexshapalov/rubyai
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/alexshapalov/rubyai
+  changelog_uri: https://github.com/alexshapalov/rubyai/CHANGELOG.md
+  documentation_uri: https://github.com/alexshapalov/rubyai#readme
 post_install_message:
 rdoc_options: []
 require_paths:
-- lib
+- "."
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,5 +79,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: A Ruby gem for the OpenAI (GPT-3 and GPT-4) API
+summary: A Ruby gem for the OpenAI (GPT-4) API
 test_files: []