This unofficial (RestEase based) client enables working with Mistral OCR (https://mistral.ai/fr/news/mistral-ocr)
Get Started
$ dotnet add package Mistral.OCRReadme
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
Sponsors
Entity Framework Extensions and Dapper Plus are major sponsors and proud to contribute to the development of Mistral.OCR.
