mistral-ai 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35454c7499ef405271de5ccb410f77dcc4bbc6be2c5727e73113630c8991f5d
-  data.tar.gz: 88e62dfaf6d8e6c22c23dfcec8c8677f546e204d7a0e5f53d87eeeb2349a1886
+  metadata.gz: ffe32ff356fd57cc72164264b4773492605133be8e3b673b8ceaf371d0cd0858
+  data.tar.gz: 5e986c0972820f5e1be8eb510210c9555ea94ea81986cbecd1295e33cc3a7fb1
 SHA512:
-  metadata.gz: 74aaaced1816ab4ef2270284013e9101a48a4d9d3a74b151f6075b787a16870f31b5b212113c6f2c7dadd2fa1b82a0b22d73360d4972a867a58c91cb42310dee
-  data.tar.gz: 26246a45258074c3a78b9cf817cf32ff9c15760ab3906485067223b7fa21446cb036d5b3d4e6a1f50bf0ffa1ecee62fe1f028213ae0f89429fe66c7be728bf6d
+  metadata.gz: 414756c816683899bf265642011f0f2598cc5fc57b1011bad67cc480f9bdd779f5ed965a76c00a1f83352699ff0e9c8b8a266fd3bc4804eccbe36ea2c396487f
+  data.tar.gz: 45664c86d3a7ea5cac7a10ed8d9b9c3be5f9770da27613816b7a4990ad3902aaa092e7ce02e07f01e21c789c5a09b172c34150f8c210335526b83e95b2df59a5

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,28 +1,36 @@
 PATH
   remote: .
   specs:
-    mistral-ai (1.1.1)
+    mistral-ai (1.2.0)
       event_stream_parser (~> 1.0)
-      faraday (~> 2.8, >= 2.8.1)
+      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)
+    dotenv (2.8.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     event_stream_parser (1.0.0)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    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.3.0.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -33,13 +41,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)
@@ -49,16 +57,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
+  dotenv (~> 2.8, >= 2.8.1)
   mistral-ai!
   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 [Mistral AI](https://mistral.ai)'s large languag
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'mistral-ai', '~> 1.1.1'
+gem 'mistral-ai', '~> 1.2.0'
 ```
 
 ```ruby
@@ -51,32 +51,33 @@ 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_completions](#chat_completions)
-            - [Without Streaming Events](#without-streaming-events)
-            - [Receiving Stream Events](#receiving-stream-events)
-        - [embeddings](#embeddings)
-        - [models](#models)
-    - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
-        - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
-    - [System Messages](#system-messages)
-    - [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_completions](#chat_completions)
+      - [Without Streaming Events](#without-streaming-events)
+      - [Receiving Stream Events](#receiving-stream-events)
+    - [embeddings](#embeddings)
+    - [models](#models)
+  - [Streaming and Server-Sent Events (SSE)](#streaming-and-server-sent-events-sse)
+    - [Server-Sent Events (SSE) Hang](#server-sent-events-sse-hang)
+  - [System Messages](#system-messages)
+  - [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)
 
@@ -85,11 +86,11 @@ Result:
 ### Installing
 
 ```sh
-gem install mistral-ai -v 1.1.1
+gem install mistral-ai -v 1.2.0
 ```
 
 ```sh
-gem 'mistral-ai', '~> 1.1.1'
+gem 'mistral-ai', '~> 1.2.0'
 ```
 
 ### Credentials
@@ -417,6 +418,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 = Mistral.new(
+  credentials: { api_key: ENV['MISTRAL_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:
@@ -504,6 +520,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -517,7 +535,7 @@ gem build mistral-ai.gemspec
 
 gem signin
 
-gem push mistral-ai-1.1.1.gem
+gem push mistral-ai-1.2.0.gem
 ```
 
 ### Updating the README

data/controllers/client.rb

@@ -2,9 +2,10 @@
 
 require 'event_stream_parser'
 require 'faraday'
+require 'faraday/typhoeus'
 require 'json'
 
-require_relative '../ports/dsl/mistral-ai/errors'
+require_relative '../components/errors'
 
 module Mistral
   module Controllers
@@ -13,6 +14,8 @@ module Mistral
 
       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)
@@ -24,7 +27,7 @@ module Mistral
                    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)
@@ -36,6 +39,8 @@ module Mistral
                            else
                              {}
                            end
+
+        @faraday_adapter = config.dig(:options, :connection, :adapter) || DEFAULT_FARADAY_ADAPTER
       end
 
       def chat_completions(payload, server_sent_events: nil, &callback)
@@ -56,7 +61,7 @@ module Mistral
         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
 
@@ -65,6 +70,7 @@ module Mistral
         method_to_call = request_method.to_s.strip.downcase.to_sym
 
         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
@@ -110,7 +116,7 @@ module Mistral
 
         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(raw)

data/mistral-ai.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['ports/dsl']
 
   spec.add_dependency 'event_stream_parser', '~> 1.0'
-  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/static/gem.rb

@@ -3,7 +3,7 @@
 module Mistral
   GEM = {
     name: 'mistral-ai',
-    version: '1.1.1',
+    version: '1.2.0',
     author: 'gbaptista',
     summary: 'Interact with Mistral AI.',
     description: "A Ruby gem for interacting with Mistral AI's large language models.",

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 [Mistral AI](https://mistral.ai)'s large languag
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'mistral-ai', '~> 1.1.1'
+gem 'mistral-ai', '~> 1.2.0'
 ```
 
 ```ruby
@@ -55,11 +55,11 @@ Result:
 ### Installing
 
 ```sh
-gem install mistral-ai -v 1.1.1
+gem install mistral-ai -v 1.2.0
 ```
 
 ```sh
-gem 'mistral-ai', '~> 1.1.1'
+gem 'mistral-ai', '~> 1.2.0'
 ```
 
 ### Credentials
@@ -387,6 +387,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 = Mistral.new(
+  credentials: { api_key: ENV['MISTRAL_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:
@@ -474,6 +489,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -487,7 +504,7 @@ gem build mistral-ai.gemspec
 
 gem signin
 
-gem push mistral-ai-1.1.1.gem
+gem push mistral-ai-1.2.0.gem
 ```
 
 ### Updating the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mistral-ai
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - gbaptista
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -30,22 +30,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 Mistral AI's large language models.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -73,7 +81,7 @@ metadata:
   homepage_uri: https://github.com/gbaptista/mistral-ai
   source_code_uri: https://github.com/gbaptista/mistral-ai
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - ports/dsl
@@ -89,7 +97,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 Mistral AI.
 test_files: []