GoodMemGoodMem
ReferenceClient SDKsRust

Ocr

Rust ocr API reference: typed methods, request options, return values, and resource models.

goodmem::api::Ocr

Access this service with client.ocr().

pub struct Ocr<'a> {
    /* private fields */
}

Methods

MethodHTTPPath
documentPOST/v1/ocr:document

Errors and cancellation

Calls return Result<T>. See Error for validation, HTTP, transport, decoding, and timeout failures. Stream items can also return errors after the call succeeds.

Pagination helpers fetch pages when polled. Drop a page or event stream to cancel further work.

Implementations

impl Ocr<'_>

document

pub async fn document(&self, body: &OcrDocumentRequest) -> Result<OcrDocumentResponse>

Run OCR on a document or image

Runs layout-aware OCR on the provided document bytes and returns per-page results. When a page range is provided, only the inclusive subset is processed. Requires OCR_DOCUMENT permission.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: POST /v1/ocr:document

Types

Trait implementations

  • Clone (derived)
  • Copy (derived)
  • Debug (derived)

On this page