openai_101 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9892962af94b1a95120444b0a9dd385d8ac7ac038ba47242f934d2f95b0f3791
-  data.tar.gz: 331516faad54d9b96f512cd5c64c88c750bdd234b79186325cac44f3eb76ebe5
+  metadata.gz: 79f63641cbdb6de624c2114e414d89b19c74ff54cce75f12a7933da1e3bf794c
+  data.tar.gz: aeb198288206c3bb986e5857f5697ee0214d570040380ab6b8aeb00d8f7d2b62
 SHA512:
-  metadata.gz: 91f7378b9e712378b16b2ddaef563db57110af2eba7a6cb90b92691fece809689f7aab38a9b94957067d64e3817e822b25ec69640dc1d253156e7b50924dbc72
-  data.tar.gz: 2dbb5f18b27c7006b55dd04c3e25fa06202164c11ee592a46cc33ec3b77ee2d7b95277bddcdd02c8f3121ebbf12c5a857cb2881e6296afe70d78bb574dd48f6f
+  metadata.gz: 10f327aa5411a2bacedf94f59ce457e2b7a6ee47e3b92aebbae8ade218ded0c38f65043e18d1500c5a7ebc29292a1fcc4cd4eedb56ae240d717d07b625dcf5db
+  data.tar.gz: d5178938b8faf8b7a2c54d9a1fe04c2b8618264934dc8e9a59650f3b39203ba60bb269b481d20d8de6605bf8b07bf0a6d4a4092a045fd5a9f66f519b98476f9a

data/.rubocop.yml

@@ -92,8 +92,12 @@ Layout/SpaceBeforeComma:
 # My Preferences - End
 
 # RSpec Cops
+RSpec/MultipleExpectations:
+  Max: 8
+RSpec/ExampleLength:
+  Max: 25
 RSpec/NestedGroups:
-  Max: 5
+  Max: 8
 
 RSpec/SpecFilePathFormat:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.2.3](https://github.com/appydave/openai_101/compare/v1.2.2...v1.2.3) (2024-06-19)
+
+
+### Bug Fixes
+
+* node update on ci ([3aa4b9d](https://github.com/appydave/openai_101/commit/3aa4b9dc783f5ef1d47c2583c6c988446c472a05))
+
 ## [1.2.2](https://github.com/appydave/openai_101/compare/v1.2.1...v1.2.2) (2024-06-19)
 
 

data/config/openai-cost.json

@@ -0,0 +1,285 @@
+{
+  "groups": [
+    {
+      "name": "GPT-4 Turbo",
+      "description": "With 128k context, fresher knowledge and the broadest set of capabilities, GPT-4 Turbo is more powerful than GPT-4 and offered at a lower price.",
+      "models": [
+        {
+          "name": "gpt-4-0125-preview",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$10.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$30.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "gpt-4-1106-preview",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$10.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$30.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "gpt-4-1106-vision-preview",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$10.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$30.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "GPT-4",
+      "description": "With broad general knowledge and domain expertise, GPT-4 can follow complex instructions in natural language and solve difficult problems with accuracy.",
+      "models": [
+        {
+          "name": "gpt-4",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$30.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$60.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "gpt-4-32k",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$60.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$120.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "GPT-3.5 Turbo",
+      "description": "GPT-3.5 Turbo models are capable and cost-effective.",
+      "models": [
+        {
+          "name": "gpt-3.5-turbo-0125",
+          "notes": "gpt-3.5-turbo-0125 is the flagship model of this family, supports a 16K context window and is optimized for dialog.",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$0.50",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$1.50",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "gpt-3.5-turbo-instruct",
+          "notes": "gpt-3.5-turbo-instruct is an Instruct model and only supports a 4K context window.",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$1.50",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$2.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Assistants API",
+      "description": "Assistants API and tools (retrieval, code interpreter) make it easy for developers to build AI assistants within their own applications. Each assistant incurs its own retrieval file storage fee based on the files passed to that assistant. The retrieval tool chunks and indexes your files content in our vector database.",
+      "models": [
+        {
+          "name": "code_interpreter",
+          "notes": "The tokens used for the Assistant API are billed at the chosen language model's per-token input/output rates, and the assistant intelligently chooses which context from the thread to include when calling the model.",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$0.03",
+              "unit_type": "session"
+            }
+          ]
+        },
+        {
+          "name": "retrieval",
+          "costs": [
+            {
+              "usage_type": "input",
+              "price_per_unit": "$0.20",
+              "unit_type": "GB / assistant / day",
+              "notes": "Free until 04/01/2024"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Fine-tuning models",
+      "description": "Create your own custom models by fine-tuning our base models with your training data. Once you fine-tune a model, you’ll be billed only for the tokens you use in requests to that model.",
+      "models": [
+        {
+          "name": "gpt-3.5-turbo",
+          "costs": [
+            {
+              "usage_type": "training",
+              "price_per_unit": "$8.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "input",
+              "price_per_unit": "$3.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$6.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "davinci-002",
+          "costs": [
+            {
+              "usage_type": "training",
+              "price_per_unit": "$6.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "input",
+              "price_per_unit": "$12.00",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$12.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "babbage-002",
+          "costs": [
+            {
+              "usage_type": "training",
+              "price_per_unit": "$0.40",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "input",
+              "price_per_unit": "$1.60",
+              "unit_type": "1M tokens"
+            },
+            {
+              "usage_type": "output",
+              "price_per_unit": "$1.60",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Embedding models",
+      "description": "Build advanced search, clustering, topic modeling, and classification functionality with our embeddings offering.",
+      "models": [
+        {
+          "name": "text-embedding-3-small",
+          "costs": [
+            {
+              "usage_type": "usage",
+              "price_per_unit": "$0.02",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "text-embedding-3-large",
+          "costs": [
+            {
+              "usage_type": "usage",
+              "price_per_unit": "$0.13",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "ada v2",
+          "costs": [
+            {
+              "usage_type": "usage",
+              "price_per_unit": "$0.10",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Base models",
+      "description": "GPT base models are not optimized for instruction-following and are less capable, but they can be effective when fine-tuned for narrow tasks.",
+      "models": [
+        {
+          "name": "davinci-002",
+          "costs": [
+            {
+              "usage_type": "usage",
+              "price_per_unit": "$2.00",
+              "unit_type": "1M tokens"
+            }
+          ]
+        },
+        {
+          "name": "babbage-002",
+          "costs": [
+            {
+              "usage_type": "usage",
+              "price_per_unit": "$0.40",
+              "unit_type": "1M tokens"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/lib/openai101/{config/openai.rb → initializer.rb}

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 require 'dotenv'
-# Dotenv.load(".env.#{ENV['APP_ENV']}") # Loads environment-specific dotenv file.
+
 Dotenv.load('.env')
 
 OpenAI.configure do |config|
   tools_enabled = ENV.fetch('TOOLS_ENABLED', 'false')
 
   if tools_enabled == 'true'
-    puts 'OpenAI Tools are enabled'
     config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
     config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID', nil)
   end
+
+  puts "Initializing OpenAI with tools #{tools_enabled == 'true' ? 'enabled' : 'disabled'}"
 end

data/lib/openai101/models/completion_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Openai101
+  module Models
+    # Parameters for the OpenAI API
+    class CompletionParams < Openai101::Types::BaseModel
+      # attribute :platform, :string, default: 'openai'
+      attribute :model, :string
+      attribute :prompt, :string
+      attribute :temperature, :float, default: 1.0
+      attribute :max_tokens, :integer, default: 256
+      attribute :top_p, :float, default: 1.0
+      attribute :best_of, :integer, default: 1
+      attribute :frequency_penalty, :float, default: 0.0
+      attribute :presence_penalty, :float, default: 0.0
+    end
+  end
+end

data/lib/openai101/types/array_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Openai101
+  module Types
+    # Used by the ActiveModel attributes API to cast values to arrays
+    class ArrayType < ActiveModel::Type::Value
+      def cast(value)
+        case value
+        when String
+          value.split(',')
+        when Array
+          value
+        else
+          raise ArgumentError, "Cannot cast #{value.class} to Array"
+        end
+      end
+
+      def serialize(value)
+        value.join(',')
+      end
+    end
+  end
+end
+
+ActiveModel::Type.register(:array, Openai101::Types::ArrayType)

data/lib/openai101/types/base_model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Openai101
+  module Types
+    # Used by the ActiveModel attributes API to cast values to hashes
+    class BaseModel
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+    end
+  end
+end

data/lib/openai101/types/hash_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Openai101
+  module Types
+    # Used by the ActiveModel attributes API to cast values to hashes
+    class HashType < ActiveModel::Type::Value
+      def cast(value)
+        case value
+        when String
+          JSON.parse(value)
+        when Hash
+          value
+        else
+          raise ArgumentError, "Cannot cast #{value.class} to Hash"
+        end
+      end
+
+      def serialize(value)
+        value.to_json
+      end
+    end
+  end
+end
+
+ActiveModel::Type.register(:hash, Openai101::Types::HashType)

data/lib/openai101/usecases/scrape_model_metrics.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Read the model metrics from
+# https://platform.openai.com/docs/models
+# https://openai.com/api/pricing

data/lib/openai101/usecases/token_counter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# Read: https://platform.openai.com/docs/guides/text-generation/managing-tokens

data/lib/openai101/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openai101
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/lib/openai_101.rb

@@ -7,9 +7,15 @@ require 'csv'
 require 'json'
 require 'table_print'
 require 'pry'
+require 'active_model'
 
 require 'openai101/version'
-require 'openai101/sample'
+require 'openai101/initializer'
+require 'openai101/types/hash_type'
+require 'openai101/types/array_type'
+require 'openai101/types/base_model'
+
+require 'openai101/models/completion_params'
 
 module Openai101
   # raise Openai101::Error, 'Sample message'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "openai_101",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "openai_101",
-      "version": "1.2.3",
+      "version": "1.2.4",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.3",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai_101",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "OpenAI 101 working through the API endpoints",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai_101
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - David Cruwys
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  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'
 - !ruby/object:Gem::Dependency
   name: clipboard
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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'
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -89,8 +145,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/openai101/config/openai.rb
-- lib/openai101/sample.rb
+- config/openai-cost.json
+- lib/openai101/initializer.rb
+- lib/openai101/models/completion_params.rb
+- lib/openai101/types/array_type.rb
+- lib/openai101/types/base_model.rb
+- lib/openai101/types/hash_type.rb
+- lib/openai101/usecases/scrape_model_metrics.rb
+- lib/openai101/usecases/token_counter.rb
 - lib/openai101/version.rb
 - lib/openai_101.rb
 - package-lock.json

data/lib/openai101/sample.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Openai101
-  # Testing the Sample class
-  class Sample
-    def self.hello
-      'Hello, World!'
-    end
-  end
-end