mindee-api-dotnet

MindeeClient Class

Namespace: Mindee
Assembly: Mindee
Assembly Version: 3.13.0+eab8cb726dfe6c5eac4fe379821ed5e1a7a970c3

The entry point to use the Mindee features.

public sealed class MindeeClient

Inheritance: object → MindeeClient

Constructors

Name Description
MindeeClient(IPdfOperation, IHttpApi, ILoggerFactory)  
MindeeClient(MindeeSettings, ILoggerFactory)  
MindeeClient(string, ILoggerFactory)  

Methods

Name Description
EnqueueAndParseAsync<TInferenceModel>(LocalInputSource, CustomEndpoint, PredictOptions, PageOptions, AsyncPollingOptions) Add the document to an async queue, poll, and parse when complete.
EnqueueAndParseAsync<TInferenceModel>(LocalInputSource, PredictOptions, PageOptions, AsyncPollingOptions) Add the document to an async queue, poll, and parse when complete.
EnqueueAsync<TInferenceModel>(LocalInputSource, CustomEndpoint, PredictOptions, PageOptions) Add a local input source to a Generated async queue.
EnqueueAsync<TInferenceModel>(LocalInputSource, PredictOptions, PageOptions) Add a local input source to a Standard async queue.
EnqueueAsync<TInferenceModel>(UrlInputSource, CustomEndpoint, PredictOptions) Add a URL input source to an async queue.
EnqueueAsync<TInferenceModel>(UrlInputSource, PredictOptions) Add a URL input source to an async queue.
LoadPrediction<TInferenceModel>(LocalResponse) Load a local prediction. Typically used when wanting to load from a webhook callback. However, any kind of Mindee response may be loaded.
ParseAsync(LocalInputSource, CustomEndpoint, PredictOptions, PageOptions) Call Custom prediction API on a local input source and parse the results.
ParseAsync(UrlInputSource, CustomEndpoint, PredictOptions) Call Custom prediction API on a URL input source and parse the results.
ParseAsync<TInferenceModel>(LocalInputSource, CustomEndpoint, PredictOptions, PageOptions) Call Generated prediction API on a local input source and parse the results.
ParseAsync<TInferenceModel>(LocalInputSource, PredictOptions, PageOptions) Call Standard prediction API on a local input source and parse the results.
ParseAsync<TInferenceModel>(UrlInputSource, CustomEndpoint, PredictOptions) Call Generated prediction API on a URL input source and parse the results.
ParseAsync<TInferenceModel>(UrlInputSource, PredictOptions) Call Standard prediction API on a URL input source and parse the results.
ParseQueuedAsync<TInferenceModel>(CustomEndpoint, string) Parse a document from a Generated async queue.
ParseQueuedAsync<TInferenceModel>(string) Parse a document from an async queue.

Documentation generated by MdDocs