orbai 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c90da28fcf62b76b25bee920a7d76c218ea9bc863a37bdaf0890b68d873d064
+  data.tar.gz: 8732e8319d49c793fc79a14d8d2fd36596e037f6ab90867b3dd4329784c4935a
+SHA512:
+  metadata.gz: 4aff74febd95ea6e0d7515b0a8411a641169fe62307ac020bd212a177172556f28c94cc32d0c8046f6042fc166c295a3d805a482c523f4155f09ef5e69bf6519
+  data.tar.gz: 22d6aed2f31a6c9f85d3d485909dac450f9dd3d14eafbe331712b622d47ea0f689b702e0068d810189cdbeb79a7750c4fc3c3d627b6a2b19fb6ff56b5a9a136e

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2023-10-22
+
+- Initial release

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 TODO: Write your email address. 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 orbai.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/README.md

@@ -0,0 +1,253 @@
+# `orbai`: A Ruby DSL for OpenAI
+
+Welcome to `orbai`, an idiomatic Ruby DSL for OpenAI's powerful API. With the
+combination of Ruby's natural language processing strengths and OpenAI's
+advanced capabilities, your applications are set to take a massive leap forward.
+
+## Disclaimer
+
+Please be aware that `orbai` is in its early stages and is not maintained
+regularly. While we aim to provide the best, there might be bugs or
+unimplemented features. Your patience and contributions are highly appreciated.
+
+## Quick Start (For Rubyists)
+
+1. Install the orbai gem:
+
+```sh
+gem install orbai
+```
+
+1. [Have an OpenAI API key](https://beta.openai.com/account/api-keys) in your
+   environment. By default, `orbai` will look for `OPENAI_API_KEY`..
+
+1. Use `orbai` to query OpenAI:
+
+```ruby
+require "orbai"
+
+Orbai.query("What's the capital of France?")
+
+# => "The capital of France is Paris."
+```
+
+## Rationale
+
+1. **Ruby is the Best Language for DSLs**: Ruby's expressiveness has made it the
+   go-to language for Domain Specific Languages, finding its use in a myriad of
+   practical domains.
+2. **OpenAI & Ruby**: OpenAI offers transformative capabilities to the domains
+   where Ruby DSLs excel.
+3. **orbai**: Born out of the need for an expressive, easy-to-integrate tool
+   that merges the power of OpenAI and the elegance of Ruby.
+
+## Getting Started (For Newbies)
+
+1. Installing Ruby: If you're a technical person, we recommend using
+   [asdf-vm](https://github.com/asdf-vm/asdf) for version management.
+1. Learning Ruby: If you're new to Ruby... `TODO`
+1. Follow the "Quick Start" guide above to get up and running.
+
+## 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
+
+We welcome contributions to `orbai`! If you stumble upon issues or have features
+you'd like to suggest, please:
+
+- [Submit an issue](https://github.com/skotchpine/orbai/issues)
+- For direct contributions,
+  [submit a pull request](https://github.com/skotchpine/orbai/pulls).
+
+## Help Wanted!
+
+- 🔲 Feedback
+- 🔲 Docs
+- 🔲 Tests
+- 🔲 Triage
+- 🔲 Imagination
+
+## `Orbai::DSL`
+
+### Simple Query API
+
+```ruby
+require "orbai"
+Orbai.query("What is your favorite color?")
+#=> "My favorite color is blue."
+```
+
+### Wishlist
+
+- 🔲 Config DX
+- 🔲 Roles Builder DX
+- 🔲 Context Params DX
+- 🔲 Extract structured data
+- 🔲 Functions DX
+- 🔲 Images DX
+- 🔲 Audio DX
+- 🔲 Files DX
+- 🔲 Embeddings DX
+- 🔲 Fine-tuning DX
+
+## `Orbai` Module / `HttpClient` HTTP Methods
+
+The `Orbai` module is just a container for everything else.
+
+For ease of use, it includes http getters through an `HttpClient` singleton.
+
+The HTTP getters throw an `Orbai::HTTPClient::Error` if the request fails. The
+OpenAI API `type` field from the error response is assigned to
+`Orbai::HTTPClient::Error#type`.
+
+### Example
+
+```ruby
+Orbai.get("/chat/completions", model: 'gpt-3.5-turbo', messages: [
+  {role:'system',content:'Act as a helpful prompt.'},
+  {role:'user',content:'What is the capital of France?'},
+])
+
+# Returns
+{"id"=>"chatcmpl-XXXXXXXX",
+ "object"=>"chat.completion",
+ "created"=>1697444538,
+ "model"=>"gpt-3.5-turbo-0613",
+ "choices"=>
+  [{"index"=>0,
+    "message"=>
+     {"role"=>"assistant", "content"=>"The capital of France is Paris."},
+    "finish_reason"=>"stop"}],
+ "usage"=>{"prompt_tokens"=>24, "completion_tokens"=>7, "total_tokens"=>31}}
+```
+
+### `Orbai` Shortcuts / `HttpClient` HTTP Methods
+
+```ruby
+c = Orbai::HttpClient.new
+
+# HttpClient singleton
+c.http_client #=> #<Orbai::HttpClient>
+
+# HTTP Methods
+c.get(path, **params) #=> Returns JSON result as a ruby hash.
+c.post(path, **params)
+c.put(path, **params)
+c.patch(path, **params)
+c.delete(path, **params)
+c.http_request(method, path, **params)
+```
+
+## `Orbai::HttpClient`
+
+The `HttpClient` class is used to make requests to the OpenAI API. It returns
+the JSON response from the API as a ruby hash.
+
+### Example:
+
+```ruby
+c = Orbai::HttpClient.new
+
+c.chat_completions(
+  model: 'gpt-3.5-turbo',
+  messages: [
+    {role:'system',content:'Act as a helpful prompt.'},
+    {role:'user',content:'What is the capital of France?'},
+  ],
+)
+
+# Returns
+{"id"=>"chatcmpl-XXXXXXXX",
+ "object"=>"chat.completion",
+ "created"=>1697983333,
+ "model"=>"gpt-3.5-turbo-0613",
+ "choices"=>
+  [{"index"=>0,
+    "message"=>
+     {"role"=>"assistant", "content"=>"The capital of France is Paris."},
+    "finish_reason"=>"stop"}],
+ "usage"=>{"prompt_tokens"=>24, "completion_tokens"=>7, "total_tokens"=>31}}
+```
+
+### API Methods Cheatsheet
+
+```ruby
+c = Orbai::HttpClient.new
+
+# Chat
+#   POST /chat/completions
+c.chat_completions(**params)
+
+# Completions
+#   POST /completions
+c.completions(**params)
+
+# Edits
+#   POST /edits
+c.edits(**params)
+
+# Images
+#   POST /images/generations
+c.create_image(**params)
+#   POST /images/edits
+c.create_image_edit(**params)
+#   POST /images/variations
+c.create_image_variation(**params)
+
+# Embeddings
+#   POST /embeddings
+c.create_embedding(**params)
+
+# Fine_tuning
+#
+#   POST /fine_tuning/jobs
+c.create_fine_tuning_jobs(**params)
+#   GET /fine_tuning/jobs
+c.list_fine_tuning_jobs(**params)
+#   GET /fine_tuning/jobs/{fine_tuning_job_id}
+c.retrieve_fine_tuning_job(id, **params)
+#   POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel
+c.cancel_fine_tuning_job(id, **params)
+#   GET /fine_tuning/jobs/{fine_tuning_job_id}/events
+c.list_fine_tuning_events(id, **params)
+
+# Audio
+#   POST /audio/transcriptions
+c.create_transcription(**params)
+#   POST /audio/translations
+c.create_translation(**params)
+
+# Files
+#   GET /files
+c.list_files(**params)
+#   POST /files
+c.upload_file(**params)
+#   DELETE /files/{file_id}
+c.delete_file(id, **params)
+#   GET /files/{file_id}
+c.retrieve_file(id, **params)
+#   GET /files/{file_id}/content
+c.file_content(id, **params)
+
+# Models
+#   GET /models
+c.list_models(**params)
+#   GET /models/{model}
+c.retrieve_model(id, **params)
+#   DELETE /models/{model}
+c.delete_model(id, **params)
+
+# Moderations
+#   POST /moderations
+c.create_moderation(**params)
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/orbai/dsl.rb

@@ -0,0 +1,3 @@
+module Orbai::Dsl
+  # TODO
+end

data/lib/orbai/http_client.rb

@@ -0,0 +1,51 @@
+module Orbai
+  # Better experience for API interaction
+  class HttpClient
+    class Error < StandardError
+      attr_reader :type
+      def initialize(response)
+        @type = response['type']
+        super(response['message'])
+      end
+    end
+
+    DEFAULT_OPS = {
+      url: 'https://api.openai.com/v1',
+      token: ENV['OPENAI_API_KEY'],
+      default_prompt: 'Act as a ruby programmer introducing someone to the language.',
+      default_model: 'gpt-3.5-turbo'
+    }
+
+    def initialize(**ops)
+      @ops = DEFAULT_OPS.merge(ops)
+    end
+
+    # Send HTTP request to openAI's API
+    #
+    # NOTE: method must be lowercase
+    #
+    def http_request(method, path, multipart: false, **params)
+      url = "#{@ops[:url]}#{path}"
+      headers = {'Authorization' => "Bearer #{@ops[:token]}"}
+
+      response = if multipart
+        headers['Content-Type'] = 'multipart/form-data'
+        HTTParty.send(method, url, multipart:, headers:, body: params)
+      else
+        headers['Content-Type'] = 'application/json'
+        HTTParty.send(method, url, multipart:, headers:, body: params.to_json)
+      end
+
+      raise Error, response['error'] if response['error']
+
+      response
+    end
+
+    # HTTP method helpers: get, post, put, patch, delete
+    def get(path, **params) = http_request('get', path, **params)
+    def post(path, **params) = http_request('post', path, **params)
+    def put(path, **params) = http_request('put', path, **params)
+    def patch(path, **params) = http_request('patch', path, **params)
+    def delete(path, **params) = http_request('delete', path, **params)
+  end
+end

data/lib/orbai/openai_methods.rb

@@ -0,0 +1,69 @@
+# Complete public openai API: https://beta.openai.com/docs/api-reference
+class Orbai::HttpClient
+  # Chat
+  #   POST /chat/completions
+  def chat_completions(**params) = post("/chat/completions", **params)
+
+  # Completions
+  #   POST /completions
+  def completions(**params) = post("/completions", **params)
+
+  # Edits
+  #   POST /edits
+  def edits(**params) = post("/edits", **params)
+
+  # Images
+  #   POST /images/generations
+  def create_image(**params) = post("/images/generations", **params)
+  #   POST /images/edits
+  def create_image_edit(**params) = post("/images/edits", multipart: true, **params)
+  #   POST /images/variations
+  def create_image_variation(**params) = post("/images/variations", multipart: true, **params)
+
+  # Embeddings
+  #   POST /embeddings
+  def create_embedding(**params) = post("/embeddings", **params)
+
+  # Fine_tuning
+  #
+  #   POST /fine_tuning/jobs
+  def create_fine_tuning_jobs(**params) = post("/fine_tuning/jobs", **params)
+  #   GET /fine_tuning/jobs
+  def list_fine_tuning_jobs(**params) = get("/fine_tuning/jobs", **params)
+  #   GET /fine_tuning/jobs/{fine_tuning_job_id}
+  def retrieve_fine_tuning_job(id, **params) = get("/fine_tuning/jobs/#{id}", **params)
+  #   POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel
+  def cancel_fine_tuning_job(id, **params) = post("/fine_tuning/jobs/#{id}/cancel", **params)
+  #   GET /fine_tuning/jobs/{fine_tuning_job_id}/events
+  def list_fine_tuning_events(id, **params) = get("/fine_tuning/jobs/#{id}/events", **params)
+
+  # Audio
+  #   POST /audio/transcriptions
+  def create_transcription(**params) = post("/audio/transcriptions", multipart: true, **params)
+  #   POST /audio/translations
+  def create_translation(**params) = post("/audio/translations", multipart: true, **params)
+
+  # Files
+  #   GET /files
+  def list_files(**params) = get("/files", **params)
+  #   POST /files
+  def upload_file(**params) = post("/files", multipart: true, **params)
+  #   DELETE /files/{file_id}
+  def delete_file(id, **params) = delete("/files/#{id}", **params)
+  #   GET /files/{file_id}
+  def retrieve_file(id, **params) = get("/files/#{id}", **params)
+  #   GET /files/{file_id}/content
+  def file_content(id, **params) = get("/files/#{id}/content", **params)
+
+  # Models
+  #   GET /models
+  def list_models(**params) = get("/models", **params)
+  #   GET /models/{model}
+  def retrieve_model(id, **params) = get("/models/#{id}", **params)
+  #   DELETE /models/{model}
+  def delete_model(id, **params) = delete("/models/#{id}", **params)
+
+  # Moderations
+  #   POST /moderations
+  def create_moderation(**params) = post("/moderations", **params)
+end

data/lib/orbai/simple_methods.rb

@@ -0,0 +1,10 @@
+class << Orbai
+  def query(prompt)
+    response = http_client.chat_completions(model: 'gpt-3.5-turbo', messages: [
+      {role:'system', content: 'Act as a helpful prompt.'},
+      {role:'user', content: prompt},
+    ])
+
+    response['choices'].first['message']['content']
+  end
+end

data/lib/orbai/version.rb

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

data/lib/orbai.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require_relative "orbai/version"
+require_relative "orbai/http_client"
+require_relative "orbai/openai_methods"
+require_relative "orbai/simple_methods"
+require_relative "orbai/dsl"
+
+module Orbai
+  # Better experience for API errors
+  class << self
+    extend Forwardable
+
+    # Singleton client for method delegation
+    def http_client = @http_client ||= HttpClient.new
+
+    def_delegators :http_client,
+      :get, :post, :put, :patch, :delete, :http_request
+  end
+end