mistral 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01bc1534430ff8a86dafca215d434c999337163910c2b67c5a7198bbc4ade7c3
+  data.tar.gz: d97eda8d0b53118de9998dca31041ec14a1e357b7052a6083d4f172408192ebf
+SHA512:
+  metadata.gz: 46f9cb65643ff7b805a2fe94181d7d8af3e27afc42ae001d9a6a6a4ef660ae79461508c793734cf46bcf14e470ec2f2e21c480e12d567f2e0c224c6cd3639f62
+  data.tar.gz: a68462d1daf574b786d325ece5f5519d9b3bada3081b1a150eb088e6bdb036b6f455a46a5e516ed6b4f6a79b294e400c21240c0a210181279c5eab16575756e9

data/.env.example

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

data/.rubocop.yml

@@ -0,0 +1,60 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+# All cops below exist to maximize compatibility with the Python client source code
+
+Lint/UnreachableLoop:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+    - examples/chatbot_with_streaming.rb
+
+Style/StringConcatenation:
+  Exclude:
+    - test/test_chat.rb
+    - test/test_helper.rb

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+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.1.0] - 2024-05-04
+
+- Initial release. Feature parity with `v0.1.8` of the [client-python](https://github.com/mistralai/client-python)
+
+[0.1.0]: https://github.com/wilsonsilva/nostr/compare/28e7c9...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at wilson.dsigns@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Wilson Silva
+
+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/PYTHON_CLIENT_COMPARISON.md

@@ -0,0 +1,184 @@
+# Comparison with [client-python](https://github.com/mistralai/client-python)
+
+This Ruby gem aims to maintain 1:1 parity with the Python client. There are just a few differences to make the API
+more idiomatic to Ruby.
+
+## Development standards
+
+In the interest of efficiency and maintainability, this gem __prioritizes parity__ with the Python client over
+__adherence to my typical development standards__ such as 100% documentation, 100% test coverage, and strict
+linting. This approach simplifies the process of backporting new features from the Python package in the future.
+
+## Public API
+
+The public API remains the same as the Python client. For example, these two examples are equivalent:
+
+```python
+import os
+
+from mistralai.client import MistralClient
+from mistralai.models.chat_completion import ChatMessage
+
+
+def main():
+    api_key = os.environ["MISTRAL_API_KEY"]
+    model = "mistral-tiny"
+
+    client = MistralClient(api_key=api_key)
+
+    chat_response = client.chat(
+        model=model,
+        messages=[
+          ChatMessage(role="user", content="What is the best French cheese?")
+        ],
+    )
+    print(chat_response.choices[0].message.content)
+
+
+if __name__ == "__main__":
+    main()
+```
+
+```ruby
+require 'mistral'
+
+api_key = ENV.fetch('MISTRAL_API_KEY')
+model = 'mistral-tiny'
+
+client = Mistral::Client.new(api_key: api_key)
+
+chat_response = client.chat(
+  model: model,
+  messages: [
+    Mistral::ChatMessage.new(role: 'user', content: 'What is the best French cheese?')
+  ]
+)
+
+puts chat_response.choices[0].message.content
+```
+
+However, since Ruby doesn't have native `async` support, all `async` methods and examples are not implemented.
+
+### Directory structure
+
+Excluding the async files, they are roughly the same. The main differences are the presence of `__init__.py` files in
+the Python package, additional files like `http/features/line_iterable_body.rb` in the Ruby gem and `utils.py`
+(equivalent to `test_helper.rb`) in the Python package.
+
+```shell
+Python package                         Ruby gem
+├── examples                           ├── examples
+│   ├── chat_no_streaming.py           │   ├── chat_no_streaming.rb
+│   ├── chat_with_streaming.py         │   ├── chat_with_streaming.rb
+│   ├── chatbot_with_streaming.py      │   ├── chatbot_with_streaming.rb
+│   ├── embeddings.py                  │   ├── embeddings.rb
+│   ├── function_calling.py            │   ├── function_calling.rb
+│   ├── json_format.py                 │   ├── json_format.rb
+│   └── list_models.py                 │   └── list_models.rb
+├── src                                ├── lib
+│   └── mistralai                      │   ├── http
+│       ├── __init__.py                │   │   └── features
+│       ├── client.py                  │   │       └── line_iterable_body.rb
+│       ├── client_base.py             │   ├── mistral
+│       ├── constants.py               │   │   ├── client.rb
+│       ├── exceptions.py              │   │   ├── client_base.rb
+│       └── models                     │   │   ├── constants.rb
+│           ├── __init__.py            │   │   ├── exceptions.rb
+│           ├── chat_completion.py     │   │   ├── models
+│           ├── common.py              │   │   │   ├── chat_completion.rb
+│           ├── embeddings.py          │   │   │   ├── common.rb
+│           └── models.py              │   │   │   ├── embeddings.rb
+└── tests                              │   │   │   └── models.rb
+    ├── __init__.py                    │   │   └── version.rb
+    ├── test_chat.py                   │   └── mistral.rb
+    ├── test_embedder.py               └── test
+    ├── test_list_models.py                ├── test_chat.rb
+    └── utils.py                           ├── test_embedder.rb
+                                           ├── test_helper.rb
+                                           └── test_list_models.rb
+```
+
+### Errors and exceptions
+
+Ruby lacks a native way to import and namespace constants like Python. To address this, exceptions are namespaced,
+and the top-level exception is named `Error` as per Ruby gem standard practice:
+
+| Python                       | Ruby                       |
+|------------------------------|----------------------------|
+| `MistralException`           | `Mistral::Error`           |
+| `MistralAPIException`        | `Mistral::APIError`        |
+| `MistralAPIStatusException`  | `Mistral::APIStatusError`  |
+| `MistralConnectionException` | `Mistral::ConnectionError` |
+
+## Private API
+
+Unlike Python, where private methods start with an underscore (`_`), Ruby follows the convention of not having a
+specific naming pattern for private methods.
+
+```python
+def _process_line(self, line: str) -> Optional[Dict[str, Any]]:
+  # Implementation
+
+def _make_chat_request:
+  # Implementation
+```
+
+```ruby
+def process_line(line)
+end
+
+def make_chat_request(line)
+end
+```
+
+## Static typing
+
+Python's `Pydantic` package for data validation and manipulation is implemented using `dry-types` and `dry-struct`
+in Ruby. `Pydantic`'s `Model`s are implemented as `Dry::Struct`s, and `model_dump` is replaced with `to_h` for
+converting structs to hashes.
+
+Ruby's `RBS` type system was initially explored but not fully implemented due to time constraints. It remains
+available in a [separate branch](https://github.com/wilsonsilva/mistral/tree/rbs-types).
+
+## Client version
+
+Unlike Python, where the version is set in the `Client` class, Ruby follows the convention of defining the version
+as a `VERSION` constant in the gem's top-level module.
+
+## HTTP Client
+
+The Python version uses the package [httpx](https://www.python-httpx.org/) to send HTTP requests. In Ruby, the
+gem [http](https://github.com/httprb/http) (also called `http.rb`) is used, which is similar. One difference
+is that while `httpx`'s responses let you easily iterate over each line of the body, `http.rb` doesn't have this
+functionality built-in.
+
+To mimic `httpx`'s `iter_lines` behavior, I implemented a plugin (known as a `Feature` in `http.rb`):
+
+```python
+for line in response.iter_lines():
+    json_streamed_response = self._process_line(line)
+    if json_streamed_response:
+        yield json_streamed_response
+```
+
+```ruby
+response.body.each_line do |line|
+  processed_line = process_line(line)
+  next if processed_line.nil?
+
+  yielder << processed_line
+end
+```
+
+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
+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.

data/README.md

@@ -0,0 +1,145 @@
+# Mistral Ruby Client
+
+[![Gem Version](https://badge.fury.io/rb/mistral.svg)](https://badge.fury.io/rb/mistral)
+![Build](https://github.com/wilsonsilva/mistral/actions/workflows/main.yml/badge.svg)
+
+Mistral is a Ruby gem to interact with the [Mistral AI API](https://www.mistral.ai).
+
+This client is a 1:1 port of Mistral's [client-python](https://github.com/mistralai/client-python).
+For a detailed comparison between the Ruby and Python clients, please refer to the
+[PYTHON_CLIENT_COMPARISON.md](https://github.com/wilsonsilva/mistral/blob/main/PYTHON_CLIENT_COMPARISON.md) file.
+
+## 🔑 Key features
+
+- API parity with the official [Python client](https://github.com/mistralai/client-python)
+- Full support for all Mistral AI functionalities, including chat completions, embeddings, and function calling
+- Asynchronous streaming of responses
+- Comprehensive error handling and retry mechanisms
+- Configurable client options (e.g., API endpoint, timeout, max retries)
+- Fully leverages `dry-struct` for type safety and avoids primitive obsession with hashes
+
+## 📦 Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```
+$ bundle add mistral
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```
+$ gem install mistral
+```
+
+## ⚡️ Quickstart
+
+Here are a few examples of how to use the Mistral gem:
+
+### Chat completion
+
+```ruby
+require 'mistral'
+
+api_key = ENV.fetch('MISTRAL_API_KEY')
+client = Mistral::Client.new(api_key: api_key)
+
+model = 'mistral-small'
+
+chat_response = client.chat(
+ model: model,
+ messages: [
+   Mistral::ChatMessage.new(role: 'user', content: 'What is the best French cheese?')
+ ]
+)
+
+puts chat_response.choices[0].message.content
+```
+
+### Chat completion with streaming
+
+```ruby
+require 'mistral'
+
+api_key = ENV.fetch('MISTRAL_API_KEY')
+client = Mistral::Client.new(api_key: api_key)
+
+model = 'mistral-small'
+
+client.chat_stream(
+  model: model,
+  messages: [
+    Mistral::ChatMessage.new(role: 'user', content: 'What is the best French cheese?')
+  ]
+).each do |chunk|
+  print chunk.choices[0].delta.content if chunk.choices[0].delta.content
+end
+```
+
+## 📚 Documentation
+
+In the [`examples`](https://github.com/wilsonsilva/mistral/tree/main/examples) folder, you will find how to do:
+
+| File Name                                                                                                          | Description                                                    |
+|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
+| [`chat_no_streaming.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/chat_no_streaming.rb)           | How to use the chat endpoint without streaming                 |
+| [`chat_with_streaming.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/chat_with_streaming.rb)       | How to use the chat endpoint with streaming                    |
+| [`chatbot_with_streaming.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/chatbot_with_streaming.rb) | A simple interactive chatbot using streaming                   |
+| [`embeddings.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/embeddings.rb)                         | How to use the embeddings endpoint                             |
+| [`function_calling.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/function_calling.rb)             | How to call functions using the chat endpoint                  |
+| [`json_format.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/json_format.rb)                       | How to request and parse JSON responses from the chat endpoint |
+| [`list_models.rb`](https://github.com/wilsonsilva/mistral/blob/main/examples/list_models.rb)                       | How to list available models                                   |
+
+## 🔨 Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+The health and maintainability of the codebase is ensured through a set of Rake tasks to test and lint the gem:
+
+```
+rake build                    # Build mistral into the pkg directory
+rake build:checksum           # Generate SHA512 checksum if mistral.gem into the checksums directory
+rake clean                    # Remove any temporary products
+rake clobber                  # Remove any generated files
+rake install                  # Build and install mistral.gem into system gems
+rake install:local            # Build and install mistral.gem into system gems without network access
+rake release[remote]          # Create tag v0.1.0 and build and push mistral.gem to https://rubygems.org
+rake rubocop                  # Run RuboCop
+rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
+rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
+rake test                     # Run the test suite
+rake test:cmd                 # Print out the test command
+rake test:isolated            # Show which test files fail when run in isolation
+rake test:slow                # Show bottom 25 tests wrt time
+```
+
+## 🐞 Issues & Bugs
+
+If you find any issues or bugs, please report them [here](https://github.com/wilsonsilva/mistral/issues), I will be happy
+to have a look at them and fix them as soon as possible.
+
+Please let me know if the [client-python](https://github.com/mistralai/client-python) introduces any new features,
+so I can keep this gem in sync with the latest updates.
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/mistral.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [code of conduct](https://github.com/wilsonsilva/mistral/blob/main/CODE_OF_CONDUCT.md).
+
+## 📜 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 👔 Code of Conduct
+
+Everyone interacting in the mistral project's codebases, issue trackers, chat rooms and mailing lists is expected
+to follow the [code of conduct](https://github.com/wilsonsilva/mistral/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/chat_no_streaming.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'mistral'
+
+api_key = ENV.fetch('MISTRAL_API_KEY')
+client = Mistral::Client.new(api_key: api_key)
+
+model = 'mistral-tiny'
+
+chat_response = client.chat(
+  model: model,
+  messages: [Mistral::ChatMessage.new(role: 'user', content: 'What is the best French cheese?')]
+)
+
+puts chat_response.choices[0].message.content

data/examples/chat_with_streaming.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'mistral'
+
+api_key = ENV.fetch('MISTRAL_API_KEY')
+client = Mistral::Client.new(api_key: api_key)
+
+model = 'mistral-tiny'
+
+client.chat_stream(
+  model: model,
+  messages: [Mistral::ChatMessage.new(role: 'user', content: 'What is the best French cheese?')]
+).each do |chunk|
+  print chunk.choices[0].delta.content if chunk.choices[0].delta.content
+end