Mindee 1.3.0
Prefix ReservedSee the version list below for details.
dotnet add package Mindee --version 1.3.0
NuGet\Install-Package Mindee -Version 1.3.0
<PackageReference Include="Mindee" Version="1.3.0" />
paket add Mindee --version 1.3.0
#r "nuget: Mindee, 1.3.0"
// Install Mindee as a Cake Addin #addin nuget:?package=Mindee&version=1.3.0 // Install Mindee as a Cake Tool #tool nuget:?package=Mindee&version=1.3.0
Mindee API Helper Library for .NET
The official Mindee API Helper Library for the .NET ecosystem to quickly and easily connect to Mindee's API services.
This library is compatible with:
- .NET Standard 2.0
- .NET 4.7.2
- .NET 6+
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 from dependency injection (DI)
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
.
Instantiate manually
Or, you could also simply instantiate a new instance of MindeeClient
:
using Mindee;
var mindeeClient = new MindeeClient(
Options.Create(new MindeeSettings() { ApiKey = "MyKey" }));
Let's parse an invoice:
var prediction = await _mindeeClient
.LoadDocument(new FileInfo("/path/to/the/file.ext"))
.ParseAsync<InvoiceV4Prediction>();
Usage
You can also use the client with your custom documents:
CustomEndpoint myEndpoint = new CustomEndpoint(
endpointName: "wnine",
accountName: "john",
version: "1.1" // optional
);
var prediction = await _mindeeClient
.LoadDocument(new FileInfo("/path/to/the/file.ext"))
.ParseAsync(myEndpoint);
Further Reading
There's more to it than that for those that need more features, or want to customize the experience.
All the juicy details are described in the Official Guide.
You also can use the Reference documentation to dig deeper in the code.
Or feel free to reach us in our slack community channel 😃 !
License
Copyright © Mindee
Available as open source under the terms of the MIT License.
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 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 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. |
.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 (>= 108.0.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 (>= 108.0.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 (>= 108.0.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.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