Vision · IOS API REFERENCE

RecognizeDocumentsRequest

struct · iOS 26.0+ · SDK 27.1

struct RecognizeDocumentsRequest

An image-analysis request to scan an image of a document and provide information about its structure. This request scans a document and extracts different groups of text and barcodes within the document image. Use this request to understand different types of structured texts like receipts, nutritional labels, textbook pages, forms, or other documents that you want to understand in further detail. The request generates a ``DocumentObservation`` array, which allows you to access your chosen document’s structure grouped by words, lines, or paragraphs. You can also access tables and lists that appear in the document.

Members (14)

get · iOS 26.0+

descriptor

TypeScript

get descriptor(): RequestDescriptor

Swift declaration

var descriptor: RequestDescriptor { get }

An enum that identifies the request and request revision.

get · iOS 26.0+

regionOfInterest

TypeScript

get regionOfInterest(): NormalizedRect

Swift declaration

var regionOfInterest: NormalizedRect

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

set · iOS 26.0+

regionOfInterest

TypeScript

set regionOfInterest(value: NormalizedRect)

Swift declaration

var regionOfInterest: NormalizedRect

method · iOS 26.0+

setComputeDevice

TypeScript

setComputeDevice(computeDevice: (_CoreML_MLComputeDevice) | null, computeStage: ComputeStage): void

Swift declaration

mutating func setComputeDevice(_ computeDevice: MLComputeDevice?, for computeStage: ComputeStage)

Assigns a compute device for a compute stage. If the parameter `computeDevice` is `nil`, the framework removes any explicit compute device assignment and allows the framework to select the device. Configure any compute device for a given compute stage. When performing a request, the system makes a validity check. Use `supportedComputeStageDevices` to get valid compute devices for a request’s compute stages. - Parameters: - `computeDevice: `The compute device to assign to the compute stage. - `computeStage: `The compute stage.

get · iOS 26.0+

supportedRevisions

TypeScript

static get supportedRevisions(): Array<RecognizeDocumentsRequest_Revision>

Swift declaration

static let supportedRevisions: [RecognizeDocumentsRequest.Revision]

The revisions supported by `ClassifyImageRequest`.

get · iOS 26.0+

textRecognitionOptions

TypeScript

get textRecognitionOptions(): RecognizeDocumentsRequest_TextRecognitionOptions

Swift declaration

var textRecognitionOptions: RecognizeDocumentsRequest.TextRecognitionOptions

Configuration for recognizing text in the document. Set properties such as what languages are detected.

set · iOS 26.0+

textRecognitionOptions

TypeScript

set textRecognitionOptions(value: RecognizeDocumentsRequest_TextRecognitionOptions)

Swift declaration

var textRecognitionOptions: RecognizeDocumentsRequest.TextRecognitionOptions

Configuration for recognizing text in the document. Set properties such as what languages are detected.

get · iOS 26.0+

barcodeDetectionOptions

TypeScript

get barcodeDetectionOptions(): RecognizeDocumentsRequest_BarcodeDetectionOptions

Swift declaration

var barcodeDetectionOptions: RecognizeDocumentsRequest.BarcodeDetectionOptions

Configuration for detecting machine-readable codes in the document. Enable barcode detection and set what symbologies (eg. `.qrCode`) will be detected.

set · iOS 26.0+

barcodeDetectionOptions

TypeScript

set barcodeDetectionOptions(value: RecognizeDocumentsRequest_BarcodeDetectionOptions)

Swift declaration

var barcodeDetectionOptions: RecognizeDocumentsRequest.BarcodeDetectionOptions

Configuration for detecting machine-readable codes in the document. Enable barcode detection and set what symbologies (eg. `.qrCode`) will be detected.

get · iOS 26.0+

supportedBarcodeSymbologies

TypeScript

get supportedBarcodeSymbologies(): Array<BarcodeSymbology>

Swift declaration

var supportedBarcodeSymbologies: [BarcodeSymbology] { get }

The collection of revisions the request supports.

get · iOS 26.0+

supportedComputeStageDevices

TypeScript

get supportedComputeStageDevices(): NativeMap<ComputeStage, Array<_CoreML_MLComputeDevice>>

Swift declaration

var supportedComputeStageDevices: [ComputeStage : [MLComputeDevice]] { get }

get · iOS 26.0+

supportedRecognitionLanguages

TypeScript

get supportedRecognitionLanguages(): Array<_Foundation_Locale_Language>

Swift declaration

var supportedRecognitionLanguages: [Locale.Language] { get }

The identifiers of the languages that the request supports.

get · iOS 26.0+

revision

TypeScript

get revision(): RecognizeDocumentsRequest_Revision

Swift declaration

let revision: RecognizeDocumentsRequest.Revision

The request's configured revision.

init · iOS 26.0+

init

TypeScript

static init(revision?: (RecognizeDocumentsRequest_Revision) | null): RecognizeDocumentsRequest

Swift declaration

init(_ revision: RecognizeDocumentsRequest.Revision? = nil)

Creates a document content recognition request. - Parameters: - revision: The specific algorithm or implementation revision that performs the request.

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →