Node.js SDKResources
Identify
Node.js SDK - Document identification resource
Identify
Resource for identifying document types from images. Access via client.identify.
Methods
run(params, options?)
Creates a synchronous identification request.
const status = await client.identify.run({
url: 'https://example.com/document.pdf',
});
console.log(status.document_type); // best match
console.log(status.alternatives); // other matchesParameters: IdentifyParams
Returns: Promise<IdentificationStatus>
runAsync(params, options?)
Creates an asynchronous identification request with a .wait() method for polling.
import fs from 'fs';
const status = await client.identify.runAsync({
file: fs.readFileSync('document.pdf'),
});
const result = await status.wait();
console.log(result.document_type);Parameters: IdentifyParams
Returns: Promise<IdentificationStatus & { wait(): Promise<IdentificationStatus> }>
getStatus(identificationId, options?)
Retrieves the current status of an identification operation.
const status = await client.identify.getStatus('id_abc123');Parameters: identificationId: string
Returns: Promise<IdentificationStatus>
Raw Responses
Access raw HTTP response details via withRawResponse:
const raw = await client.identify.withRawResponse.run({
url: 'https://example.com/document.pdf',
});
console.log(raw.statusCode);
const data = await raw.parse();