RecognizedTextObservation

bottomLeft

get bottomLeft(): NormalizedPoint

let bottomLeft: NormalizedPoint

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

confidence

get confidence(): number

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

transcript

get transcript(): string

var transcript: String { get }

The top text candidate as a string. Please call `topCandidates` to see alternate text candidates.

bottomRight

get bottomRight(): NormalizedPoint

let bottomRight: NormalizedPoint

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

description

get description(): string

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.

textDirection

get textDirection(): (RecognizedTextObservation_Direction) | null

let textDirection: RecognizedTextObservation.Direction?

topCandidates

topCandidates(maxCandidateCount: number): Array<RecognizedText>

func topCandidates(_ maxCandidateCount: Int) -> [RecognizedText]

Requests the n top candidates for a recognized text string. This function returns no more than n candidates, but it may return fewer than n candidates. - Parameters: - maxCandidateCount: The maximum number of candidates to return. This can't exceed 10. - Returns: An array of the n top candidates, sorted by decreasing confidence score.

boundingRegion

get boundingRegion(): ContoursObservation_Contour

var boundingRegion: NormalizedRegion { get }

The bounding region of the text.

recognitionLanguages

get recognitionLanguages(): Array<_Foundation_Locale_Language>

let recognitionLanguages: [Locale.Language]

The languages in which the recognized text was written.

shouldWrapToNextLine

get shouldWrapToNextLine(): (boolean) | null

let shouldWrapToNextLine: Bool?

Whether the text continues on the next line.

originatingRequestDescriptor

get originatingRequestDescriptor(): (RequestDescriptor) | null

let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

uuid

get uuid(): string

let uuid: UUID

The unique identifier for the observation.

isTitle

get isTitle(): boolean

let isTitle: Bool

Whether this text is the title of the document.

topLeft

get topLeft(): NormalizedPoint

let topLeft: NormalizedPoint

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

topRight

get topRight(): NormalizedPoint

let topRight: NormalizedPoint

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

timeRange

get timeRange(): (_CoreMedia_CMTimeRange) | null

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

static init(observation: VNRecognizedTextObservation): RecognizedTextObservation

init(_ observation: VNRecognizedTextObservation)