gpt-function 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c69d609f72da6694cb8dd2c81ad8e22a43eef447f5579df9376e1275c20816
-  data.tar.gz: 8e2e07edf55e59fa81bbe00e6f10a39e190926a312f30e038b216d4e1c50149c
+  metadata.gz: 4a9ccc7b67016c8c4168becde657818045cd2053c0362d7e3f43ccec17932ff3
+  data.tar.gz: a39fe4ac8a9587a4ea6cf1a4fd17f5263f04548ceea48de3f058d487241283d7
 SHA512:
-  metadata.gz: 51f4d097f90ee274e6a4d199ba6bca2f4d2050a6aab67e07597596d745711c8f1001000b489e3a7fce00d0b7da8232806fa5c0da20d419af87ff77d3c437e104
-  data.tar.gz: cdb7ab8b59f152c8a3f59b5944abdc6473a664f80a68027895d76db5bb2b403e8bbec6a24f0ffa24beb76ecc477ee4043dd9ff4422bfcb786d1f9888a1baf68c
+  metadata.gz: a24119fb39f7249c81a4e51ec2e99ef794fb73f17682136943c067a767aafae5802c6f0898a7ca1e28f67af89c552ced79cde5a9849152503be41c2e49a7ca9f
+  data.tar.gz: e1dbc17085f6a72d769169d3f41713c05b92731663dfdf2e0798c361a7f0d27c29554483daab1950564d5d1c5550dd98fe249e271a2c3173bf8b9705d0807012

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gpt-function.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "byebug", "~> 11.1"
+
+gem "webmock", "~> 3.19"

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    gpt-function (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      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)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  gpt-function!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 3.19)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 etrex kuo
+
+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/Rakefile

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

data/gpt-function.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/gpt/function/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gpt-function"
+  spec.version = Gpt::Function::VERSION
+  spec.authors = ["etrex kuo"]
+  spec.email = ["et284vu065k3@gmail.com"]
+
+  spec.summary = "A Ruby gem for creating simple GPT-based functions."
+  spec.description = "This gem allows users to create simple and complex GPT functions " \
+                   "for various applications such as translation and keyword extraction."
+  spec.homepage = "https://github.com/etrex/gpt-function"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gpt/function/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gpt
+  class Function
+    VERSION = "0.1.1"
+  end
+end

data/lib/gpt/function.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require_relative "function/version"
+
+module Gpt
+  # 這是一個簡單的 GPT 函數類別
+  class Function
+    @api_key = nil
+    @model = nil
+
+    class << self
+      attr_accessor :api_key, :model
+
+      def configure(api_key:, model:)
+        @api_key = api_key
+        @model = model
+      end
+    end
+
+    def initialize(prompt, examples = [], temperature = 0)
+      @temperature = temperature
+      @messages = [
+        {
+          role: "system",
+          content: "#{prompt}\n Note: The response format is always a JSON with the key output like this:{output: ...}"
+        },
+        *examples.flat_map do |example|
+          [
+            {
+              role: "user",
+              content: example[0]
+            },
+            {
+              role: "assistant",
+              content: { output: example[1] }.to_json
+            }
+          ]
+        end
+      ]
+    end
+
+    def call(input)
+      # 使用類別級別的變量來發送請求
+      response = send_request(input)
+      body = response.body.force_encoding("UTF-8")
+      json = JSON.parse(body)
+      # 處理可能的錯誤回應
+      raise StandardError, json.dig("error", "message") if json.dig("error", "code")
+
+      # 處理正常的回應
+      JSON.parse(json.dig("choices", 0, "message", "content"))["output"]
+    end
+
+    private
+
+    def send_request(input)
+      uri = URI.parse("https://api.openai.com/v1/chat/completions")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request["Authorization"] = "Bearer #{Function.api_key}"
+      request.body = {
+        model: Function.model,
+        response_format: {
+          type: "json_object"
+        },
+        seed: 0,
+        messages: [
+          *@messages,
+          {
+            "role": "user",
+            "content": input
+          }
+        ],
+        temperature: @temperature
+      }.to_json
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+        open_timeout: 60, # opening a connection timeout
+        read_timeout: 300 # reading one block of response timeout
+      }
+
+      Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+    end
+  end
+end

data/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2.1'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpt-function
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - etrex kuo
@@ -18,7 +18,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- gpt-function.gemspec
+- lib/gpt/function.rb
+- lib/gpt/function/version.rb
+- workflows/main.yml
 homepage: https://github.com/etrex/gpt-function
 licenses:
 - MIT