cohere-ruby 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02ed5a633d1adf0626506a7f1d6023b268b54c3f7c3320086ef5a63240d8e024
+  data.tar.gz: c6105abcfaefd5996eeba2fa8cac19e64debcf0a0e4d68f73cc12b340b521305
+SHA512:
+  metadata.gz: 27d9ac0456381e1b1734b88432832a9623fc66c87a437747a3e6b64103dce806920fcb208531a8eb7c19befbcc595cd35a653fb2ab4e8d8cd167c2c7c194214c
+  data.tar.gz: be9555d9ac14e534c70afe1df520666ff893abc60a54161435bcce45b0973974722cbd81565f74793699b49d23e3e6871957ee5d10010da63eeb8c352a665a7c

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cohere.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.28.0"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    cohere-ruby (0.9.0)
+      faraday (~> 2.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.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.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      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.50.2)
+      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.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.28.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  cohere-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.28.0)
+
+BUNDLED WITH
+   2.4.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrei Bondarev
+
+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,111 @@
+# Cohere
+
+<p>
+    <img alt='Weaviate logo' src='https://static.wikia.nocookie.net/logopedia/images/d/d4/Cohere_2023.svg/revision/latest?cb=20230419182227' height='50' />
+    +&nbsp;&nbsp;
+    <img alt='Ruby logo' src='https://user-images.githubusercontent.com/541665/230231593-43861278-4550-421d-a543-fd3553aac4f6.png' height='40' />
+</p>
+
+Cohere API client for Ruby.
+
+![Tests status](https://github.com/andreibondarev/cohere-ruby/actions/workflows/ci.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/cohere-ruby.svg)](https://badge.fury.io/rb/cohere-ruby)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cohere-ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cohere-ruby
+
+## Usage
+
+### Instantiating API client
+```ruby
+client = Cohere::Client.new(
+  api_key: ENV['COHERE_API_KEY']
+)
+```
+### Generate
+```ruby
+client.generate(
+    prompt: "Once upon a time in a magical land called"
+)
+```
+
+### Embed
+```ruby
+client.embed(
+    texts: ["hello!"]
+)
+```
+
+### Classify
+```ruby
+examples = [
+    { text: "Dermatologists don't like her!", label: "Spam" },
+    { text: "Hello, open to this?", label: "Spam" },
+    { text: "I need help please wire me $1000 right now", label: "Spam" },
+    { text: "Nice to know you ;)", label: "Spam" },
+    { text: "Please help me?", label: "Spam" },
+    { text: "Your parcel will be delivered today", label: "Not spam" },
+    { text: "Review changes to our Terms and Conditions", label: "Not spam" },
+    { text: "Weekly sync notes", label: "Not spam" },
+    { text: "Re: Follow up from today's meeting", label: "Not spam" },
+    { text: "Pre-read for tomorrow", label: "Not spam" }
+]
+
+inputs = [
+  "Confirm your email address",
+  "hey i need u to send some $",
+]
+
+client.classify(
+    examples: examples,
+    inputs: inputs
+)
+```
+
+### Tokenize
+```ruby
+client.tokenize(
+    text: "hello world!"
+)
+```
+
+### Detokenize
+```ruby
+client.detokenize(
+    tokens: [33555, 1114 , 34]
+)
+```
+
+### Detect language
+```ruby
+client.detect_language(
+    texts: ["Здравствуй, Мир"]
+)
+```
+
+### Summarize
+```ruby
+client.summarize(
+    text: "..."
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec spec/` to run the tests. You can also 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, 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/andreibondarev/cohere.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/cohere/client.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Cohere
+  class Client
+    attr_reader :api_key, :connection
+
+    ENDPOINT_URL = "https://api.cohere.ai/v1"
+
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    # This endpoint generates realistic text conditioned on a given input.
+    def generate(
+      prompt:,
+      model: nil,
+      num_generations: nil,
+      max_tokens: nil,
+      preset: nil,
+      temperature: nil,
+      k: nil,
+      p: nil,
+      frequency_penalty: nil,
+      presence_penalty: nil,
+      end_sequences: nil,
+      stop_sequence: nil,
+      return_likelihoods: nil,
+      logit_bias: nil,
+      truncate: nil
+    )
+      response = connection.post("generate") do |req|
+        req.body = {prompt: prompt}
+        req.body[:model] = model if model
+        req.body[:num_generations] = num_generations if num_generations
+        req.body[:max_tokens] = max_tokens if max_tokens
+        req.body[:preset] = preset if preset
+        req.body[:temperature] = temperature if temperature
+        req.body[:k] = k if k
+        req.body[:p] = p if p
+        req.body[:frequency_penalty] = frequency_penalty if frequency_penalty
+        req.body[:presence_penalty] = presence_penalty if presence_penalty
+        req.body[:end_sequences] = end_sequences if end_sequences
+        req.body[:stop_sequence] = stop_sequence if stop_sequence
+        req.body[:return_likelihoods] = return_likelihoods if return_likelihoods
+        req.body[:logit_bias] = logit_bias if logit_bias
+        req.body[:truncate] = truncate if truncate
+      end
+      response.body
+    end
+
+    def embed(
+      texts:,
+      model: nil,
+      truncate: nil
+    )
+      response = connection.post("embed") do |req|
+        req.body = {texts: texts}
+        req.body[:model] = model if model
+        req.body[:truncate] = truncate if truncate
+      end
+      response.body
+    end
+
+    def classify(
+      inputs:,
+      examples:,
+      model: nil,
+      present: nil,
+      truncate: nil
+    )
+      response = connection.post("classify") do |req|
+        req.body = {
+          inputs: inputs,
+          examples: examples
+        }
+        req.body[:model] = model if model
+        req.body[:present] = present if present
+        req.body[:truncate] = truncate if truncate
+      end
+      response.body
+    end
+
+    def tokenize(text:)
+      response = connection.post("tokenize") do |req|
+        req.body = {text: text}
+      end
+      response.body
+    end
+
+    def detokenize(tokens:)
+      response = connection.post("detokenize") do |req|
+        req.body = {tokens: tokens}
+      end
+      response.body
+    end
+
+    def detect_language(texts:)
+      response = connection.post("detect-language") do |req|
+        req.body = {texts: texts}
+      end
+      response.body
+    end
+
+    def summarize(
+      text:,
+      length: nil,
+      format: nil,
+      model: nil,
+      extractiveness: nil,
+      temperature: nil,
+      additional_command: nil
+    )
+      response = connection.post("summarize") do |req|
+        req.body = {text: text}
+        req.body[:length] = length if length
+        req.body[:format] = format if format
+        req.body[:model] = model if model
+        req.body[:extractiveness] = extractiveness if extractiveness
+        req.body[:temperature] = temperature if temperature
+        req.body[:additional_command] = additional_command if additional_command
+      end
+      response.body
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: ENDPOINT_URL) do |faraday|
+        if api_key
+          faraday.request :authorization, :Bearer, api_key
+        end
+        faraday.request :json
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/cohere/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cohere
+  VERSION = "0.9.0"
+end

data/lib/cohere.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "cohere/version"
+
+module Cohere
+  class Error < StandardError; end
+  # Your code goes here...
+
+  autoload :Client, "cohere/client"
+end

data/sig/cohere.rbs

@@ -0,0 +1,4 @@
+module Cohere
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cohere-ruby
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Andrei Bondarev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Cohere API client for Ruby.
+email:
+- andrei.bondarev13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cohere.rb
+- lib/cohere/client.rb
+- lib/cohere/version.rb
+- sig/cohere.rbs
+homepage: https://github.com/andreibondarev/cohere-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreibondarev/cohere-ruby
+  source_code_uri: https://github.com/andreibondarev/cohere-ruby
+  changelog_uri: https://github.com/andreibondarev/cohere-ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Cohere API client for Ruby.
+test_files: []