Send the document to an asynchronous endpoint and return its ID in the queue.
product class to use for calling the API and parsing the response.
file to parse.
parameters relating to prediction options.
a Promise containing the job (queue) corresponding to a document.
Polls a queue and returns its status as well as the prediction results if the parsing is done.
an extension of an Inference. Can be omitted as it will be inferred from the productClass.
product class to use for calling the API and parsing the response.
id of the queue to poll.
parameters relating to prediction options.
a Promise containing a Job, which also contains a Document if the
parsing is complete.
ProtectedapiMindee V1 API settings.
Creates a custom endpoint with the given values. Raises an error if the endpoint is invalid.
Name of the custom Endpoint.
Name of the account tied to the Endpoint.
OptionalendpointVersion: string
Version of the custom Endpoint.
Endpoint a new product endpoint
ProtectedgetForces boolean coercion on truthy/falsy parameters.
Optionalparam: boolean
input parameter to check.
a strict boolean value.
Send a document to an asynchronous endpoint and poll the server until the result is sent or until the maximum number of tries is reached.
an extension of an Inference. Can be omitted as it will be inferred from the productClass.
product class to use for calling the API and parsing the response.
document to parse.
parameters relating to prediction options.
a Promise containing parsing results.
Fetch prediction results from a document already processed.
an extension of an Inference. Can be omitted as it will be inferred from the productClass.
product class to use for calling the API and parsing the response.
id of the document to fetch.
optional parameters.
Optionalendpoint?: EndpointEndpoint, only specify if using a custom product.
a Promise containing parsing results.
Send a document to a synchronous endpoint and parse the predictions.
an extension of an Inference. Can be omitted as it will be inferred from the productClass.
product class to use for calling the API and parsing the response.
file to parse.
parameters relating to prediction options.
a Promise containing parsing results.
Send feedback for a document.
an extension of an Inference. Can be omitted as it will be inferred from the productClass.
product class to use for calling the API and parsing the response.
id of the document to send feedback for.
the feedback to send.
optional parameters.
Optionalendpoint?: EndpointEndpoint, only specify if using a custom product.
a Promise containing feedback results.
Send the document to an asynchronous endpoint and return its ID in the queue.
file to send to the API.
ID of the workflow.
parameters relating to prediction options.
a Promise containing the job (queue) corresponding to a document.
Mindee Client class that centralizes most basic operations.