Mindee v2.2.0 — nugetz
Mindee/Mindeev2.2.0
✓ Verified.NET FW4.7.2.NET FW4.8.NET 6.0.NET 7.0
Mindee is a class library helper to use the Mindee API. (Official Library)
Get Started
$ dotnet add package MindeeReadme
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.
License
Available as open source under the terms of the MIT License.
Questions?