Mindee 2.1.1-preview1

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.7.2 This package targets .NET Framework 4.7.2. The package is compatible with this framework or higher.
This is a prerelease version of Mindee.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Mindee --version 2.1.1-preview1                

                    
                

            
NuGet\Install-Package Mindee -Version 2.1.1-preview1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Mindee" Version="2.1.1-preview1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Mindee --version 2.1.1-preview1                

                    
                

            
#r "nuget: Mindee, 2.1.1-preview1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Mindee as a Cake Addin
#addin nuget:?package=Mindee&version=2.1.1-preview1&prerelease

// Install Mindee as a Cake Tool
#tool nuget:?package=Mindee&version=2.1.1-preview1&prerelease

License: MIT GitHub Workflow Status NuGet NuGet Join Mindee on Slack

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 = MindeeClientInit.Create("MyKey");

Let's parse an invoice:

var prediction = await _mindeeClient
    .LoadDocument(new FileInfo("/path/to/the/file.ext"))
    .ParseAsync<InvoiceV4Inference>();

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 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. 
.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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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 96 11/14/2024
3.20.1 150 10/22/2024
3.20.0 111 10/11/2024
3.19.0 132 9/18/2024
3.18.4 204 8/30/2024
3.18.3 266 7/23/2024
3.18.2 155 7/22/2024 3.18.2 is deprecated because it has critical bugs.
3.18.1 135 7/19/2024 3.18.1 is deprecated because it has critical bugs.
3.18.0 128 7/18/2024 3.18.0 is deprecated because it has critical bugs.
3.17.0 222 6/26/2024 3.17.0 is deprecated because it has critical bugs.
3.16.0 166 6/11/2024
3.15.0 327 5/28/2024
3.14.0 165 5/21/2024
3.13.0 216 4/30/2024
3.12.0 775 4/8/2024
3.11.1 184 4/5/2024
3.11.0 173 3/26/2024
3.10.0 441 3/6/2024
3.9.0 284 1/30/2024
3.8.0 1,001 12/20/2023
3.7.1 138 12/20/2023
3.7.0 313 11/22/2023
3.6.0 204 11/17/2023
3.5.0 140 11/13/2023
3.4.0 334 10/20/2023
3.3.0 354 9/22/2023
3.2.0 212 9/13/2023
3.1.0 503 8/9/2023
3.0.0 1,871 7/28/2023
2.2.1 485 5/30/2023 2.2.1 is deprecated because it is no longer maintained.
2.2.0 404 3/16/2023 2.2.0 is deprecated because it has critical bugs.
2.1.2 141 3/9/2023 2.1.2 is deprecated because it is no longer maintained.
2.1.1 145 3/8/2023 2.1.1 is deprecated because it is no longer maintained.
2.1.1-preview2 173 3/8/2023 2.1.1-preview2 is deprecated because it is no longer maintained.
2.1.1-preview1 206 3/8/2023 2.1.1-preview1 is deprecated because it is no longer maintained.
2.1.0 172 2/20/2023 2.1.0 is deprecated because it is no longer maintained.
2.0.0 2,758 2/3/2023 2.0.0 is deprecated because it is no longer maintained.
1.4.0 360 1/4/2023 1.4.0 is deprecated because it is no longer maintained.
1.3.0 375 12/22/2022 1.3.0 is deprecated because it is no longer maintained.
1.2.0 357 12/9/2022 1.2.0 is deprecated because it is no longer maintained.
1.1.0 423 11/28/2022 1.1.0 is deprecated because it is no longer maintained.
1.0.0 415 11/17/2022 1.0.0 is deprecated because it is no longer maintained.
1.0.0-rc1 160 11/16/2022 1.0.0-rc1 is deprecated because it is no longer maintained.

CHANGELOG.md