Protected apiKey of the API.
Send the document to an asynchronous endpoint and return its ID in the queue.
a Promise containing the job (queue) corresponding to a document.
product class to use for calling the API and parsing the response.
file to parse.
parameters relating to prediction options.
Polls a queue and returns its status as well as the prediction results if the parsing is done.
a Promise containing a Job, which also contains a Document if the
parsing is complete.
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.
Private #buildBuilds a document endpoint.
a custom Endpoint object.
Private #buildBuilds a product endpoint.
a custom Endpoint object.
name of the endpoint.
name of the endpoint's owner.
version of the endpoint.
Private #cleanChecks that an account name is provided for custom builds, and sets the default one otherwise.
the name of the account. Sends an error if one isn't provided for a custom build.
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.
Optional accountName: stringname of the account's holder. Only required on custom builds.
Private #getGet the name and version of an OTS endpoint.
an endpoint's name and version.
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. Mandatory to retrieve default OTS endpoint data.
Private #initializeOTSEndpointCreates an endpoint for an OTS product. Raises an error if the endpoint is invalid.
Private #setCreates a custom endpoint with the given values. Raises an error if the endpoint is invalid.
Endpoint a new product endpoint
Name of the custom Endpoint.
Name of the account tied to the Endpoint.
Optional endpointVersion: stringVersion of the custom Endpoint.
Load an input document from a base64 encoded string.
input content, as a string.
file name.
Load an input document from a Buffer.
input content, as a buffer.
file name.
Load an input document from a bytes string.
input content, as readable bytes.
file name.
Load an input document from a stream.Readable object.
input content, as a readable stream.
file name.
Protected getSend a document to an asynchronous endpoint and poll the server until the result is sent or until the maximum amount of tries is reached.
a Promise containing parsing results.
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.
Fetch prediction results from a document already processed.
a Promise containing parsing results.
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.
Optional endpoint?: EndpointEndpoint, only specify if using a custom product.
Send a document to a synchronous endpoint and parse the predictions.
a Promise containing parsing results.
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.
Send a feedback for a document.
a Promise containing feedback results.
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.
Optional endpoint?: EndpointEndpoint, only specify if using a custom product.
Generated using TypeDoc
Mindee Client class that centralizes most basic operations.