A configuration object for detected and recognized text within the document.
Members (12)
get · iOS 26.0+
minimumTextHeightFraction
TypeScript
get minimumTextHeightFraction(): number
Swift declaration
var minimumTextHeightFraction: Float
The minimum height, relative to the image height, of the text to recognize.
Specify a floating-point number relative to the image height. For example, to limit recognition to
text that's half of the image height, use `0.5`. Increasing the size reduces memory
consumption and expedites recognition with the tradeoff of ignoring text smaller than the
minimum height. The default value is `1/32`, or `0.03125`.
set · iOS 26.0+
minimumTextHeightFraction
TypeScript
set minimumTextHeightFraction(value: number)
Swift declaration
var minimumTextHeightFraction: Float
The minimum height, relative to the image height, of the text to recognize.
Specify a floating-point number relative to the image height. For example, to limit recognition to
text that's half of the image height, use `0.5`. Increasing the size reduces memory
consumption and expedites recognition with the tradeoff of ignoring text smaller than the
minimum height. The default value is `1/32`, or `0.03125`.
get · iOS 26.0+
customWords
TypeScript
get customWords(): Array<string>
Swift declaration
var customWords: [String]
An array of strings to supplement the recognized languages at the word-recognition stage.
Custom words take precedence over the standard lexicon. The request ignores this value if
``RecognizeDocumentsRequest/TextRecognitionOptions/useLanguageCorrection``
is `false`.
set · iOS 26.0+
customWords
TypeScript
set customWords(value: Array<string>)
Swift declaration
var customWords: [String]
An array of strings to supplement the recognized languages at the word-recognition stage.
Custom words take precedence over the standard lexicon. The request ignores this value if
``RecognizeDocumentsRequest/TextRecognitionOptions/useLanguageCorrection``
is `false`.
get · iOS 26.0+
recognitionLanguages
TypeScript
get recognitionLanguages(): Array<_Foundation_Locale_Language>
Swift declaration
var recognitionLanguages: [Locale.Language]
An array of languages to detect, in priority order.
The order of the languages in the array defines the order in which the system uses languages
during language processing and text recognition.
Specify the languages as two-letter ISO language codes.
set · iOS 26.0+
recognitionLanguages
TypeScript
set recognitionLanguages(value: Array<_Foundation_Locale_Language>)
Swift declaration
var recognitionLanguages: [Locale.Language]
An array of languages to detect, in priority order.
The order of the languages in the array defines the order in which the system uses languages
during language processing and text recognition.
Specify the languages as two-letter ISO language codes.
get · iOS 26.0+
maximumCandidateCount
TypeScript
get maximumCandidateCount(): number
Swift declaration
var maximumCandidateCount: Int
The maximum number of text candidates to return.
There are different variations of this candiate count, the default value is `3`, and the maximum
value is `10`.
set · iOS 26.0+
maximumCandidateCount
TypeScript
set maximumCandidateCount(value: number)
Swift declaration
var maximumCandidateCount: Int
The maximum number of text candidates to return.
There are different variations of this candiate count, the default value is `3`, and the maximum
value is `10`.
get · iOS 26.0+
useLanguageCorrection
TypeScript
get useLanguageCorrection(): boolean
Swift declaration
var useLanguageCorrection: Bool
A Boolean value that indicates whether the request applies language correction during the
recognition process.
When this value is `true`, Vision applies language correction during the recognition process.
When set to `false`, this property returns the raw recognition results, which provides
performance benefits but less accurate results.
set · iOS 26.0+
useLanguageCorrection
TypeScript
set useLanguageCorrection(value: boolean)
Swift declaration
var useLanguageCorrection: Bool
A Boolean value that indicates whether the request applies language correction during the
recognition process.
When this value is `true`, Vision applies language correction during the recognition process.
When set to `false`, this property returns the raw recognition results, which provides
performance benefits but less accurate results.
get · iOS 26.0+
automaticallyDetectLanguage
TypeScript
get automaticallyDetectLanguage(): boolean
Swift declaration
var automaticallyDetectLanguage: Bool
A Boolean value that indicates whether to attempt detecting the language to use the
appropriate model for recognition and language correction.
set · iOS 26.0+
automaticallyDetectLanguage
TypeScript
set automaticallyDetectLanguage(value: boolean)
Swift declaration
var automaticallyDetectLanguage: Bool
A Boolean value that indicates whether to attempt detecting the language to use the
appropriate model for recognition and language correction.
