One Logo Pool Ball
Vision · IOS API REFERENCE

TextObservation

struct · iOS 18.0+ · SDK 27.1

struct TextObservation

Members (12)

get · iOS 18.0+

bottomLeft

TypeScript
get bottomLeft(): NormalizedPoint
Swift declaration
let bottomLeft: NormalizedPoint

The coordinates of the lower-left corner of the quadrilateral.

get · iOS 18.0+

confidence

TypeScript
get confidence(): number
Swift declaration
let confidence: Float

The level of confidence normalized to `[0, 1]` where `1` is most confident. The only exception is results coming from `CoreMLRequest`, where confidence values are forwarded as is from relevant CoreML models

get · iOS 18.0+

bottomRight

TypeScript
get bottomRight(): NormalizedPoint
Swift declaration
let bottomRight: NormalizedPoint

The coordinates of the lower-right corner of the quadrilateral.

get · iOS 18.0+

boundingBox

TypeScript
get boundingBox(): NormalizedRect
Swift declaration
let boundingBox: NormalizedRect

The bounding box of the object. The coordinate system is normalized to the dimensions of the processed image, with the origin at the lower-left corner of the image.

get · iOS 18.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 18.0+

characterBoxes

TypeScript
get characterBoxes(): (Array<RectangleObservation>) | null
Swift declaration
let characterBoxes: [RectangleObservation]?

An array of detected individual character bounding boxes. If the associated `DetectTextRectanglesRequest` indicates interest in character boxes by setting the option `reportCharacterBoxes` to `true`, this property is non-`nil`. If no characters are found, it remains empty.

get · iOS 18.0+

originatingRequestDescriptor

TypeScript
get originatingRequestDescriptor(): (RequestDescriptor) | null
Swift declaration
let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

get · iOS 18.0+

uuid

TypeScript
get uuid(): string
Swift declaration
let uuid: UUID

The unique identifier for the observation.

get · iOS 18.0+

topLeft

TypeScript
get topLeft(): NormalizedPoint
Swift declaration
let topLeft: NormalizedPoint

The coordinates of the upper-left corner of the quadrilateral.

get · iOS 18.0+

topRight

TypeScript
get topRight(): NormalizedPoint
Swift declaration
let topRight: NormalizedPoint

The coordinates of the upper-right corner of the quadrilateral.

get · iOS 18.0+

timeRange

TypeScript
get timeRange(): (_CoreMedia_CMTimeRange) | null
Swift declaration
let timeRange: CMTimeRange?

The time range of the reported observation. When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.

init · iOS 18.0+

init

TypeScript
static init(observation: VNTextObservation): TextObservation
Swift declaration
init(_ observation: VNTextObservation)

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →