Mindee 2.2.0
Prefix ReservedProblems with RestSharp fixed in 2.2.1
See the version list below for details.
dotnet add package Mindee --version 2.2.0
NuGet\Install-Package Mindee -Version 2.2.0
<PackageReference Include="Mindee" Version="2.2.0" />
<PackageVersion Include="Mindee" Version="2.2.0" />
<PackageReference Include="Mindee" />
paket add Mindee --version 2.2.0
#r "nuget: Mindee, 2.2.0"
#:package Mindee@2.2.0
#addin nuget:?package=Mindee&version=2.2.0
#tool nuget:?package=Mindee&version=2.2.0
Mindee API Helper Library for .NET
Quickly and easily connect to Mindee's API services using .NET.
Requirements
The following .NET versions are tested and supported:
- Standard 2.0
- 4.7.2, 4.8 (Windows only)
- 6.0, 7.0 (Linux, macOS, Windows)
Quick Start
Here's the TL;DR of getting started.
First, get an API Key
Then, install this library:
dotnet add package Mindee
Define the API Key
The API key is retrieved using IConfiguration.
So you could define it in multiple ways:
- From an environment variable
MindeeApiSettings__ApiKey
- From an appsettings.json file
"MindeeApiSettings": {
"ApiKey": ""m-api-key"
},
Instantiate The Client
You can instantiate the client either manually or by using dependency injection.
Dependency Injection
In your Startup.cs or Program.cs file, configure the dependency injection (DI) as follows:
services.AddMindeeClient();
This call will configure the client entry point and the PDF library used internally.
Then, in your controller or service instance, pass as an argument the class MindeeClient.
Manually
Or, you could also simply instantiate a new instance of MindeeClient:
using Mindee;
var mindeeClient = MindeeClientInit.Create("my-api-key");
Loading a File and Parsing It
Global Documents
using Mindee;
using Mindee.Parsing.Invoice;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
MindeeClient mindeeClient = MindeeClientInit.Create(apiKey);
var documentParsed = await mindeeClient
.LoadDocument(File.OpenRead(filePath), System.IO.Path.GetFileName(filePath))
.ParseAsync<InvoiceV4Inference>();
System.Console.WriteLine(documentParsed.ToString());
Region-Specific Documents
using Mindee;
using Mindee.Parsing.Us.BankCheck;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
MindeeClient mindeeClient = MindeeClientInit.Create(apiKey);
var documentParsed = await mindeeClient
.LoadDocument(File.OpenRead(filePath), System.IO.Path.GetFileName(filePath))
.ParseAsync<BankCheckV1Inference>();
System.Console.WriteLine(documentParsed.ToString());
Custom Document (API Builder)
using Mindee;
using Mindee.Parsing;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
MindeeClient mindeeClient = MindeeClientInit.Create(apiKey);
CustomEndpoint myEndpoint = new CustomEndpoint(
endpointName: "my-endpoint",
accountName: "my-account"
);
var documentParsed = await mindeeClient
.LoadDocument(new FileInfo(filePath))
.ParseAsync(myEndpoint);
System.Console.WriteLine(documentParsed.ToString());
Further Reading
Complete details on the working of the library are available in the following guides:
You can view the source code on GitHub.
You can also take a look at the Reference Documentation.
License
Copyright © Mindee
Available as open source under the terms of the MIT License.
Questions?
| Product | Versions 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 is compatible. 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 was computed. 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. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.2
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 109.0.0-preview.2)
- System.Text.Json (>= 6.0.6)
-
.NETStandard 2.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 109.0.0-preview.2)
- System.Text.Json (>= 6.0.6)
-
net6.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 109.0.0-preview.2)
- System.Text.Json (>= 6.0.6)
-
net7.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 109.0.0-preview.2)
- System.Text.Json (>= 6.0.6)
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 | |
|---|---|---|---|
| 3.37.2 | 94 | 1/19/2026 | |
| 3.37.2-strongname | 81 | 1/19/2026 | |
| 3.37.1 | 95 | 1/15/2026 | |
| 3.37.1-strongname | 84 | 1/13/2026 | |
| 3.37.0 | 119 | 1/7/2026 | |
| 3.36.1 | 560 | 12/15/2025 | |
| 3.36.0 | 674 | 12/2/2025 | |
| 3.35.0 | 1,596 | 11/19/2025 | |
| 3.34.0 | 1,485 | 10/1/2025 | |
| 3.33.0 | 217 | 9/25/2025 | |
| 3.32.0 | 995 | 9/3/2025 | |
| 3.31.0 | 252 | 8/27/2025 | |
| 3.30.0 | 270 | 8/4/2025 | |
| 3.29.0 | 174 | 7/29/2025 | |
| 3.29.0-rc4 | 1,353 | 7/22/2025 | |
| 3.29.0-rc3 | 182 | 7/9/2025 | |
| 3.29.0-rc2 | 201 | 7/3/2025 | |
| 3.29.0-rc1 | 191 | 6/30/2025 | |
| 3.28.0 | 1,099 | 6/4/2025 | |
| 3.27.0 | 572 | 4/22/2025 | |
| 3.26.0 | 363 | 4/16/2025 | |
| 3.25.0 | 257 | 4/8/2025 | |
| 3.24.3 | 572 | 2/13/2025 | |
| 3.24.2 | 475 | 1/9/2025 | |
| 3.24.1 | 300 | 1/8/2025 | |
| 3.24.0 | 354 | 12/26/2024 | |
| 3.23.0 | 274 | 12/13/2024 | |
| 3.22.0 | 249 | 11/28/2024 | |
| 3.21.0 | 263 | 11/14/2024 | |
| 3.20.1 | 335 | 10/22/2024 | |
| 3.20.0 | 224 | 10/11/2024 | |
| 3.19.0 | 254 | 9/18/2024 | |
| 3.18.4 | 632 | 8/30/2024 | |
| 3.18.3 | 430 | 7/23/2024 | |
| 3.18.2 | 270 | 7/22/2024 | |
| 3.18.1 | 248 | 7/19/2024 | |
| 3.18.0 | 248 | 7/18/2024 | |
| 3.17.0 | 428 | 6/26/2024 | |
| 3.16.0 | 878 | 6/11/2024 | |
| 3.15.0 | 419 | 5/28/2024 | |
| 3.14.0 | 274 | 5/21/2024 | |
| 3.13.0 | 754 | 4/30/2024 | |
| 3.12.0 | 1,589 | 4/8/2024 | |
| 3.11.1 | 294 | 4/5/2024 | |
| 3.11.0 | 286 | 3/26/2024 | |
| 3.10.0 | 551 | 3/6/2024 | |
| 3.9.0 | 411 | 1/30/2024 | |
| 3.8.0 | 1,278 | 12/20/2023 | |
| 3.7.1 | 262 | 12/20/2023 | |
| 3.7.0 | 396 | 11/22/2023 | |
| 3.6.0 | 284 | 11/17/2023 | |
| 3.5.0 | 219 | 11/13/2023 | |
| 3.4.0 | 431 | 10/20/2023 | |
| 3.3.0 | 436 | 9/22/2023 | |
| 3.2.0 | 302 | 9/13/2023 | |
| 3.1.0 | 609 | 8/9/2023 | |
| 3.0.0 | 3,259 | 7/28/2023 | |
| 2.2.1 | 610 | 5/30/2023 | |
| 2.2.0 | 571 | 3/16/2023 | |
| 2.1.2 | 275 | 3/9/2023 | |
| 2.1.1 | 280 | 3/8/2023 | |
| 2.1.1-preview2 | 326 | 3/8/2023 | |
| 2.1.1-preview1 | 358 | 3/8/2023 | |
| 2.1.0 | 309 | 2/20/2023 | |
| 2.0.0 | 3,838 | 2/3/2023 | |
| 1.4.0 | 550 | 1/4/2023 | |
| 1.3.0 | 555 | 12/22/2022 | |
| 1.2.0 | 525 | 12/9/2022 | |
| 1.1.0 | 603 | 11/28/2022 | |
| 1.0.0 | 601 | 11/17/2022 | |
| 1.0.0-rc1 | 342 | 11/16/2022 |
CHANGELOG.md