Class YSKRecognition

The recognition result returned during speech recognition.

The recognition result contains a list of the best recognition hypotheses with their confidence scores (a so-called N-best list). The list of hypotheses is sorted in descending order, with the most likely recognition result at the top. To get the list of hypotheses, use the hypotheses property.

Instance Methods

-initWithHypotheses:

Initializes an object of the YSKRecognition class with the specified list of hypotheses.

-initWithHypotheses:biometry:

Initializes an object of the YSKRecognition class with the specified list of hypotheses and estimated biometrics.

-initWithHypotheses:requestId:biometry:

Initializes an object of the YSKRecognition class with the specified list of hypotheses, estimated biometrics and request ID.

Properties

bestResultText

Text of the best hypothesis.

biometry

Estimated biometrics of the user, such as age, gender, and age group.

hypotheses

List of hypotheses sorted in descending order of confidence score.

requestId

Request ID.

Method Detail

-initWithHypotheses:

- (instancetype)initWithHypotheses:(NSArray< YSKRecognitionHypothesis * > *)hypotheses 

Initializes an object of the YSKRecognition class with the specified list of hypotheses.

This method is a designated initializer for the YSKRecognition class.
Parameters:
hypotheses

List of hypotheses sorted in descending order of confidence score.

Returns:

An object of the YSKRecognition class.

-initWithHypotheses:biometry:

- (instancetype)initWithHypotheses:(NSArray< YSKRecognitionHypothesis * > *)hypotheses
                          biometry:(nullable YSKBiometry *)biometry 

Initializes an object of the YSKRecognition class with the specified list of hypotheses and estimated biometrics.

Parameters:
hypotheses

List of hypotheses sorted in descending order of confidence score.

biometry

Estimated biometrics of the user.

Returns:

An object of the YSKRecognition class.

-initWithHypotheses:requestId:biometry:

- (instancetype)initWithHypotheses:(NSArray< YSKRecognitionHypothesis * > *)hypotheses
                         requestId:(NSString *)requestId
                          biometry:(nullable YSKBiometry *)biometry 

Initializes an object of the YSKRecognition class with the specified list of hypotheses, estimated biometrics and request ID.

Parameters:
hypotheses

List of hypotheses sorted in descending order of confidence score.

requestId

Request ID.

biometry

Biometrics of the user.

Returns:

An object of the YSKRecognition class.

Property Detail

bestResultText

(copy, readonly) NSString * bestResultText

Text of the best hypothesis.

biometry

(copy, readonly) YSKBiometry * biometry

Estimated biometrics of the user, such as age, gender, and age group.

The YSKBiometry object is returned not equal to nil in the recognizer:didReceivePartialResults:withEndOfUtterance: method if the following conditions are met:

hypotheses

(copy, readonly) NSArray< YSKRecognitionHypothesis * > * hypotheses

List of hypotheses sorted in descending order of confidence score.

requestId

(copy, readonly) NSString * requestId

Request ID.