Mindee 3.21.0
Prefix Reserveddotnet add package Mindee --version 3.21.0
NuGet\Install-Package Mindee -Version 3.21.0
<PackageReference Include="Mindee" Version="3.21.0" />
paket add Mindee --version 3.21.0
#r "nuget: Mindee, 3.21.0"
// Install Mindee as a Cake Addin #addin nuget:?package=Mindee&version=3.21.0 // Install Mindee as a Cake Tool #tool nuget:?package=Mindee&version=3.21.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 officially supported:
- Standard 2.0
- 4.7.2, 4.8 (Windows only)
- 6.0, 7.0, 8.0 (Linux, macOS x64, 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
Mindee__ApiKey
- From an appsettings.json file
"Mindee": {
"ApiKey": "my-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;
MindeeClient mindeeClient = new MindeeClient("my-api-key");
Loading a File and Parsing It
Global Documents
using Mindee;
using Mindee.Input;
using Mindee.Product.Invoice;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
// Construct a new client
MindeeClient mindeeClient = new MindeeClient(apiKey);
// Load an input source as a path string
// Other input types can be used, as mentioned in the docs
var inputSource = new LocalInputSource(filePath);
// Call the API and parse the input
var response = await mindeeClient
.ParseAsync<InvoiceV4>(inputSource);
// Print a summary of the predictions
System.Console.WriteLine(response.Document.ToString());
// Print the document-level predictions
// System.Console.WriteLine(response.Document.Inference.Prediction.ToString());
Region-Specific Documents
using Mindee;
using Mindee.Input;
using Mindee.Product.Us.BankCheck;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
MindeeClient mindeeClient = new MindeeClient(apiKey);
// Load an input source as a path string
// Other input types can be used, as mentioned in the docs
var inputSource = new LocalInputSource(filePath);
// Call the API and parse the input
var response = await mindeeClient
.ParseAsync<BankCheckV1>(inputSource);
// Print a summary of the predictions
System.Console.WriteLine(response.Document.ToString());
// Print the document-level predictions
// System.Console.WriteLine(response.Document.Inference.Prediction.ToString());
Custom Document (API Builder)
using Mindee;
using Mindee.Http;
using Mindee.Parsing;
string apiKey = "my-api-key";
string filePath = "/path/to/the/file.ext";
MindeeClient mindeeClient = new MindeeClient(apiKey);
// Load an input source as a path string
// Other input types can be used, as mentioned in the docs
var inputSource = new LocalInputSource(filePath);
// Set the endpoint configuration
CustomEndpoint myEndpoint = new CustomEndpoint(
endpointName: "my-endpoint",
accountName: "my-account"
// optionally, lock the version
//, version: "1.1"
);
// Call the API and parse the input
var response = await mindeeClient.ParseAsync(
inputSource, myEndpoint);
// Print a summary of all the predictions
System.Console.WriteLine(response.Document.ToString());
// Print a summary of the predictions
System.Console.WriteLine(response.Document.ToString());
// Print the document-level predictions
// System.Console.WriteLine(response.Document.Inference.Prediction.ToString());
Further Reading
Complete details on the working of the library are available in the following guides:
- Getting started
- .NET Generated APIs
- .NET Custom APIs (API Builder - Deprecated)
- .NET Invoice OCR
- .NET Receipt OCR
- .NET Financial Document OCR
- .NET Passport OCR
- .NET Resume OCR
- .NET Proof of Address OCR
- .NET International Id OCR
- .NET EU License Plate OCR
- .NET EU Driver License OCR
- .NET FR Bank Account Detail OCR
- .NET FR Carte Grise OCR
- .NET FR Carte Vitale OCR
- .NET FR ID Card OCR
- .NET US Bank Check OCR
- .NET US W9 OCR
- .NET US Driver License OCR
- .NET Barcode Reader API
- .NET Cropper API
- .NET Invoice Splitter API
- .NET Multi Receipts Detector API
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 | 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 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. |
.NET Framework | net472 is compatible. net48 is compatible. net481 was computed. |
-
.NETFramework 4.7.2
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 112.0.0)
- SkiaSharp (>= 2.88.8)
- SkiaSharp.NativeAssets.Linux.NoDependencies (>= 2.88.8)
- System.Text.Json (>= 8.0.5)
-
.NETFramework 4.8
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 112.0.0)
- SkiaSharp (>= 2.88.8)
- SkiaSharp.NativeAssets.Linux.NoDependencies (>= 2.88.8)
- System.Text.Json (>= 8.0.5)
-
net6.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 112.0.0)
- SkiaSharp (>= 2.88.8)
- SkiaSharp.NativeAssets.Linux.NoDependencies (>= 2.88.8)
- System.Text.Json (>= 8.0.5)
-
net7.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 112.0.0)
- SkiaSharp (>= 2.88.8)
- SkiaSharp.NativeAssets.Linux.NoDependencies (>= 2.88.8)
- System.Text.Json (>= 8.0.5)
-
net8.0
- Docnet.Core (>= 2.3.1)
- Microsoft.Extensions.Configuration.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.4)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- RestSharp (>= 112.0.0)
- SkiaSharp (>= 2.88.8)
- SkiaSharp.NativeAssets.Linux.NoDependencies (>= 2.88.8)
- System.Text.Json (>= 8.0.5)
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.21.0 | 6 | 11/14/2024 | |
3.20.1 | 140 | 10/22/2024 | |
3.20.0 | 107 | 10/11/2024 | |
3.19.0 | 130 | 9/18/2024 | |
3.18.4 | 194 | 8/30/2024 | |
3.18.3 | 258 | 7/23/2024 | |
3.18.2 | 153 | 7/22/2024 | |
3.18.1 | 133 | 7/19/2024 | |
3.18.0 | 126 | 7/18/2024 | |
3.17.0 | 218 | 6/26/2024 | |
3.16.0 | 159 | 6/11/2024 | |
3.15.0 | 325 | 5/28/2024 | |
3.14.0 | 163 | 5/21/2024 | |
3.13.0 | 213 | 4/30/2024 | |
3.12.0 | 732 | 4/8/2024 | |
3.11.1 | 182 | 4/5/2024 | |
3.11.0 | 171 | 3/26/2024 | |
3.10.0 | 437 | 3/6/2024 | |
3.9.0 | 282 | 1/30/2024 | |
3.8.0 | 987 | 12/20/2023 | |
3.7.1 | 136 | 12/20/2023 | |
3.7.0 | 311 | 11/22/2023 | |
3.6.0 | 202 | 11/17/2023 | |
3.5.0 | 138 | 11/13/2023 | |
3.4.0 | 332 | 10/20/2023 | |
3.3.0 | 352 | 9/22/2023 | |
3.2.0 | 210 | 9/13/2023 | |
3.1.0 | 501 | 8/9/2023 | |
3.0.0 | 1,814 | 7/28/2023 | |
2.2.1 | 483 | 5/30/2023 | |
2.2.0 | 402 | 3/16/2023 | |
2.1.2 | 139 | 3/9/2023 | |
2.1.1 | 143 | 3/8/2023 | |
2.1.1-preview2 | 170 | 3/8/2023 | |
2.1.1-preview1 | 202 | 3/8/2023 | |
2.1.0 | 170 | 2/20/2023 | |
2.0.0 | 2,718 | 2/3/2023 | |
1.4.0 | 358 | 1/4/2023 | |
1.3.0 | 373 | 12/22/2022 | |
1.2.0 | 355 | 12/9/2022 | |
1.1.0 | 421 | 11/28/2022 | |
1.0.0 | 413 | 11/17/2022 | |
1.0.0-rc1 | 156 | 11/16/2022 |
CHANGELOG.md