Vision · IOS API REFERENCE

DocumentObservation

struct · iOS 26.0+ · SDK 27.1

struct DocumentObservation

Information about the sections of content that an image-analysis request detects in a document. The observation allows you to access a document’s content and group it within different sections. An observation is the result of using a ``RecognizeDocumentsRequest`` to process an image of a document and detects the content within that document using a container. Each container provides access to any text, lists, barcodes, or any other detected data that appears within the region of the container.

Members (6)

get · iOS 26.0+

confidence

TypeScript

get confidence(): number

Swift declaration

let confidence: Float

The level of confidence in the observation's accuracy. The framework normalizes this value to `[0, 1]`, where `1` represents the most confident in the observation's accuracy.

get · iOS 26.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 26.0+

originatingRequestDescriptor

TypeScript

get originatingRequestDescriptor(): (RequestDescriptor) | null

Swift declaration

let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

get · iOS 26.0+

uuid

TypeScript

get uuid(): string

Swift declaration

let uuid: UUID

A unique alphanumeric value that the framework assigns to the observation.

get · iOS 26.0+

document

TypeScript

get document(): DocumentObservation_Container

Swift declaration

let document: DocumentObservation.Container

The contents of the document.

get · iOS 26.0+

timeRange

TypeScript

get timeRange(): (_CoreMedia_CMTimeRange) | null

Swift declaration

let timeRange: CMTimeRange?

Time in a video frame where the observation was detected. When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →