Mistral.OCR 0.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package Mistral.OCR --version 0.0.1
                    


                    

                
NuGet\Install-Package Mistral.OCR -Version 0.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Mistral.OCR" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Mistral.OCR" Version="0.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Mistral.OCR" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Mistral.OCR --version 0.0.1
                    


                    

                
#r "nuget: Mistral.OCR, 0.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Mistral.OCR&version=0.0.1
                    


                            Install Mistral.OCR as a Cake Addin
                        

                    

                
#tool nuget:?package=Mistral.OCR&version=0.0.1
                    


                            Install Mistral.OCR as a Cake Tool

Mistral OCR

Unofficial RestEase C# Client for Mistral OCR.

Configuration

You will need your ApiKey to use Mistral OCR, you can get one https://console.mistral.ai/home.

Register the client using Dependency Injection:

services.AddMistralOCR(o =>
    o.ApiKey = "[YOUR_API_KEY]"
);

Usage

Process Image
IMistralOCR client = // get from DI
IImageURLHelper imageURLHelper = // get from DI

var sourceImagePath = @"c:\temp\image.png";

var request = new OCRRequest
{
    Id = Guid.NewGuid().ToString(),
    Document = await imageURLHelper.FromFile(sourceImagePath, cancellationToken)
};

var response = await client.ProcessAsync(request);
var ocr = response.GetContent();

var markdown = ocr.Pages[0].Markdown;
Process Pdf
var pdfUrl = "https://pdfobject.com/pdf/sample.pdf";

var request = new OCRRequest
{
    Id = Guid.NewGuid().ToString(),
    Document = new DocumentURLChunk
    {
        DocumentName = pdfUrl.Split('/').Last(),
        DocumentUrl = pdfUrl
    }
};
var response = await client.ProcessAsync(request);
var ocr = response.GetContent();

foreach (var page in ocr.Pages)
{
    Consolle.WriteLineAsync(page.Markdown);
}
Options
public class MistralOCROptions
{
    /// <summary>
    /// The required BaseAddress.
    /// </summary>
    [Required]
    public Uri BaseAddress { get; set; } = new("https://api.mistral.ai/v1/ocr");

    [Required] 
    public string ApiKey { get; set; } = null!;

    /// <summary>
    /// Optional HttpClient name to use.
    /// </summary>
    public string? HttpClientName { get; set; }

    /// <summary>
    /// This timeout in seconds defines the timeout on the HttpClient which is used to call the BaseAddress.
    /// 
    /// Default value is <c>60</c> seconds.
    /// </summary>
    [Range(1, int.MaxValue)]
    public int TimeoutInSeconds { get; set; } = 60;

    /// <summary>
    /// The maximum number of retries.
    ///
    /// Default value is <c>3</c>.
    /// </summary>
    [Range(0, 99)]
    public int MaxRetries { get; set; } = 3;

    /// <summary>
    /// Set the rate limit for your Completion API consumption.
    ///
    /// Default value is <c>1</c>.
    /// </summary>
    [Range(1, int.MaxValue)]
    public int MaximumRequestsPerSecond { get; set; } = 1;

    /// <summary>
    /// In addition to Network failures, TaskCanceledException, HTTP 5XX and HTTP 408. Also retry these <see cref="HttpStatusCode"/>s. [Optional]
    /// </summary>
    public HttpStatusCode[]? HttpStatusCodesToRetry { get; set; }
}

References

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.1 220 3/8/2025

# 0.0.1 (08 March 2025)
- #1 Add project [feature]

The full release notes can be found here: https://github.com/StefH/Mistral.OCR/blob/main/ReleaseNotes.md