Mistral

Mistral is an open-source Elixir client for the Mistral AI API, offering a simple and efficient way to integrate Mistral's language models into your Elixir applications. Designed for ease of use, Mistral provides access to Mistral AI's capabilities, making it a great choice for building AI-driven features.

Features

• 💬 Chat Completions
• 🛠 Function Calling / Tool Use
• 🔢 Embeddings
• 🌊 Streaming Support
• 🛡️ Error Handling
• ⬆️ File Uploading
• 📄 OCR (Optical Character Recognition)
• 🤖 Models

Installation

Add mistral to your list of dependencies in mix.exs:

def deps do
  [
    {:mistral, "~> 0.3.0"}
  ]
end

Configuration

Set your Mistral API key in your config:

config :mistral, :api_key, "your_mistral_api_key"

Usage Examples

Chat Completion

{:ok, client} = Mistral.init("your_api_key")

{:ok, response} = Mistral.chat(client,
  model: "mistral-small-latest",
  messages: [
    %{role: "user", content: "Write a haiku about elixir"}
  ]
)

Streaming Chat

{:ok, stream} = Mistral.chat(client,
  model: "mistral-small-latest",
  messages: [
    %{role: "user", content: "Tell me a short story"}
  ],
  stream: true
)

stream
|> Stream.each(fn chunk -> IO.write(chunk["choices"][0]["delta"]["content"] || "") end)
|> Stream.run()

Embeddings

{:ok, embeddings} = Mistral.embed(client,
  input: ["Hello, world!", "This is an embedding test"]
)

Response Format Control

Control the output format for structured responses:

# JSON Object Mode - ensures valid JSON response
{:ok, response} = Mistral.chat(client,
  model: "mistral-small-latest",
  messages: [
    %{role: "user", content: "Generate a user profile in JSON format"}
  ],
  response_format: %{type: "json_object"}
)

# JSON Schema Mode - validates response against schema
user_schema = %{
  type: "object",
  title: "UserProfile",
  properties: %{
    name: %{type: "string", title: "Name"},
    age: %{type: "integer", title: "Age", minimum: 0},
    email: %{type: "string", title: "Email"}
  },
  required: ["name", "age"],
  additionalProperties: false
}

{:ok, response} = Mistral.chat(client,
  model: "mistral-small-latest",
  messages: [
    %{role: "user", content: "Generate a user profile"}
  ],
  response_format: %{
    type: "json_schema",
    json_schema: %{
      name: "user_profile",
      schema: user_schema,
      strict: true
    }
  }
)

Credits & Acknowledgments

This package was heavily inspired by and draws from the excellent implementations of:

• Ollama by lebrunel
• Antropix by lebrunel

A huge thanks to the author of these projects for their work in creating robust and well-structured Elixir clients for AI APIs. Their implementations served as a valuable reference in designing this library.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Roadmap

• OCR (Optical Character Recognition) Support
• Enhanced Error Handling
• Response Format Control (JSON mode with schema validation)
• Classification/Moderation API
• Batch Processing Support
• Complete File Operations (list, delete, download)
• Advanced Streaming Improvements

License

This project is licensed under the MIT License.

Disclaimer

This is an independent, community-supported library and is not officially associated with Mistral AI.