recognize_text method

recognize_text

Recognizes text from an image stream.

def recognize_text(self, image_stream, page_index, options):
    ...
Parameter Type Description
image_stream io.RawIOBase The image representation of the document page.
page_index int The page index of the document.
options OcrOptions The OCR options.

Returns: str | None: The recognized text, or None if text recognition isn’t supported.

recognize_text

Recognize text from an image stream.

def recognize_text(self, image_stream, options):
    ...
Parameter Type Description
image_stream io.RawIOBase The image representation of the document page.
options OcrOptions The OCR options.

Returns: str or None: The recognized text, or None if text recognition isn’t supported.

Aliases

These names call recognize_text too, limited to the overloads listed.

Alias Accepts
recognize_text_stream recognize_text_stream(image_stream, page_index, options)
recognize_text_stream(image_stream, options)
recognize_text_streams recognize_text_streams(image_stream, page_index, options)
recognize_text_streams(image_stream, options)

See Also