aleph-alpha-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e249112ecb4fc8fd2f5e03c38011c806b663bbc73cf057205976a71ba7962cd3
+  data.tar.gz: e929f9628d68a6dc53d63dc25cd0ba7b193a48adb1fe398e7425b77b11540f1e
+SHA512:
+  metadata.gz: 02a9ddf75c2b9f79fe44d161af033b1d24111201a6e186f8e42540ace2442556301fd0a2e43f25911473f585dc1c3a484fd20ca351f158eb619711a007b8c3a9
+  data.tar.gz: c8e4161f1b032561b2e3c1a650e672d66d3aacab0315764288c8d95e4ee4ba0b6f0f4e21652db48285b024349e60d2211eb2ed8578f71eba1fc89cef01c628eb

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 140

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.6

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2023-05-21
+
+### Added
+
+- Initialise repository
+- Add tests and cached responses

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in aleph-alpha-ruby.gemspec
+gemspec
+
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.51"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    aleph-alpha-ruby (0.0.1)
+      faraday (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    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.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aleph-alpha-ruby!
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.51)
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Sascha
+
+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/README.md

@@ -0,0 +1,291 @@
+# Aleph Alpha Ruby Client
+
+<p align="center">
+  <img src="https://i.imgur.com/FSM2NNV.png" width="50%" />
+</p>
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "aleph-alpha-ruby"
+```
+
+And then execute:
+
+$ bundle install
+
+### Gem install
+
+Or install with:
+
+$ gem install aleph-alpha-ruby
+
+and require with:
+
+```ruby
+require "aleph-alpha"
+```
+
+## Usage
+
+- Get your API token from [https://app.aleph-alpha.com/profile](https://app.aleph-alpha.com/profile)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = AlephAlpha::Client.new(access_token: "access_token_goes_here")
+```
+
+### With Config
+
+```ruby
+AlephAlpha.configure do |config|
+  config.access_token = ENV.fetch("ALEPH_ALPHA_ACCESS_TOKEN")
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = AlephAlpha::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.
+
+```ruby
+client = AlephAlpha::Client.new(
+    access_token: "access_token_goes_here",
+    uri_base: "https://other-api-endpoint.aleph-alpha.com",
+    request_timeout: 240
+)
+```
+
+or when configuring the gem:
+
+```ruby
+AlephAlpha.configure do |config|
+    config.access_token = ENV.fetch("ALEPH_ALPHA_ACCESS_TOKEN")
+    config.uri_base = "https://other-api-endpoint.aleph-alpha.com" # Optional
+    config.request_timeout = 240 # Optional
+end
+```
+
+### Models
+
+There are different models that can be used to generate text. For a full list:
+
+```ruby
+client.models.list
+```
+
+### Current API version
+
+```ruby
+client.version
+```
+
+### Tokens
+
+#### Get a list of issued API tokens
+
+```ruby
+client.tokens.list
+```
+
+#### Create a new API token
+
+```ruby
+client.tokens.create(
+  parameters: {
+    description: "token used on my laptop"
+  }
+)
+```
+
+#### Delete an API token
+
+```ruby
+client.tokens.delete(id: 123)
+```
+
+### Users
+
+#### Get settings for own user
+
+```ruby
+client.users.me
+```
+
+#### Change settings for own user
+
+```ruby
+client.users.settings(
+  parameters: {
+    out_of_credits_threshold: 0
+  }
+)
+```
+
+#### Query Recent Usage
+
+```ruby
+client.users.usage
+```
+
+### Tasks
+
+#### Completion
+
+```ruby
+client.completions(
+  parameters: {
+    model: "model name",
+    prompt: "some text",
+    maximum_tokens: 64
+  }
+)
+```
+
+#### Embeddings
+
+```ruby
+client.embeddings(
+  parameters: {
+    model: "model name",
+    prompt: "some text",
+    layers: [
+      0,
+      1
+    ],
+    tokens: false,
+    pooling: [
+      "max"
+    ]
+  }
+)
+```
+
+#### Semantic Embeddings
+
+```ruby
+client.semantic_embeddings(
+  parameters: {
+    model: "model name",
+    prompt: "some text",
+    representation: "symmetric",
+    compress_to_size: 128
+  }
+)
+```
+
+#### Evaluate
+
+```ruby
+client.evaluate(
+  parameters: {
+    model: "model name",
+    prompt: "some text",
+    completion_expected: "another text"
+  }
+)
+```
+
+#### Explanation
+
+```ruby
+client.explain(
+  parameters: {
+    model: "model name",
+    hosting: "aleph-alpha",
+    prompt: "some text",
+    target: "string",
+    control_factor: 0.1,
+    contextual_control_threshold: 0,
+    control_log_additive: true,
+    postprocessing: "none",
+    normalize: false,
+    prompt_granularity: {
+      type: "token",
+      delimiter: "string"
+    },
+    target_granularity: "complete",
+    control_token_overlap: "partial"
+  }
+)
+```
+
+#### Tokenize
+
+```ruby
+client.tokenize(
+  parameters: {
+    model: "model name",
+    prompt: "some text",
+    tokens: true,
+    token_ids: true
+  }
+)
+```
+
+#### Detokenize
+
+```ruby
+client.detokenize(
+  parameters: {
+    model: model,
+    token_ids: [
+      556,
+      48_741,
+      247,
+      2983,
+      28_063,
+      301,
+      10_510,
+      5469,
+      17
+    ]
+  }
+)
+```
+
+#### Q&A
+
+```ruby
+client.qa(
+  parameters: {
+    query: "some text",
+    documents: [
+      {
+        text: "another text"
+      }
+    ]
+  }
+)
+```
+
+#### Summarize
+
+```ruby
+client.summarize(
+  parameters: {
+    model: "model name",
+    document: {
+      text: "Text about something..."
+    }
+  }
+)
+```
+
+## Contributing
+
+Initially, this gem is based on [ruby-openai](https://github.com/alexrudall/ruby-openai). I didn't want to reinvent the wheel and if possible have a similar API for convenience. Bug reports and pull requests are welcome on GitHub at <https://github.com/skorth/aleph-alpha-ruby>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/aleph-alpha/client.rb

@@ -0,0 +1,67 @@
+module AlephAlpha
+  class Client
+    extend AlephAlpha::HTTP
+
+    def initialize(access_token: nil, uri_base: nil, request_timeout: nil)
+      AlephAlpha.configuration.access_token = access_token if access_token
+      AlephAlpha.configuration.uri_base = uri_base if uri_base
+      AlephAlpha.configuration.request_timeout = request_timeout if request_timeout
+    end
+
+    def version
+      AlephAlpha::Client.get(path: "/version")
+    end
+
+    def tokens
+      @tokens ||= AlephAlpha::Tokens.new
+    end
+
+    def models
+      @models ||= AlephAlpha::Models.new
+    end
+
+    def users
+      @users ||= AlephAlpha::Users.new
+    end
+
+    def completions(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/complete?nice=#{nice}", parameters: parameters)
+    end
+
+    def embeddings(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/embed?nice=#{nice}", parameters: parameters)
+    end
+
+    def semantic_embeddings(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/semantic_embed?nice=#{nice}", parameters: parameters)
+    end
+
+    def evaluate(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/evaluate?nice=#{nice}", parameters: parameters)
+    end
+
+    def explain(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/explain?nice=#{nice}", parameters: parameters)
+    end
+
+    def tokenize(parameters: {})
+      AlephAlpha::Client.json_post(path: "/tokenize", parameters: parameters)
+    end
+
+    def detokenize(parameters: {})
+      AlephAlpha::Client.json_post(path: "/detokenize", parameters: parameters)
+    end
+
+    def qa(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/qa?nice=#{nice}", parameters: parameters)
+    end
+
+    def summarize(parameters: {}, nice: false)
+      AlephAlpha::Client.json_post(path: "/summarize?nice=#{nice}", parameters: parameters)
+    end
+
+    def permissions(parameters: [])
+      AlephAlpha::Client.json_post(path: "/check_privileges", parameters: parameters)
+    end
+  end
+end

data/lib/aleph-alpha/http.rb

@@ -0,0 +1,56 @@
+module AlephAlpha
+  module HTTP
+    def get(path:)
+      to_json(conn.get(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    def json_post(path:, parameters:)
+      to_json(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    def json_patch(path:, parameters:)
+      to_json(conn.patch(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    def delete(path:)
+      to_json(conn.delete(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    private
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{AlephAlpha.configuration.access_token}"
+      }
+    end
+
+    def uri(path:)
+      AlephAlpha.configuration.uri_base + path
+    end
+
+    def to_json(string)
+      return unless string
+
+      JSON.parse(string)
+    rescue JSON::ParserError
+      string
+    end
+
+    def conn
+      Faraday.new do |f|
+        f.options[:timeout] = AlephAlpha.configuration.request_timeout
+      end
+    end
+  end
+end

data/lib/aleph-alpha/models.rb

@@ -0,0 +1,11 @@
+module AlephAlpha
+  class Models
+    def initialize(access_token: nil)
+      AlephAlpha.configuration.access_token = access_token if access_token
+    end
+
+    def list
+      AlephAlpha::Client.get(path: "/models_available")
+    end
+  end
+end

data/lib/aleph-alpha/tokens.rb

@@ -0,0 +1,19 @@
+module AlephAlpha
+  class Tokens
+    def initialize(access_token: nil)
+      AlephAlpha.configuration.access_token = access_token if access_token
+    end
+
+    def list
+      AlephAlpha::Client.get(path: "/users/me/tokens")
+    end
+
+    def create(parameters: {})
+      AlephAlpha::Client.json_post(path: "/users/me/tokens", parameters: parameters)
+    end
+
+    def delete(id:)
+      AlephAlpha::Client.delete(path: "/users/me/tokens/#{id}")
+    end
+  end
+end

data/lib/aleph-alpha/users.rb

@@ -0,0 +1,19 @@
+module AlephAlpha
+  class Users
+    def initialize(access_token: nil)
+      AlephAlpha.configuration.access_token = access_token if access_token
+    end
+
+    def me
+      AlephAlpha::Client.get(path: "/users/me")
+    end
+
+    def usage
+      AlephAlpha::Client.get(path: "/users/me/requests")
+    end
+
+    def settings(parameters: {})
+      AlephAlpha::Client.json_patch(path: "/users/me", parameters: parameters)
+    end
+  end
+end

data/lib/aleph-alpha/version.rb

@@ -0,0 +1,3 @@
+module AlephAlpha
+  VERSION = "0.0.1".freeze
+end

data/lib/aleph-alpha.rb

@@ -0,0 +1,46 @@
+require "faraday"
+
+require_relative "aleph-alpha/version"
+require_relative "aleph-alpha/http"
+require_relative "aleph-alpha/client"
+require_relative "aleph-alpha/tokens"
+require_relative "aleph-alpha/models"
+require_relative "aleph-alpha/users"
+
+module AlephAlpha
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :access_token
+    attr_accessor :uri_base, :request_timeout
+
+    DEFAULT_URI_BASE = "https://api.aleph-alpha.com".freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @access_token = nil
+      @uri_base = DEFAULT_URI_BASE
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+    end
+
+    def access_token
+      return @access_token if @access_token
+
+      error_text = "AlephAlpha access token missing!"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= AlephAlpha::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: aleph-alpha-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sascha Korth
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- korth.sascha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/aleph-alpha.rb
+- lib/aleph-alpha/client.rb
+- lib/aleph-alpha/http.rb
+- lib/aleph-alpha/models.rb
+- lib/aleph-alpha/tokens.rb
+- lib/aleph-alpha/users.rb
+- lib/aleph-alpha/version.rb
+homepage: https://github.com/skorth/aleph-alpha-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skorth/aleph-alpha-ruby
+  source_code_uri: https://github.com/skorth/aleph-alpha-ruby
+  changelog_uri: https://github.com/skorth/aleph-alpha-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Aleph Alpha Ruby Client
+test_files: []