ruby-advanced-openai 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf6f6a2c422f1842883062ffe4e6dcc3315ed79323f126ebf1c759d005d68f4
-  data.tar.gz: fc2be4ce29643e0f38a67adda1488364f2f280a139e66b8a484548f4ac97c5ac
+  metadata.gz: 524aac2fb147784d0a663a665b620de29a1e76359976d60be2697c08766c4ca1
+  data.tar.gz: 59056a07679f7669e735776aa5abb37bbd87dd74cdfc0178543e180272fb0ba1
 SHA512:
-  metadata.gz: '06879b030e8f7b254101db3e1b11ca024471dc3491ee853552a167e4768529045761860c8d177fb7075e66af52c4a87b6816a193e1fd8abaf04b73ca64d945c1'
-  data.tar.gz: '0028141fb741a851be88708ffa2c4eaffa0fd91470d45995f6b99a1297c411d16a387543f11849ee78602599746f63691b8aa003c43e78dde9c6aa5a8ba0784e'
+  metadata.gz: 7b596f1b5e887d8156b0a26ec96b2da76db8116894cc3bbb5b5bfb606f92ff62c02fc74cae64df1cad9674e2ce2149ecd79d6af644388f376ffa03f15b5bddd7
+  data.tar.gz: 7d339f816a2c3cbef65ed48eb8ca9d5a477725c51c45e8ccd8a33460df12095f89bc7bf26cd72def432224a05e63cf1bb3872658357e937958fe13f5e76bf6e9

data/README.md

@@ -1,2 +1,394 @@
-# Ruby Advanced OpenAI
-I will be creating an advanced gem for utilizing OpenAI, based on https://github.com/alexrudall/ruby-openai.
+# Ruby OpenAI
+Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby.
+ruby-advanced-openai is a customized of https://github.com/alexrudall/ruby-openai.
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-advanced-openai"
+```
+
+And then execute:
+
+$ bundle install
+
+### Gem install
+
+Or install with:
+
+$ gem install ruby-advanced-openai
+
+and require with:
+
+```ruby
+require "openai"
+```
+
+## Usage
+
+- Get your API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)
+- If you belong to multiple organizations, you can get your Organization ID from [https://platform.openai.com/account/org-settings](https://platform.openai.com/account/org-settings)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = OpenAI::Client.new(access_token: "access_token_goes_here")
+```
+
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `openai.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+
+```ruby
+OpenAI.configure do |config|
+    config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
+    config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional.
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = OpenAI::Client.new
+```
+
+#### Custom timeout or base URI
+
+The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests, eg. to use observability tools like [Helicone](https://docs.helicone.ai/quickstart/integrate-in-one-line-of-code):
+
+```ruby
+client = OpenAI::Client.new(
+    access_token: "access_token_goes_here",
+    uri_base: "https://oai.hconeai.com/",
+    request_timeout: 240
+)
+```
+
+or when configuring the gem:
+
+```ruby
+OpenAI.configure do |config|
+    config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
+    config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional
+    config.uri_base = "https://oai.hconeai.com/" # Optional
+    config.request_timeout = 240 # Optional
+end
+```
+
+### Models
+
+There are different models that can be used to generate text. For a full list and to retrieve information about a single model:
+
+```ruby
+client.models.list
+client.models.retrieve(id: "text-ada-001")
+```
+
+#### Examples
+
+- [GPT-4 (limited beta)](https://platform.openai.com/docs/models/gpt-4)
+  - gpt-4
+  - gpt-4-0314
+  - gpt-4-32k
+- [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5)
+  - gpt-3.5-turbo
+  - gpt-3.5-turbo-0301
+  - text-davinci-003
+- [GPT-3](https://platform.openai.com/docs/models/gpt-3)
+  - text-ada-001
+  - text-babbage-001
+  - text-curie-001
+
+### ChatGPT
+
+ChatGPT is a model that can be used to generate text in a conversational style. 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
+response = client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo", # Required.
+        messages: [{ role: "user", content: "Hello!"}], # Required.
+        temperature: 0.7,
+    })
+puts response.dig("choices", 0, "message", "content")
+# => "Hello! How may I assist you today?"
+```
+
+### ChatGPT for reply mail or ...
+
+```ruby
+incoming_mail = <<~MESSAGE
+拝啓、Hoge様
+
+お世話になっております。私たちの会社は、〇〇に関する新規プロジェクトの立ち上げを検討しております。このたび、貴社に対して提案書の作成を依頼させていただきたく、ご連絡差し上げました。
+
+ご承知の通り、弊社は〇〇分野での豊富な経験と実績を持つ企業です。今回のプロジェクトにおいても、貴社の専門知識と技術力に大変興味を持っており、提案書を通じて具体的な提案をいただければと考えています。
+
+提案書の内容には、以下の要素を含めていただけると幸いです：
+
+1. プロジェクトの目的と背景
+2. 提案するソリューションやアプローチ
+3. 予算と納期の見積もり
+4. 弊社と貴社の連携方法やプロジェクトの進行管理について
+
+なお、提案書の作成にあたり、詳細な要件や資料を別途提供させていただきます。また、提案書の提出期限は〇〇月〇〇日までとさせていただきますので、お時間の許す範囲でご検討いただければ幸いです。
+
+お忙しい中恐縮ですが、貴社のご協力とご検討をお願い申し上げます。何卒、ご返信をいただけますようお願い申し上げます。
+
+敬具
+fuga株式会社
+MESSAGE
+response = client.suggested_reply(model: "gpt-4", incoming_mail: incoming_mail, reply_summary: "承知しました。")
+puts response.dig("choices", 0, "message", "content")
+# => {Email reply text}
+```
+
+### Streaming ChatGPT
+
+[Quick guide to streaming ChatGPT with Rails 7 and Hotwire](https://gist.github.com/alexrudall/cb5ee1e109353ef358adb4e66631799d)
+
+You can stream from the API in realtime, which can be much faster and used to create a more engaging user experience. Pass a [Proc](https://ruby-doc.org/core-2.6/Proc.html) (or any object with a `#call` method) to the `stream` parameter to receive the stream of text chunks as they are generated. Each time one or more chunks is received, the proc will be called once with each chunk, parsed as a Hash. If OpenAI returns an error, `ruby-openai` will pass that to your proc as a Hash.
+
+```ruby
+client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo", # Required.
+        messages: [{ role: "user", content: "Describe a character called Anna!"}], # Required.
+        temperature: 0.7,
+        stream: proc do |chunk, _bytesize|
+            print chunk.dig("choices", 0, "delta", "content")
+        end
+    })
+# => "Anna is a young woman in her mid-twenties, with wavy chestnut hair that falls to her shoulders..."
+```
+
+### Completions
+
+Hit the OpenAI API for a completion using other GPT-3 models:
+
+```ruby
+response = client.completions(
+    parameters: {
+        model: "text-davinci-001",
+        prompt: "Once upon a time",
+        max_tokens: 5
+    })
+puts response["choices"].map { |c| c["text"] }
+# => [", there lived a great"]
+```
+
+### Edits
+
+Send a string and some instructions for what to do to the string:
+
+```ruby
+response = client.edits(
+    parameters: {
+        model: "text-davinci-edit-001",
+        input: "What day of the wek is it?",
+        instruction: "Fix the spelling mistakes"
+    }
+)
+puts response.dig("choices", 0, "text")
+# => What day of the week is it?
+```
+
+### Embeddings
+
+You can use the embeddings endpoint to get a vector of numbers representing an input. You can then compare these vectors for different inputs to efficiently check how similar the inputs are.
+
+```ruby
+client.embeddings(
+    parameters: {
+        model: "babbage-similarity",
+        input: "The food was delicious and the waiter..."
+    }
+)
+```
+
+### Files
+
+Put your data in a `.jsonl` file like this:
+
+```json
+{"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
+{"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
+```
+
+and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
+
+```ruby
+client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
+client.files.list
+client.files.retrieve(id: "file-123")
+client.files.content(id: "file-123")
+client.files.delete(id: "file-123")
+```
+
+### Fine-tunes
+
+Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
+
+```ruby
+response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
+file_id = JSON.parse(response.body)["id"]
+```
+
+You can then use this file ID to create a fine-tune model:
+
+```ruby
+response = client.finetunes.create(
+    parameters: {
+    training_file: file_id,
+    model: "ada"
+})
+fine_tune_id = response["id"]
+```
+
+That will give you the fine-tune ID. If you made a mistake you can cancel the fine-tune model before it is processed:
+
+```ruby
+client.finetunes.cancel(id: fine_tune_id)
+```
+
+You may need to wait a short time for processing to complete. Once processed, you can use list or retrieve to get the name of the fine-tuned model:
+
+```ruby
+client.finetunes.list
+response = client.finetunes.retrieve(id: fine_tune_id)
+fine_tuned_model = response["fine_tuned_model"]
+```
+
+This fine-tuned model name can then be used in completions:
+
+```ruby
+response = client.completions(
+    parameters: {
+        model: fine_tuned_model,
+        prompt: "I love Mondays!"
+    }
+)
+response.dig("choices", 0, "text")
+```
+
+You can delete the fine-tuned model when you are done with it:
+
+```ruby
+client.finetunes.delete(fine_tuned_model: fine_tuned_model)
+```
+
+### Image Generation
+
+Generate an image using DALL·E! The size of any generated images must be one of `256x256`, `512x512` or `1024x1024` -
+if not specified the image will default to `1024x1024`.
+
+```ruby
+response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort", size: "256x256" })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Ruby](https://i.ibb.co/6y4HJFx/img-d-Tx-Rf-RHj-SO5-Gho-Cbd8o-LJvw3.png)
+
+### Image Edit
+
+Fill in the transparent part of an image, or upload a mask with transparent sections to indicate the parts of an image that can be changed according to your prompt...
+
+```ruby
+response = client.images.edit(parameters: { prompt: "A solid red Ruby on a blue background", image: "image.png", mask: "mask.png" })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Ruby](https://i.ibb.co/sWVh3BX/dalle-ruby.png)
+
+### Image Variations
+
+Create n variations of an image.
+
+```ruby
+response = client.images.variations(parameters: { image: "image.png", n: 2 })
+puts response.dig("data", 0, "url")
+# => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Ruby](https://i.ibb.co/TWJLP2y/img-miu-Wk-Nl0-QNy-Xtj-Lerc3c0l-NW.png)
+![Ruby](https://i.ibb.co/ScBhDGB/img-a9-Be-Rz-Au-Xwd-AV0-ERLUTSTGdi.png)
+
+### Moderations
+
+Pass a string to check if it violates OpenAI's Content Policy:
+
+```ruby
+response = client.moderations(parameters: { input: "I'm worried about that." })
+puts response.dig("results", 0, "category_scores", "hate")
+# => 5.505014632944949e-05
+```
+
+### Whisper
+
+Whisper is a speech to text model that can be used to generate text based on audio files:
+
+#### Translate
+
+The translations API takes as input the audio file in any of the supported languages and transcribes the audio into English.
+
+```ruby
+response = client.translate(
+    parameters: {
+        model: "whisper-1",
+        file: File.open("path_to_file", "rb"),
+    })
+puts response["text"]
+# => "Translation of the text"
+```
+
+#### Transcribe
+
+The transcriptions API takes as input the audio file you want to transcribe and returns the text in the desired output file format.
+
+```ruby
+response = client.transcribe(
+    parameters: {
+        model: "whisper-1",
+        file: File.open("path_to_file", "rb"),
+    })
+puts response["text"]
+# => "Transcription of the text"
+```
+
+## 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`.
+
+### Warning
+
+If you have an `OPENAI_ACCESS_TOKEN` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+
+## Release
+
+First run the specs without VCR so they actually hit the API. This will cost 2 cents or more. Set OPENAI_ACCESS_TOKEN in your environment or pass it in like this:
+
+```
+OPENAI_ACCESS_TOKEN=123abc bundle exec rspec
+```
+
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, 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/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).
+
+## 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 Ruby OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/lib/openai/assistant/replyer.rb

@@ -0,0 +1,58 @@
+module OpenAI
+  module Assistant
+    class Replyer
+      def initialize(model: "gpt-3.5-turbo", incoming_mail: "", reply_summary: "", situation: 'formal', other_request: "")
+        return if incoming_mail.empty? || reply_summary.empty?
+
+        @prompt_data = prompt_data(model:model, incoming_mail: incoming_mail, reply_summary: reply_summary, situation: situation, other_request: other_request)
+      end
+
+      def prompt_data(model:, incoming_mail:, reply_summary:, situation:, other_request:)
+        {
+          model: model,
+          incoming_mail: incoming_mail,
+          reply_summary: reply_summary,
+          situation: situation,
+          other_request: other_request
+        }
+      end
+
+      def get_prompt_data(model:, incoming_mail:, reply_summary:, situation:, other_request:)
+        @prompt_data
+      end
+
+      def set_prompt_data(model:, incoming_mail:, reply_summary:, situation:, other_request:)
+        @prompt_data[:incoming_mail] = incoming_mail if !incoming_mail.empty?
+        @prompt_data[:reply_summary] = reply_summary if !reply_summary.empty?
+        @prompt_data[:situation] = situation if !situation.empty?
+        @prompt_data[:other_request] = other_request if !other_request.empty?
+      end
+
+      def parameters
+        {
+          model: @prompt_data[:model],
+          messages: [
+            { role: "system", content: system_prompt },
+            # { role: "user", content: user_prompt }
+          ],
+          temperature: 0.7,
+        }
+      end
+
+      private
+
+      def system_prompt
+        system_prompt = []
+        system_prompt << "状況:" + @prompt_data[:situation]
+        system_prompt << "返信したい内容:" + @prompt_data[:reply_summary]
+        system_prompt << "受信したメール:" + @prompt_data[:incoming_mail]
+        system_prompt << "その他要望:" + @prompt_data[:other_request] if @prompt_data[:other_request].empty?
+        system_prompt << "USER: メールの返信を作成してください。\nASSISTANT:"
+        system_prompt.join(',')
+      end
+
+      def user_prompt
+      end
+    end
+  end
+end

data/lib/openai/client.rb

@@ -1,3 +1,5 @@
+require_relative "assistant/replyer"
+
 module OpenAI
   class Client
     extend OpenAI::HTTP
@@ -13,6 +15,20 @@ module OpenAI
       OpenAI::Client.json_post(path: "/chat/completions", parameters: parameters)
     end
 
+    def suggested_reply(model: nil, incoming_mail: "", reply_summary: "", situation: nil, other_request: nil, assistant: nil)
+      response = if !assistant.nil?
+                   self.chat(parameters: assistant.parameters)
+                 else
+                   return if incoming_mail.empty? || reply_summary.empty?
+
+                   self.chat(
+                     OpenAI::Assistant::Replyer.new(model: model, incoming_mail: incoming_mail, reply_summary: reply_summary, situation: situation, other_request: other_request)
+                   )
+                 end
+      response
+      # TODO: erorrs
+    end
+
     def completions(parameters: {})
       OpenAI::Client.json_post(path: "/completions", parameters: parameters)
     end

data/lib/openai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-advanced-openai
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Yudai-hub
@@ -63,6 +63,7 @@ files:
 - bin/console
 - bin/setup
 - lib/openai.rb
+- lib/openai/assistant/replyer.rb
 - lib/openai/client.rb
 - lib/openai/compatibility.rb
 - lib/openai/files.rb