inferkit-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ce20468e408077f0666ee2be5e6ec4fc7de060072fe866b8a142c159c7b1dc9
+  data.tar.gz: 4640e79ce055f83a163aadcab616b185ee4f884490ee700c52b3f20ca59e13a4
+SHA512:
+  metadata.gz: 5f9a16ff20e85cb275142c8f8411c709a555eeb7de6f9826e1e720600b5bd17cf47974768d6cf7e72731303f8c447075f2fe792d1138718372768876020a3bd5
+  data.tar.gz: 69e3ee95fc9af97e4ae0be52589d5a880c58f7354554b2f4d3e9ae0dd38fa39802dba29ade69a61a0d2e2ea2326521be0029a286a5e48838eb09b7d58e4ce287

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+yarn.lock
+node_modules

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,127 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - Rakefile
+    - Guardfile
+    - bin/*
+    - tmp/**/*
+    - node_modules/**/*
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions:
+    rubocop-sequel: false
+
+Style:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+    - "Rakefile"
+    - "*.gemspec"
+    - "apps/api/application.rb"
+    - "**/*.rake"
+
+Metrics/ClassLength:
+  CountComments: false
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+Metrics/MethodLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+Metrics/ModuleLength:
+  CountComments: false
+  Exclude:
+    - "spec/**/*.rb"
+    - "test/**/*.rb"
+
+# RSpec config
+# When adding a new setting below here, please provide a reason with it.
+
+# Excluded for some folders because we want this rule only for unit specs
+RSpec/DescribeClass:
+  Exclude:
+    - spec/features/*
+    - spec/integration/*
+
+# Avoid filename issues with Minitest filenames
+RSpec/FilePath:
+  Exclude:
+    - "test/**/*.rb"
+
+# Next to the advantages, the check for verified doubles also means that
+# something about Y being checked in a spec that is about X, which is not
+# really clean. So it's not enabled by default.
+# refs https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+# There are cases for meta-programming where adding an empty class is useful and
+# should be allowed.
+Lint/EmptyClass:
+  Enabled: false
+
+# The standard library has methods like `iso8601` which trigger this rule, so
+# it's better to allow iso8601 for those as well as things like `foo_2` in our # code
+Naming/VariableNumber:
+  Enabled: false
+
+###
+# Disabled initially
+###
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.0.1
+nodejs 15.14.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# inferkit-ruby
+
+This gem is a Ruby wrapper for [InferKit](https://inferkit.com/), an AI-based
+text generator.
+
+## Installation
+
+```
+gem install inferkit-ruby
+```
+
+## Requirements
+
+- Ruby 3.0.0 or higher
+- An InferKit API-Key
+
+## Usage
+
+```
+require 'inferkit'
+require 'inferkit/client'
+
+Inferkit.configure(api_key: 'YOUR_INFERKIT_API_KEY')
+
+client = Inferkit::Client.new
+puts client.generate('This is the story of',
+  length: 500,
+  start_from_beginning: true,
+  force_no_end: false,
+  top_p: 0.8,
+  temperature: 1.5
+)
+```
+
+## Configuration
+
+You can provide your API-key as parameter when calling `Inferkit.configure` as in the example above. Or you can set the `INFERKIT_API_KEY` environment variable and call `Inferkit.configure` without parameter.
+
+## Generating text
+
+You generate text by calling the `generate` method of `Inferkit::Client` and providing a text prompt. All additional parameters, such as length, are optional.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+task :version do
+  puts Gem::Specification.load('inferkit-ruby.gemspec').version
+end
+
+module Bundler
+  class GemHelper
+    def install
+      desc "Build #{name}-#{version}.gem into the pkg directory."
+      task 'build' do
+        build_gem
+      end
+
+      GemHelper.instance = self
+    end
+  end
+end
+
+Bundler::GemHelper.install_tasks

data/inferkit-ruby.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/inferkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'inferkit-ruby'
+  spec.version = Inferkit::VERSION
+  spec.authors = ['Thomas Frütel']
+  spec.email = %w[tom@fruetel.de]
+
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.summary = 'Ruby wrapper for https://inferkit.com/'
+  spec.description = 'This gem is a Ruby wrapper for InferKit, an AI-based text generator.'
+  spec.homepage = 'https://github.com/Fruetel/inferkit-ruby'
+
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(spec|Dockerfile)/})
+      end
+    end
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '>= 1.0.0'
+  spec.add_development_dependency 'rubocop-performance', '>= 1.9.1'
+  spec.add_development_dependency 'rubocop-rake', '>= 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.0.0'
+  spec.add_development_dependency 'webmock', '>= 3.0.0'
+
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'oj', '~>3.10'
+end

data/lib/inferkit.rb

@@ -0,0 +1,4 @@
+require 'inferkit/version'
+require 'inferkit/configuration'
+
+module Inferkit; end

data/lib/inferkit/client.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require 'json'
+require 'oj'
+
+module Inferkit
+  class Client
+    HOST = 'https://api.inferkit.com'
+    GENERATE_ENDPOINT = '/v1/models/standard/generate'
+
+    def generate(prompt, **params)
+      request_params = default_params.merge(params)
+
+      response =
+        conn.post(GENERATE_ENDPOINT) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Authorization'] =
+            "Bearer #{Inferkit.configuration.api_key}"
+          req.body = generate_body(prompt, request_params)
+        end
+
+      Oj.load(response.body, symbol_keys: true).dig(:data, :text)
+    end
+
+    private
+
+    def default_params
+      {
+        length: 200,
+        start_from_beginning: false,
+        force_no_end: false,
+        top_p: 0.9,
+        temperature: 1.0
+      }
+    end
+
+    def generate_body(prompt, request_params)
+      {
+        prompt: { text: prompt },
+        length: request_params.fetch(:length),
+        startFromBeginning: request_params.fetch(:start_from_beginning),
+        forceNoEnd: request_params.fetch(:force_no_end),
+        topP: request_params.fetch(:top_p),
+        temperature: request_params.fetch(:temperature)
+      }.to_json
+    end
+
+    def conn
+      @conn ||= Faraday.new(HOST, request: { timeout: 90 })
+    end
+  end
+end

data/lib/inferkit/configuration.rb

@@ -0,0 +1,18 @@
+module Inferkit
+  class << self
+    attr_reader :configuration
+
+    def configure(api_key: nil)
+      @configuration =
+        Inferkit::Configuration.new(api_key || ENV['INFERKIT_API_KEY'])
+    end
+  end
+
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+  end
+end

data/lib/inferkit/version.rb

@@ -0,0 +1,3 @@
+module Inferkit
+  VERSION = '0.0.1'
+end

data/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "queue-store",
+  "private": true,
+  "scripts": {
+    "prettify": "prettier \"**/*.{ru,rb,yml,yaml,md}\" --ignore-path=\".gitignore\"",
+    "lint": "yarn prettify --check",
+    "format": "yarn prettify --write"
+  },
+  "devDependencies": {
+    "@prettier/plugin-ruby": "^0.20.1",
+    "prettier": "^2.2.0"
+  }
+}

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: inferkit-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Frütel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: This gem is a Ruby wrapper for InferKit, an AI-based text generator.
+email:
+- tom@fruetel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- README.md
+- Rakefile
+- inferkit-ruby.gemspec
+- lib/inferkit.rb
+- lib/inferkit/client.rb
+- lib/inferkit/configuration.rb
+- lib/inferkit/version.rb
+- package.json
+homepage: https://github.com/Fruetel/inferkit-ruby
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for https://inferkit.com/
+test_files: []