IRPCScanningAndOCR.OCROperation_Status
Vault API / standard write session idempotent returns metadata structure version
Gets the progress of an OCR job, and optionally cancels it.
| Service | Scanning and OCR MFiles.IRPCScanningAndOCR |
|---|---|
| gRPC method | /MFiles.IRPCScanningAndOCR/OCROperation_Status |
| HTTP (mf-http-grpc) | POST /grpc/v1/ocroperation_-status |
| Request | OCROperation_StatusRequest |
| Response | OCROperation_StatusResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Poll until
doneis true, then end the job. - If the job failed, the call fails with the job's error and the job is released.
- An unknown or already ended job fails with "The parameter is incorrect.".
Request: OCROperation_StatusRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
background_op_id | uint32 | The ID of the job. |
cancel | bool | True to cancel the job. |
Response: OCROperation_StatusResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
items | uint32 | The number of pages to process; 0 until known. |
items_completed | uint32 | The number of pages processed. |
done | bool | True when the job has stopped. |
Related methods
- OCROperation_BeginAfterUpload -- Starts an OCR job on a file that the caller uploaded with UploadTempFile.
- OCROperation_Begin -- Starts an OCR job on a file of a document that the caller has checked out.
- OCROperation_End -- Ends an OCR job started with OCROperation_Begin and replaces the document's file with the resulting PDF.
- OCROperation_EndWithDownload -- Ends an OCR job and returns its results: the recognized texts and a download of the PDF.