ruby-advanced-openai 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebf6f6a2c422f1842883062ffe4e6dcc3315ed79323f126ebf1c759d005d68f4
+  data.tar.gz: fc2be4ce29643e0f38a67adda1488364f2f280a139e66b8a484548f4ac97c5ac
+SHA512:
+  metadata.gz: '06879b030e8f7b254101db3e1b11ca024471dc3491ee853552a167e4768529045761860c8d177fb7075e66af52c4a87b6816a193e1fd8abaf04b73ca64d945c1'
+  data.tar.gz: '0028141fb741a851be88708ffa2c4eaffa0fd91470d45995f6b99a1297c411d16a387543f11849ee78602599746f63691b8aa003c43e78dde9c6aa5a8ba0784e'

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1 # Use 2.1 to enable using orbs and other features.
+
+# Declare the orbs that we'll use in our config.
+orbs:
+  ruby: circleci/ruby@1.0
+
+jobs:
+  rubocop:
+    parallelism: 1
+    docker:
+      - image: cimg/ruby:3.1-node
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      ruby-image:
+        type: string
+    parallelism: 1
+    docker:
+      - image: << parameters.ruby-image >>
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run tests
+          command: bundle exec rspec -fd
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - rubocop
+      - test:
+          matrix:
+            parameters:
+              ruby-image:
+                - cimg/ruby:2.6-node
+                - cimg/ruby:2.7-node
+                - cimg/ruby:3.0-node
+                - cimg/ruby:3.1-node
+                - cimg/ruby:3.2-node

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: webmock
+    versions:
+    - 3.11.1
+    - 3.11.3
+  - dependency-name: rspec
+    versions:
+    - 3.10.0

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+.env
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,281 @@
+# 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).
+
+## [4.1.0] - 2023-05-15
+
+### Added
+
+- Add the ability to trigger any callable object as stream chunks come through, not just Procs. Big thanks to [@obie](https://github.com/obie) for this change.
+
+## [4.0.0] - 2023-04-25
+
+### Added
+
+- Add the ability to stream Chat responses from the API! Thanks to everyone who requested this and made suggestions.
+- Added instructions for streaming to the README.
+
+### Changed
+
+- Switch HTTP library from HTTParty to Faraday to allow streaming and future feature and performance improvements.
+- [BREAKING] Endpoints now return JSON rather than HTTParty objects. You will need to update your code to handle this change, changing `JSON.parse(response.body)["key"]` and `response.parsed_response["key"]` to just `response["key"]`.
+
+## [3.7.0] - 2023-03-25
+
+### Added
+
+- Allow the usage of proxy base URIs like https://www.helicone.ai/. Thanks to [@mmmaia](https://github.com/mmmaia) for the PR!
+
+## [3.6.0] - 2023-03-22
+
+### Added
+
+- Add much-needed ability to increase HTTParty timeout, and set default to 120 seconds. Thanks to [@mbackermann](https://github.com/mbackermann) for the PR and to everyone who requested this!
+
+## [3.5.0] - 2023-03-02
+
+### Added
+
+- Add Client#transcribe and Client translate endpoints - Whisper over the wire! Thanks to [@Clemalfroy](https://github.com/Clemalfroy)
+
+## [3.4.0] - 2023-03-01
+
+### Added
+
+- Add Client#chat endpoint - ChatGPT over the wire!
+
+## [3.3.0] - 2023-02-15
+
+### Changed
+
+- Replace ::Ruby::OpenAI namespace with ::OpenAI - thanks [@kmcphillips](https://github.com/kmcphillips) for this work!
+- To upgrade, change `require 'ruby/openai'` to `require 'openai'` and change all references to `Ruby::OpenAI` to `OpenAI`.
+
+## [3.2.0] - 2023-02-13
+
+### Added
+
+- Add Files#content endpoint - thanks [@unixneo](https://github.com/unixneo) for raising!
+
+## [3.1.0] - 2023-02-13
+
+### Added
+
+- Add Finetunes#delete endpoint - thanks [@lancecarlson](https://github.com/lancecarlson) for flagging this.
+- Add VCR header and body matching - thanks [@petergoldstein](https://github.com/petergoldstein)!
+
+### Fixed
+
+- Update File#upload specs to remove deprecated `answers` purpose.
+
+## [3.0.3] - 2023-01-07
+
+### Added
+
+- Add ability to run the specs without VCR cassettes using `NO_VCR=true bundle exec rspec`.
+- Add Ruby 3.2 to CircleCI config - thanks [@petergoldstein](https://github.com/petergoldstein)!
+- A bit of detail added to the README on DALLE image sizes - thanks [@ndemianc](https://github.com/ndemianc)!
+
+### Fixed
+
+- Fix finetunes and files uploads endpoints - thanks [@chaadow](https://github.com/chaadow) for your PR on this and [@petergoldstein](https://github.com/petergoldstein) for the PR we ultimately went with.
+
+## [3.0.2] - 2022-12-27
+
+### Fixed
+
+- Fixed Images#generate and Finetunes#create which were broken by a double call of to_json.
+- Thanks [@konung](https://github.com/konung) for spotting this!
+
+## [3.0.1] - 2022-12-26
+
+### Removed
+
+- [BREAKING] Remove deprecated answers, classifications, embeddings, engines and search endpoints.
+- [BREAKING] Remove ability to pass engine to completions and embeddings outside of the parameters hash.
+
+## [3.0.0] - 2022-12-26
+
+### Added
+
+- Add ability to set access_token via gem configuration.
+- Thanks [@grjones](https://github.com/grjones) and [@aquaflamingo](https://github.com/aquaflamingo) for raising this and [@feministy](https://github.com/feministy) for the [excellent guide](https://github.com/feministy/lizabinante.com/blob/stable/source/2016-01-30-creating-a-configurable-ruby-gem.markdown#configuration-block-the-end-goal) to adding config to a gem.
+
+### Removed
+
+- [BREAKING] Remove ability to include access_token directly via ENV vars.
+- [BREAKING] Remove ability to pass API version directly to endpoints.
+
+## [2.3.0] - 2022-12-23
+
+### Added
+
+- Add Images#edit and Images#variations endpoint to modify images with DALL·E.
+
+## [2.2.0] - 2022-12-15
+
+### Added
+
+- Add Organization ID to headers so users can charge credits to the correct organization.
+- Thanks [@mridul911](https://github.com/mridul911) for raising this and [@maks112v](https://github.com/maks112v) for adding it!
+
+## [2.1.0] - 2022-11-13
+
+### Added
+
+- Add Images#generate endpoint to generate images with DALL·E!
+
+## [2.0.1] - 2022-10-22
+
+### Removed
+
+- Deprecate Client#answers endpoint.
+- Deprecate Client#classifications endpoint.
+
+## [2.0.0] - 2022-09-19
+
+### Removed
+
+- [BREAKING] Remove support for Ruby 2.5.
+- [BREAKING] Remove support for passing `query`, `documents` or `file` as top-level parameters to `Client#search`.
+- Deprecate Client#search endpoint.
+- Deprecate Client#engines endpoints.
+
+### Added
+
+- Add Client#models endpoints to list and query available models.
+
+## [1.5.0] - 2022-09-18
+
+### Added
+
+- Add Client#moderations endpoint to check OpenAI's Content Policy.
+- Add Client#edits endpoints to transform inputs according to instructions.
+
+## [1.4.0] - 2021-12-11
+
+### Added
+
+- Add Client#engines endpoints to list and query available engines.
+- Add Client#finetunes endpoints to create and use fine-tuned models.
+- Add Client#embeddings endpoint to get vector representations of inputs.
+- Add tests and examples for more engines.
+
+## [1.3.1] - 2021-07-14
+
+### Changed
+
+- Add backwards compatibility from Ruby 2.5+.
+
+## [1.3.0] - 2021-04-18
+
+### Added
+
+- Add Client#classifications to predict the most likely labels based on examples or a file.
+
+### Fixed
+
+- Fixed Files#upload which was previously broken by the validation code!
+
+## [1.2.2] - 2021-04-18
+
+### Changed
+
+- Add Client#search(parameters:) to allow passing `max_rerank` or `return_metadata`.
+- Deprecate Client#search with query, file or document parameters at the top level.
+- Thanks [@stevegeek](https://github.com/stevegeek) for pointing this issue out!
+
+## [1.2.1] - 2021-04-11
+
+### Added
+
+- Add validation of JSONL files to make it easier to debug during upload.
+
+## [1.2.0] - 2021-04-08
+
+### Added
+
+- Add Client#answers endpoint for question/answer response on documents or a file.
+
+## [1.1.0] - 2021-04-07
+
+### Added
+
+- Add Client#files to allow file upload.
+- Add Client#search(file:) so you can search a file.
+
+## [1.0.0] - 2021-02-01
+
+### Removed
+
+- Remove deprecated method Client#call - use Client#completions instead.
+
+### Changed
+
+- Rename 'master' branch to 'main' branch.
+- Bump dependencies.
+
+## [0.3.0] - 2020-11-22
+
+### Added
+
+- Add Client#completions to allow all parameters.
+
+### Changed
+
+- Deprecate Client#call.
+- Update README.
+
+## [0.2.0] - 2020-11-22
+
+### Added
+
+- Add method to use the search endpoint.
+
+## [0.1.4] - 2020-10-18
+
+### Changed
+
+- Bump Rubocop to 3.9.2.
+- Bump Webmock to 3.9.1.
+
+## [0.1.3] - 2020-09-09
+
+### Changed
+
+- Add ability to change API version in the future.
+- Fix README typos.
+
+## [0.1.2] - 2020-09-09
+
+### Added
+
+- Add tests and cached responses for the different engines.
+- Add issue templates.
+
+### Changed
+
+- Add README instructions for using the gem without dotenv.
+- Add list of engines to README.
+
+## [0.1.1] - 2020-09-08
+
+### Added
+
+- Run Rubocop on pulls using CircleCI.
+
+### Changed
+
+- Clean up CircleCI config file.
+
+## [0.1.0] - 2020-09-06
+
+### Added
+
+- Initialise repository.
+- Add OpenAI::Client to connect to OpenAI API using user credentials.
+- Add spec for Client with a cached response using VCR.
+- Add CircleCI to run the specs on pull requests.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexrudall@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/ruby-openai. 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/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Include gem dependencies from ruby-openai.gemspec
+gemspec
+
+gem "byebug", "~> 11.1.3"
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.50.2"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    ruby-advanced-openai (4.1.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      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.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.50.2)
+  ruby-advanced-openai!
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alex
+
+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,2 @@
+# Ruby Advanced OpenAI
+I will be creating an advanced gem for utilizing OpenAI, based on https://github.com/alexrudall/ruby-openai.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openai"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openai/client.rb

@@ -0,0 +1,56 @@
+module OpenAI
+  class Client
+    extend OpenAI::HTTP
+
+    def initialize(access_token: nil, organization_id: nil, uri_base: nil, request_timeout: nil)
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.uri_base = uri_base if uri_base
+      OpenAI.configuration.request_timeout = request_timeout if request_timeout
+    end
+
+    def chat(parameters: {})
+      OpenAI::Client.json_post(path: "/chat/completions", parameters: parameters)
+    end
+
+    def completions(parameters: {})
+      OpenAI::Client.json_post(path: "/completions", parameters: parameters)
+    end
+
+    def edits(parameters: {})
+      OpenAI::Client.json_post(path: "/edits", parameters: parameters)
+    end
+
+    def embeddings(parameters: {})
+      OpenAI::Client.json_post(path: "/embeddings", parameters: parameters)
+    end
+
+    def files
+      @files ||= OpenAI::Files.new
+    end
+
+    def finetunes
+      @finetunes ||= OpenAI::Finetunes.new
+    end
+
+    def images
+      @images ||= OpenAI::Images.new
+    end
+
+    def models
+      @models ||= OpenAI::Models.new
+    end
+
+    def moderations(parameters: {})
+      OpenAI::Client.json_post(path: "/moderations", parameters: parameters)
+    end
+
+    def transcribe(parameters: {})
+      OpenAI::Client.multipart_post(path: "/audio/transcriptions", parameters: parameters)
+    end
+
+    def translate(parameters: {})
+      OpenAI::Client.multipart_post(path: "/audio/translations", parameters: parameters)
+    end
+  end
+end

data/lib/openai/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module OpenAI
+    VERSION = ::OpenAI::VERSION
+
+    Error = ::OpenAI::Error
+    ConfigurationError = ::OpenAI::ConfigurationError
+    Configuration = ::OpenAI::Configuration
+  end
+end

data/lib/openai/files.rb

@@ -0,0 +1,43 @@
+module OpenAI
+  class Files
+    def initialize(access_token: nil, organization_id: nil)
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+    end
+
+    def list
+      OpenAI::Client.get(path: "/files")
+    end
+
+    def upload(parameters: {})
+      validate(file: parameters[:file])
+
+      OpenAI::Client.multipart_post(
+        path: "/files",
+        parameters: parameters.merge(file: File.open(parameters[:file]))
+      )
+    end
+
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/files/#{id}")
+    end
+
+    def content(id:)
+      OpenAI::Client.get(path: "/files/#{id}/content")
+    end
+
+    def delete(id:)
+      OpenAI::Client.delete(path: "/files/#{id}")
+    end
+
+    private
+
+    def validate(file:)
+      File.open(file).each_line.with_index do |line, index|
+        JSON.parse(line)
+      rescue JSON::ParserError => e
+        raise JSON::ParserError, "#{e.message} - found on line #{index + 1} of #{file}"
+      end
+    end
+  end
+end

data/lib/openai/finetunes.rb

@@ -0,0 +1,36 @@
+module OpenAI
+  class Finetunes
+    def initialize(access_token: nil, organization_id: nil)
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+    end
+
+    def list
+      OpenAI::Client.get(path: "/fine-tunes")
+    end
+
+    def create(parameters: {})
+      OpenAI::Client.json_post(path: "/fine-tunes", parameters: parameters)
+    end
+
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/fine-tunes/#{id}")
+    end
+
+    def cancel(id:)
+      OpenAI::Client.multipart_post(path: "/fine-tunes/#{id}/cancel")
+    end
+
+    def events(id:)
+      OpenAI::Client.get(path: "/fine-tunes/#{id}/events")
+    end
+
+    def delete(fine_tuned_model:)
+      if fine_tuned_model.start_with?("ft-")
+        raise ArgumentError, "Please give a fine_tuned_model name, not a fine-tune ID"
+      end
+
+      OpenAI::Client.delete(path: "/models/#{fine_tuned_model}")
+    end
+  end
+end

data/lib/openai/http.rb

@@ -0,0 +1,95 @@
+module OpenAI
+  module HTTP
+    def get(path:)
+      to_json(conn.get(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    def json_post(path:, parameters:)
+      to_json(conn.post(uri(path: path)) do |req|
+        if parameters[:stream].respond_to?(:call)
+          req.options.on_data = to_json_stream(user_proc: parameters[:stream])
+          parameters[:stream] = true # Necessary to tell OpenAI to stream.
+        elsif parameters[:stream]
+          raise ArgumentError, "The stream parameter must be a Proc or have a #call method"
+        end
+
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    def multipart_post(path:, parameters: nil)
+      to_json(conn(multipart: true).post(uri(path: path)) do |req|
+        req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
+        req.body = multipart_parameters(parameters)
+      end&.body)
+    end
+
+    def delete(path:)
+      to_json(conn.delete(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    private
+
+    def to_json(string)
+      return unless string
+
+      JSON.parse(string)
+    rescue JSON::ParserError
+      # Convert a multiline string of JSON objects to a JSON array.
+      JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
+    end
+
+    # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.
+    # For each chunk, the inner user_proc is called giving it the JSON object. The JSON object could
+    # be a data object or an error object as described in the OpenAI API documentation.
+    #
+    # If the JSON object for a given data or error message is invalid, it is ignored.
+    #
+    # @param user_proc [Proc] The inner proc to call for each JSON object in the chunk.
+    # @return [Proc] An outer proc that iterates over a raw stream, converting it to JSON.
+    def to_json_stream(user_proc:)
+      proc do |chunk, _|
+        chunk.scan(/(?:data|error): (\{.*\})/i).flatten.each do |data|
+          user_proc.call(JSON.parse(data))
+        rescue JSON::ParserError
+          # Ignore invalid JSON.
+        end
+      end
+    end
+
+    def conn(multipart: false)
+      Faraday.new do |f|
+        f.options[:timeout] = OpenAI.configuration.request_timeout
+        f.request(:multipart) if multipart
+      end
+    end
+
+    def uri(path:)
+      OpenAI.configuration.uri_base + OpenAI.configuration.api_version + path
+    end
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{OpenAI.configuration.access_token}",
+        "OpenAI-Organization" => OpenAI.configuration.organization_id
+      }
+    end
+
+    def multipart_parameters(parameters)
+      parameters&.transform_values do |value|
+        next value unless value.is_a?(File)
+
+        # Doesn't seem like OpenAI need mime_type yet, so not worth
+        # the library to figure this out. Hence the empty string
+        # as the second argument.
+        Faraday::UploadIO.new(value, "", value.path)
+      end
+    end
+  end
+end

data/lib/openai/images.rb

@@ -0,0 +1,28 @@
+module OpenAI
+  class Images
+    def initialize(access_token: nil, organization_id: nil)
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+    end
+
+    def generate(parameters: {})
+      OpenAI::Client.json_post(path: "/images/generations", parameters: parameters)
+    end
+
+    def edit(parameters: {})
+      OpenAI::Client.multipart_post(path: "/images/edits", parameters: open_files(parameters))
+    end
+
+    def variations(parameters: {})
+      OpenAI::Client.multipart_post(path: "/images/variations", parameters: open_files(parameters))
+    end
+
+    private
+
+    def open_files(parameters)
+      parameters = parameters.merge(image: File.open(parameters[:image]))
+      parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]
+      parameters
+    end
+  end
+end

data/lib/openai/models.rb

@@ -0,0 +1,16 @@
+module OpenAI
+  class Models
+    def initialize(access_token: nil, organization_id: nil)
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
+    end
+
+    def list
+      OpenAI::Client.get(path: "/models")
+    end
+
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/models/#{id}")
+    end
+  end
+end

data/lib/openai/version.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  VERSION = "4.1.0".freeze
+end

data/lib/openai.rb

@@ -0,0 +1,51 @@
+require "faraday"
+require "faraday/multipart"
+
+require_relative "openai/http"
+require_relative "openai/client"
+require_relative "openai/files"
+require_relative "openai/finetunes"
+require_relative "openai/images"
+require_relative "openai/models"
+require_relative "openai/version"
+
+module OpenAI
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :access_token
+    attr_accessor :api_version, :organization_id, :uri_base, :request_timeout
+
+    DEFAULT_API_VERSION = "v1".freeze
+    DEFAULT_URI_BASE = "https://api.openai.com/".freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @access_token = nil
+      @api_version = DEFAULT_API_VERSION
+      @organization_id = nil
+      @uri_base = DEFAULT_URI_BASE
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+    end
+
+    def access_token
+      return @access_token if @access_token
+
+      error_text = "OpenAI access token missing! See https://github.com/alexrudall/ruby-openai#usage"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= OpenAI::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ruby/advanced/openai.rb

@@ -0,0 +1,2 @@
+require_relative "../openai"
+require_relative "../openai/compatibility"

data/pull_request_template.md

@@ -0,0 +1,5 @@
+## All Submissions:
+
+* [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

data/ruby-advanced-openai.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/openai/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-advanced-openai"
+  spec.version       = OpenAI::VERSION
+  spec.authors       = ["Yudai-hub"]
+  spec.email         = ["coffeecoffee@outlook.jp"]
+
+  spec.summary       = "Advanced OpenAI API wrapper for Ruby."
+  spec.homepage      = "https://github.com/Yudai-hub/ruby-advanced-openai"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Yudai-hub/ruby-advanced-openai"
+  spec.metadata["changelog_uri"] = "https://github.com/Yudai-hub/ruby-advanced-openai/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 1"
+  spec.add_dependency "faraday-multipart", ">= 1"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ruby-advanced-openai
+version: !ruby/object:Gem::Version
+  version: 4.1.0
+platform: ruby
+authors:
+- Yudai-hub
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: 
+email:
+- coffeecoffee@outlook.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openai.rb
+- lib/openai/client.rb
+- lib/openai/compatibility.rb
+- lib/openai/files.rb
+- lib/openai/finetunes.rb
+- lib/openai/http.rb
+- lib/openai/images.rb
+- lib/openai/models.rb
+- lib/openai/version.rb
+- lib/ruby/advanced/openai.rb
+- pull_request_template.md
+- ruby-advanced-openai.gemspec
+homepage: https://github.com/Yudai-hub/ruby-advanced-openai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Yudai-hub/ruby-advanced-openai
+  source_code_uri: https://github.com/Yudai-hub/ruby-advanced-openai
+  changelog_uri: https://github.com/Yudai-hub/ruby-advanced-openai/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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Advanced OpenAI API wrapper for Ruby.
+test_files: []