adobe.pdfservices.operation.pdfjobs.params.ocr_pdf package

Submodules

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params module

class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_params.OCRParams(*, ocr_locale: OCRSupportedLocale = OCRSupportedLocale.EN_US, ocr_type: OCRSupportedType = OCRSupportedType.SEARCHABLE_IMAGE)

Bases: PDFServicesJobParams

Parameters for converting PDF to a searchable PDF using OCRPDFJob<adobe.pdfservices.operation.pdfjobs.jobs.ocr_pdf_job.OCRPDFJob

Constructs a new OCRParams instance.

Parameters:
get_ocr_locale()
Returns:

OCRSupportedLocale to be used for OCR.

Return type:

OCRSupportedLocale

get_ocr_type()
Returns:

OCRSupportedType to be used for OCR.

Return type:

OCRSupportedType

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale module

class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_locale.OCRSupportedLocale(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported locales for OCRJob

Construct a locale from a language code.

Parameters:

locale – language code

BG_BG = 'bg-BG'

Represents “Bulgarian (Bulgaria)” locale

CA_CA = 'ca-CA'

Represents “Catalan (Canada)” locale

CS_CZ = 'cs-CZ'

Represents “Czech (Czech Republic)” locale

DA_DK = 'da-DK'

Represents “Danish (Denmark)” locale

DE_CH = 'de-CH'

Represents “German (Switzerland)” locale

DE_DE = 'de-DE'

Represents “German (Germany)” locale

EL_GR = 'el-GR'

Represents “Greek (Greece)” locale

EN_GB = 'en-GB'

Represents “English (United Kingdom)” locale

EN_US = 'en-US'

Represents “English (United States)” locale

ES_ES = 'es-ES'

Represents “Spanish (Spain)” locale

ET_EE = 'et-EE'

Represents “Estonian (Estonia)” locale

FI_FI = 'fi-FI'

Represents “Finnish (Finland)” locale

FR_FR = 'fr-FR'

Represents “French (France)” locale

HR_HR = 'hr-HR'

Represents “Croatian (Croatia)” locale

HU_HU = 'hu-HU'

Represents “Hungarian (Hungary)” locale

IT_IT = 'it-IT'

Represents “Italian (Italy)” locale

IW_IL = 'iw-IL'

Represents “Hebrew (Israel)” locale

JA_JP = 'ja-JP'

Represents “Japanese (Japan)” locale

KO_KR = 'ko-KR'

Represents “Korean (Korea)” locale

LT_LT = 'lt-LT'

Represents “Lithuanian (Lithuania)” locale

LV_LV = 'lv-LV'

Represents “Latvian (Latvia)” locale

MK_MK = 'mk-MK'

Represents “Macedonian (Macedonia)” locale

MT_MT = 'mt-MT'

Represents “Maltese (Malta)” locale

NB_NO = 'nb-NO'

Represents “Norwegian (Norway)” locale

NL_NL = 'nl-NL'

Represents “Dutch (Netherlands)” locale

NO_NO = 'no-NO'

Represents “Norwegian (Norway)” locale

PL_PL = 'pl-PL'

Represents “Polish (Poland)” locale

PT_BR = 'pt-BR'

Represents “Portuguese (Brazil)” locale

RO_RO = 'ro-RO'

Represents “Romanian (Romania)” locale

RU_RU = 'ru-RU'

Represents “Russian (Russia)” locale

SK_SK = 'sk-SK'

Represents “Slovak (Slovakia)” locale

SL_SI = 'sl-SI'

Represents “Slovenian (Slovenia)” locale

SR_SR = 'sr-SR'

Represents “Serbian (Serbia)” locale

SV_SE = 'sv-SE'

Represents “Swedish (Sweden)” locale

TR_TR = 'tr-TR'

Represents “Turkish (Turkey)” locale

UK_UA = 'uk-UA'

Represents “Ukrainian (Ukraine)” locale

ZH_CN = 'zh-CN'

Represents “Chinese (China)” locale

ZH_HK = 'zh-HK'

Represents “Chinese (Hong Kong)” locale

get_locale()

Returns the language code of this OCRSupportedLocale.

Returns:

language code of the locale

adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type module

class adobe.pdfservices.operation.pdfjobs.params.ocr_pdf.ocr_supported_type.OCRSupportedType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported OCR types for OCRJob

Constructs OCR Type from its string representation.

Parameters:

ocr_type – String representation

SEARCHABLE_IMAGE = 'searchable_image'
SEARCHABLE_IMAGE_EXACT = 'searchable_image_exact'
get_type()

Returns the string representation of this OCRSupportedType.

Returns:

String representation of this OCRSupportedType

Module contents