cohere-ai 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5326901fa2fcef2d71d74de376e3ca9df19d9adb65fe6cf5e1a6d0bd195b8d6
-  data.tar.gz: 78e162ac160c691b0060945511059a9ea185ee44105298bbf784f3a8e86fbf5a
+  metadata.gz: 3ea877fce85c65fa6b22f580d335c1e4d2445f60b85df8db0025cd4e1acb93d6
+  data.tar.gz: 435e4efc2cf75f18fd6ed283e915975ffda1561c868bbfd9cc7b691295fa0ea2
 SHA512:
-  metadata.gz: 9cff2fb206e5daa899b440b27280c9b155b012364319da3536e28875a14cbebbb6c6f2a00e07409ec1edc501cd9c9a87154fbd31a28c084985bf8eccab627d28
-  data.tar.gz: 71453d884fd1bd3e76a9c78c5c9752dd6b695d887a1448aa12d3b0421a788f3da9306a6796beebbd0335537fa81a67ddb92dd68fd965e5e9b65d26169ff58640
+  metadata.gz: 74d7b9593bae09f94e6d0c9c60f060a5118f4772be5a8fb8125a0bd96161ba0ac578f8d094a52c9f9312e2fa4c7cb4a35307b078ad7a339bb30309f37a45fae2
+  data.tar.gz: e23ee1214c25cf3cde1005a7847dd5a6d752c2e1b3a9e1bb1746ba6c6049c8784a46d8f27c96156c6900f20c91255b01fa5c569779dcb3693650338105b3b717

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 .devcontainer
+.env

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
+  gem 'dotenv', '~> 2.8', '>= 2.8.1'
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rubocop', '~> 1.58'
+  gem 'rubocop', '~> 1.60', '>= 1.60.2'
 end

data/Gemfile.lock

@@ -1,26 +1,34 @@
 PATH
   remote: .
   specs:
-    cohere-ai (1.0.1)
-      faraday (~> 2.8, >= 2.8.1)
+    cohere-ai (1.1.0)
+      faraday (~> 2.9)
+      faraday-typhoeus (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    dotenv (2.8.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    faraday-typhoeus (1.1.0)
+      faraday (~> 2.0)
+      typhoeus (~> 1.4)
+    ffi (1.16.3)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
+    net-http (0.4.1)
+      uri
     parallel (1.24.0)
-    parser (3.2.2.4)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -31,13 +39,13 @@ GEM
       pry (>= 0.13, < 0.15)
     racc (1.7.3)
     rainbow (3.1.1)
-    regexp_parser (2.8.3)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.59.0)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
@@ -47,16 +55,19 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
     unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   cohere-ai!
+  dotenv (~> 2.8, >= 2.8.1)
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.58)
+  rubocop (~> 1.60, >= 1.60.2)
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -9,7 +9,7 @@ A Ruby gem for interacting with [Cohere AI](https://cohere.com).
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'cohere-ai', '~> 1.0.1'
+gem 'cohere-ai', '~> 1.1.0'
 ```
 
 ```ruby
@@ -46,39 +46,40 @@ Result:
 - [TL;DR and Quick Start](#tldr-and-quick-start)
 - [Index](#index)
 - [Setup](#setup)
-    - [Installing](#installing)
-    - [Credentials](#credentials)
+  - [Installing](#installing)
+  - [Credentials](#credentials)
 - [Usage](#usage)
-    - [Client](#client)
-        - [Custom Address](#custom-address)
-    - [Methods](#methods)
-        - [chat](#chat)
-            - [Without Streaming Events](#without-streaming-events)
-            - [Receiving Stream Events](#receiving-stream-events)
-        - [generate](#generate)
-        - [embed](#embed)
-        - [rerank](#rerank)
-        - [classify](#classify)
-        - [detect_language](#detect_language)
-        - [summarize](#summarize)
-        - [tokenize](#tokenize)
-        - [detokenize](#detokenize)
-    - [Datasets](#datasets)
-    - [Connectors](#connectors)
-    - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
-        - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
-    - [Back-and-Forth Conversations](#back-and-forth-conversations)
-    - [New Functionalities and APIs](#new-functionalities-and-apis)
-    - [Request Options](#request-options)
-        - [Timeout](#timeout)
-    - [Error Handling](#error-handling)
-        - [Rescuing](#rescuing)
-        - [For Short](#for-short)
-        - [Errors](#errors)
+  - [Client](#client)
+    - [Custom Address](#custom-address)
+  - [Methods](#methods)
+    - [chat](#chat)
+      - [Without Streaming Events](#without-streaming-events)
+      - [Receiving Stream Events](#receiving-stream-events)
+    - [generate](#generate)
+    - [embed](#embed)
+    - [rerank](#rerank)
+    - [classify](#classify)
+    - [detect_language](#detect_language)
+    - [summarize](#summarize)
+    - [tokenize](#tokenize)
+    - [detokenize](#detokenize)
+  - [Datasets](#datasets)
+  - [Connectors](#connectors)
+  - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
+    - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
+  - [Back-and-Forth Conversations](#back-and-forth-conversations)
+  - [New Functionalities and APIs](#new-functionalities-and-apis)
+  - [Request Options](#request-options)
+    - [Adapter](#adapter)
+    - [Timeout](#timeout)
+  - [Error Handling](#error-handling)
+    - [Rescuing](#rescuing)
+    - [For Short](#for-short)
+    - [Errors](#errors)
 - [Development](#development)
-    - [Purpose](#purpose)
-    - [Publish to RubyGems](#publish-to-rubygems)
-    - [Updating the README](#updating-the-readme)
+  - [Purpose](#purpose)
+  - [Publish to RubyGems](#publish-to-rubygems)
+  - [Updating the README](#updating-the-readme)
 - [Resources and References](#resources-and-references)
 - [Disclaimer](#disclaimer)
 
@@ -87,11 +88,11 @@ Result:
 ### Installing
 
 ```sh
-gem install cohere-ai -v 1.0.1
+gem install cohere-ai -v 1.1.0
 ```
 
 ```sh
-gem 'cohere-ai', '~> 1.0.1'
+gem 'cohere-ai', '~> 1.1.0'
 ```
 
 ### Credentials
@@ -617,6 +618,21 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+The gem uses [Faraday](https://github.com/lostisland/faraday) with the [Typhoeus](https://github.com/typhoeus/typhoeus) adapter by default.
+
+You can use a different adapter if you want:
+
+```ruby
+require 'faraday/net_http'
+
+client = Cohere.new(
+  credentials: { api_key: ENV['COHERE_API_KEY'] },
+  options: { connection: { adapter: :net_http } }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -704,6 +720,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -717,7 +735,7 @@ gem build cohere-ai.gemspec
 
 gem signin
 
-gem push cohere-ai-1.0.1.gem
+gem push cohere-ai-1.1.0.gem
 ```
 
 ### Updating the README

data/cohere-ai.gemspec

@@ -29,7 +29,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['ports/dsl']
 
-  spec.add_dependency 'faraday', '~> 2.8', '>= 2.8.1'
+  spec.add_dependency 'faraday', '~> 2.9'
+  spec.add_dependency 'faraday-typhoeus', '~> 1.1'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/controllers/client.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday/typhoeus'
 require 'json'
 
-require_relative '../ports/dsl/cohere-ai/errors'
+require_relative '../components/errors'
 
 module Cohere
   module Controllers
@@ -12,6 +13,8 @@ module Cohere
 
       ALLOWED_REQUEST_OPTIONS = %i[timeout open_timeout read_timeout write_timeout].freeze
 
+      DEFAULT_FARADAY_ADAPTER = :typhoeus
+
       def initialize(config)
         @api_key = config.dig(:credentials, :api_key)
         @server_sent_events = config.dig(:options, :server_sent_events)
@@ -23,7 +26,7 @@ module Cohere
                    end
 
         if @api_key.nil? && @address == "#{DEFAULT_ADDRESS}/"
-          raise MissingAPIKeyError, 'Missing API Key, which is required.'
+          raise Errors::MissingAPIKeyError, 'Missing API Key, which is required.'
         end
 
         @request_options = config.dig(:options, :connection, :request)
@@ -35,6 +38,8 @@ module Cohere
                            else
                              {}
                            end
+
+        @faraday_adapter = config.dig(:options, :connection, :adapter) || DEFAULT_FARADAY_ADAPTER
       end
 
       def chat(payload, server_sent_events: nil, &callback)
@@ -80,7 +85,7 @@ module Cohere
         url = "#{@address}#{path}"
 
         if !callback.nil? && !server_sent_events_enabled
-          raise BlockWithoutServerSentEventsError,
+          raise Errors::BlockWithoutServerSentEventsError,
                 'You are trying to use a block without Server Sent Events (SSE) enabled.'
         end
 
@@ -91,6 +96,7 @@ module Cohere
         partial_json = ''
 
         response = Faraday.new(request: @request_options) do |faraday|
+          faraday.adapter @faraday_adapter
           faraday.response :raise_error
         end.send(method_to_call) do |request|
           request.url url
@@ -109,14 +115,16 @@ module Cohere
 
               partial_json += chunk
 
-              parsed_json = safe_parse_json(partial_json)
+              parsed_jsons = safe_parse_jsonl(partial_json)
 
-              if parsed_json
-                result = { event: parsed_json, raw: { chunk:, bytes:, env: } }
+              if parsed_jsons
+                parsed_jsons.each do |parsed_json|
+                  result = { event: parsed_json, raw: { chunk:, bytes:, env: } }
 
-                callback.call(result[:event], result[:raw]) unless callback.nil?
+                  callback.call(result[:event], result[:raw]) unless callback.nil?
 
-                results << result
+                  results << result
+                end
 
                 partial_json = ''
               end
@@ -126,11 +134,11 @@ module Cohere
 
         return safe_parse_json_with_fallback_to_raw(response.body) unless server_sent_events_enabled
 
-        raise IncompleteJSONReceivedError, partial_json if partial_json != ''
+        raise Errors::IncompleteJSONReceivedError, partial_json if partial_json != ''
 
         results.map { |result| result[:event] }
       rescue Faraday::ServerError => e
-        raise RequestError.new(e.message, request: e, payload:)
+        raise Errors::RequestError.new(e.message, request: e, payload:)
       end
 
       def safe_parse_json_with_fallback_to_raw(raw)
@@ -139,8 +147,8 @@ module Cohere
         raw
       end
 
-      def safe_parse_json(raw)
-        raw.to_s.lstrip.start_with?('{', '[') ? JSON.parse(raw) : nil
+      def safe_parse_jsonl(raw)
+        raw.to_s.lstrip.start_with?('{', '[') ? raw.split("\n").map { |line| JSON.parse(line) } : raw
       rescue JSON::ParserError
         nil
       end

data/static/gem.rb

@@ -3,7 +3,7 @@
 module Cohere
   GEM = {
     name: 'cohere-ai',
-    version: '1.0.1',
+    version: '1.1.0',
     author: 'gbaptista',
     summary: 'Interact with Cohere AI.',
     description: 'A Ruby gem for interacting with Cohere AI platform.',

data/tasks/generate-readme.clj

@@ -23,7 +23,7 @@
                              (remove nil?))]
     (->> processed-lines
          (map (fn [{:keys [level title link]}]
-                (str (apply str (repeat (* 4 (- level 2)) " "))
+                (str (apply str (repeat (* 2 (- level 2)) " "))
                      "- ["
                      title
                      "](#"

data/template.md

@@ -9,7 +9,7 @@ A Ruby gem for interacting with [Cohere AI](https://cohere.com).
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'cohere-ai', '~> 1.0.1'
+gem 'cohere-ai', '~> 1.1.0'
 ```
 
 ```ruby
@@ -50,11 +50,11 @@ Result:
 ### Installing
 
 ```sh
-gem install cohere-ai -v 1.0.1
+gem install cohere-ai -v 1.1.0
 ```
 
 ```sh
-gem 'cohere-ai', '~> 1.0.1'
+gem 'cohere-ai', '~> 1.1.0'
 ```
 
 ### Credentials
@@ -580,6 +580,21 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+The gem uses [Faraday](https://github.com/lostisland/faraday) with the [Typhoeus](https://github.com/typhoeus/typhoeus) adapter by default.
+
+You can use a different adapter if you want:
+
+```ruby
+require 'faraday/net_http'
+
+client = Cohere.new(
+  credentials: { api_key: ENV['COHERE_API_KEY'] },
+  options: { connection: { adapter: :net_http } }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -667,6 +682,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -680,7 +697,7 @@ gem build cohere-ai.gemspec
 
 gem signin
 
-gem push cohere-ai-1.0.1.gem
+gem push cohere-ai-1.1.0.gem
 ```
 
 ### Updating the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cohere-ai
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - gbaptista
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,22 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '1.1'
 description: A Ruby gem for interacting with Cohere AI platform.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -59,7 +67,7 @@ metadata:
   homepage_uri: https://github.com/gbaptista/cohere-ai
   source_code_uri: https://github.com/gbaptista/cohere-ai
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - ports/dsl
@@ -75,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Interact with Cohere AI.
 test_files: []