import { PDFServicesJob } from "./PDFServicesJob"; import { Asset } from "../../io/Asset"; import { OCRParams } from "../params/ocr/OCRParams"; import { ExecutionContext } from "../../internal/ExecutionContext"; import { NotifierConfig } from "../../config/notifier/NotifierConfig"; /** * A job that convert a PDF file into a searchable PDF file. Allows specifying locale({@link OCRSupportedLocale}) and * OCR Type * ({@link OCRSupportedType}) for performing OCR (Optical Character Recognition) *

* * @example * Sample Usage: * ```js * const readStream = fs.createReadStream(""); * * const credentials = new ServicePrincipalCredentials({ * clientId: process.env.PDF_SERVICES_CLIENT_ID, * clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET * }); * * const pdfServices = new PDFServices({credentials}); * * const inputAsset = await pdfServices.upload({ * readStream, * mimeType: MimeType.PDF * }); * * const job = new OCRJob({inputAsset}); * * const pollingURL = await pdfServices.submit({job}); * * const pdfServicesResponse = await pdfServices.getJobResult({ * pollingURL, * resultType: OCRResult * }); * * const resultAsset = pdfServicesResponse.result.asset; * const streamAsset = await pdfServices.getContent({asset: resultAsset}); * ``` */ export declare class OCRJob extends PDFServicesJob { private readonly _inputAsset; private readonly _outputAsset?; private readonly _ocrParams?; /** * Constructs a new `OCRJob` instance. * * @param params The parameters for constructing an instance of `OCRJob`. * @param params.inputAsset The input asset for the job. Cannot be undefined. * @param [params.params] {@link OCRParams} object to specify the OCR parameters. * @param [params.outputAsset] {@link Asset} object representing the output asset. * @remarks External assets can be set as output only when input is external asset as well. */ constructor(params: { inputAsset: Asset; params?: OCRParams; outputAsset?: Asset; }); /** * @hidden */ process(executionContext: ExecutionContext, notifierConfigList?: NotifierConfig[]): Promise; private generatePDFServicesAPIRequest; }