Introducing Know Your HealthDocs: Learn more

onymos-logo

onymosDocID.analyze

To use client-side machine learning to identify a document.

OnymosDocID.analyze(
modelID,
image,
(results) => {
/* ------
bioauthTypeObject = {
modelID: Model ID used for document identification,
documentName: Name of the document associated with the model ID,
confidenceThresh: Minimum level of confidence for DocKnow to identify the document,
confidenceLevel: DocID's level of confidence that the analyzed document is a match,
isDocument: Boolean value that returns true if the confidenceLevel meets or exceeds the confidenceThresh,
processTime: Time elapsed during analysis
};
------ */
},
(error) => {
console.log(error);
},
options
);
modelID

String

A model ID used to identify the document.

image

String

The image of the document to be analyzed must be converted to a JPEG represented as a base64 string. It is recommended that the height and width of this image be no larger than 1000px to prevent lengthy runtimes.

documentName

String

The name of the document associated with the model ID.

confidenceThresh

Float

Default: .7
Value ranging from 0 to 1 used to determine if the analyzed document matches the corresponding model.

confidenceLevel

Float

Value ranging from 0 to 1 representing DocID’s confidence the analyzed document matches the corresponding model.

isDocument

Boolean

A boolean indicating if an analyzed document matches the corresponding model. Returns ‘true’ when the confidenceLevel meets or exceeds the confidenceThresh.

processTime

Float

Number of milliseconds that elapsed during the document analysis.

options
confidenceThresh

Float

Value ranging from 0 to 1 used to determine if the analyzed document matches the corresponding model.

onymosDocID.listModels

To get a list of available document models associated with your Onymos account. Doing this will also allow you to update document models — without needing to republish your app.

OnymosDocID.listModels(
(list) => {
/* ------
list = [{
documentName: Name of the document associated with the model ID,
modelID: Model ID used for document identification,
modelVersion: Version of the model,
timeUpdated: Time since the model was last updated
}];
------ */
},
(error) => {
console.log(error);
},
options
);
documentName

String

The name of the document associated with the model ID.

modelID

String

A model ID used to identify the document.

modelVersion

String

The model ID’s iteration or version number.

timeUpdated

Integer

Unix epoch time capturing when the modelVersion was last updated.

options
documentName

String

The name of the document associated with the model ID.

Think differently about app development

Download our free white paper today to learn how Onymos Features can maximize the value of your developer resources — and shave days or weeks off your development timeline.

Get your free white paper