mistral 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bc1534430ff8a86dafca215d434c999337163910c2b67c5a7198bbc4ade7c3
-  data.tar.gz: d97eda8d0b53118de9998dca31041ec14a1e357b7052a6083d4f172408192ebf
+  metadata.gz: d9d2632f2ddb13e1ebe7e1e286eef43e577598bfe3f918a8961efda0fd471b84
+  data.tar.gz: 150463bfd7ec228c3d8bbae83a3e1277d1907324e10649ebe236868486e91c47
 SHA512:
-  metadata.gz: 46f9cb65643ff7b805a2fe94181d7d8af3e27afc42ae001d9a6a6a4ef660ae79461508c793734cf46bcf14e470ec2f2e21c480e12d567f2e0c224c6cd3639f62
-  data.tar.gz: a68462d1daf574b786d325ece5f5519d9b3bada3081b1a150eb088e6bdb036b6f455a46a5e516ed6b4f6a79b294e400c21240c0a210181279c5eab16575756e9
+  metadata.gz: d10df680e7ad04178dea6a386539404659836ce4df94fa991a45bc3a00837802c251923ea9bb58a5118e96b4dd2b44dfce171c55588a8c704bb886627144b4ee
+  data.tar.gz: 709d9ccaf6ed76d8c56d513f5c08ff3610eafe2662430f9f71ff6984f0ec83b3ec37daa0cf7d04efcdd2b8f5ad41e6af17ea6a62a6d593abb07f97542bf64cdd

data/.env.example

@@ -1,3 +1,3 @@
 # Get this from https://console.mistral.ai/api-keys/
 MISTRAL_API_KEY=
-LOG_LEVEL=ERROR
+MISTRAL_LOG_LEVEL=ERROR

data/CHANGELOG.md

@@ -5,8 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.1/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2024-05-23
+
+### Added
+
+- We now support tool_call_id for tool messages. This will be mandatory in the future but you can start using right
+away to improve the model performance during function calling (especially multiple).
+Ports [mistralai/client-python#93](https://github.com/mistralai/client-python/pull/93)
+
+### Changed
+
+- Renamed `LOG_LEVEL` to `MISTRAL_LOG_LEVEL`. This is not a direct port of the Python client because Python has a
+global logger in the `logging` module, but Ruby doesn't.
+Ports [mistralai/client-python#86](https://github.com/mistralai/client-python/pull/86)
+- Get API key at client initialization. Ports
+[mistralai/client-python#57](https://github.com/mistralai/client-python/pull/57)
+
 ## [0.1.0] - 2024-05-04
 
-- Initial release. Feature parity with `v0.1.8` of the [client-python](https://github.com/mistralai/client-python)
+- Initial release. Feature parity with `v0.1.8` of the
+[mistralai/client-python](https://github.com/mistralai/client-python)
 
-[0.1.0]: https://github.com/wilsonsilva/nostr/compare/28e7c9...v0.1.0
+[0.2.0]: https://github.com/wilsonsilva/mistral/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/wilsonsilva/mistral/compare/28e7c9...v0.1.0

data/PYTHON_CLIENT_COMPARISON.md

@@ -175,10 +175,21 @@ This code resides in `lib/http/features/line_iterable_body.rb`.
 ## Testing
 
 The Ruby gem aims for 1:1 parity with the Python client. As such, it uses `Minitest` (similar to Python's `pytest`).
-However, testing was simplified by using and `webmock` for stubbing requests, instead of implementing 100% test
+However, testing was simplified by using `webmock` for stubbing requests, instead of implementing 100% test
 coverage and using RSpec, which is usually what I do.
 
 ## Examples
 
 The `function_calling.rb` example omits the unnecessary `n_rows = data['transaction_id'].length` line present in
 the Python version.
+
+## Logging
+
+Python has a global logger:
+
+```python
+self._logger = logging.getLogger(__name__)
+```
+
+Ruby doesn't. Thus, in order to allow users to customize the logging level, they can set the environment variable
+`MISTRAL_LOG_LEVEL` to `DEBUG`, `INFO`, `WARN`, `ERROR` or `FATAL`.

data/examples/function_calling.rb

@@ -73,7 +73,7 @@ tools = [
 ]
 
 api_key = ENV.fetch('MISTRAL_API_KEY')
-model = 'mistral-large-latest'
+model = 'mistral-small-latest'
 
 client = Mistral::Client.new(api_key: api_key)
 
@@ -97,7 +97,9 @@ puts "calling function_name: #{function_name}, with function_params: #{function_
 function_result = names_to_functions[function_name].call(function_params['transaction_id'])
 
 messages << response.choices[0].message
-messages << Mistral::ChatMessage.new(role: 'tool', name: function_name, content: function_result)
+messages << Mistral::ChatMessage.new(
+  role: 'tool', name: function_name, content: function_result, tool_call_id: tool_call.id
+)
 
 response = client.chat(model: model, messages: messages, tools: tools)
 

data/lib/mistral/client.rb

@@ -6,7 +6,7 @@ module Mistral
   # Synchronous wrapper around the async client
   class Client < ClientBase
     def initialize(
-      api_key: ENV['MISTRAL_API_KEY'],
+      api_key: nil,
       endpoint: ENDPOINT,
       max_retries: 5,
       timeout: 120

data/lib/mistral/client_base.rb

@@ -5,11 +5,15 @@ module Mistral
     attr_reader :endpoint, :api_key, :max_retries, :timeout
 
     def initialize(endpoint:, api_key: nil, max_retries: 5, timeout: 120)
-      @endpoint = endpoint
-      @api_key = api_key
       @max_retries = max_retries
       @timeout = timeout
 
+      api_key = ENV['MISTRAL_API_KEY'] if api_key.nil?
+
+      raise Error, 'API key not provided. Please set MISTRAL_API_KEY environment variable.' if api_key.nil?
+
+      @api_key = api_key
+      @endpoint = endpoint
       @logger = config_logger
 
       # For azure endpoints, we default to the mistral model
@@ -115,7 +119,7 @@ module Mistral
 
     def config_logger
       Logger.new($stdout).tap do |logger|
-        logger.level = ENV.fetch('LOG_LEVEL', 'ERROR')
+        logger.level = ENV.fetch('MISTRAL_LOG_LEVEL', 'ERROR')
 
         logger.formatter = proc do |severity, datetime, progname, msg|
           "#{datetime.strftime("%Y-%m-%d %H:%M:%S")} #{severity} #{progname}: #{msg}\n"

data/lib/mistral/models/chat_completion.rb

@@ -43,6 +43,7 @@ module Mistral
     attribute :content, Types::Strict::Array.of(Types::Strict::String) | Types::Strict::String
     attribute? :name, Types::String.optional
     attribute? :tool_calls, Types::Strict::Array.of(ToolCall).optional
+    attribute? :tool_call_id, Types::String.optional
   end
 
   class DeltaMessage < Dry::Struct

data/lib/mistral/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mistral
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mistral
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -108,7 +108,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: You can use the Mistral Ruby client to interact with the Mistral AI API.
+description: A 1:1 Ruby port of the official Mistral Python client, with feature and
+  API parity.
 email:
 - wilson.dsigns@gmail.com
 executables: []