mistral_rb

MistralRb

Welcome to MistralRb, a Ruby gem providing an easy-to-use interface for the Mistral AI API. This gem allows you to interact with the Mistral API to create chat completions, embeddings, and list available models in a Ruby-friendly way.

Installation

To install MistralRb, add it to your application's Gemfile:

bundle add mistral_rb

Or install it yourself as:

gem install mistral_rb

Usage

Here is a quick example to get you started:

require 'mistral_rb'

# Initialize the API with your API key
mistral = MistralAPI.new(api_key: "your_api_key_here")

# Create Chat Completion
response = mistral.create_chat_completion(model: "mistral-tiny", messages: [{role: "user", content: "Who is Macron?"}])
puts response.choices.to_s

# Create Embeddings
embedding_response = mistral.create_embeddings(model: "mistral-embed", input: ["Hello", "world"])
puts embedding_response.data.first.inspect

# List Available Models
model_list_response = mistral.list_available_models
model_list_response.data.each do |model|
  puts model.id
end

Here is how to use streaming:

api = MistralAPI.new(api_key: "api_key")

api.create_chat_completion(
  model: 'mistral-tiny',
  messages: [{ 'role' => 'user', 'content' => 'Who is Barack Obama ?' }],
  stream: true
) do |chunk|
  puts chunk.inspect
end

It is now possible add RAG (Retrieval Augmented Generation) in your apps, with only 6 lines of code:

vector_store = PineconeService.new(index_name: 'your_index_name')
llm = MistralAPI.new
file = "https://www.ycombinator.com/deal"
embedding_creator = MistralEmbeddingCreator.new

responder = Responder.new(vector_store: vector_store,llm: llm,file: file, embedding_creator: embedding_creator)

puts responder.call("How much does YC invest per startup ?")

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fsndzomga/mistral_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the MistralRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.