Class

SFSpeechRecognitionRequest

An abstract class representing a request to recognize speech from an audio source.

Declaration

@interface SFSpeechRecognitionRequest : NSObject

Overview

Do not create SFSpeechRecognitionRequest objects directly. Create an SFSpeechURLRecognitionRequest or SFSpeechAudioBufferRecognitionRequest object instead. Use the properties of this class to configure various aspects of your request object before you start the speech recognition process. For example, use the shouldReportPartialResults property to specify whether you want partial results or only the final result of speech recognition.

Topics

Configuring the Recognition Request

requiresOnDeviceRecognition

A Boolean value that determines whether a request must keep its audio data on the device.

shouldReportPartialResults

A Boolean value that indicates whether you want intermediate results returned for each utterance.

contextualStrings

An array of phrases that should be recognized, even if they are not in the system vocabulary.

Classifying the Type of Speech

taskHint

A value that indicates the type of speech recognition being performed.

SFSpeechRecognitionTaskHint

The type of task for which you are using speech recognition.

Identifying the Request

interactionIdentifier

An identifier string that you use to describe the type of interaction associated with the speech recognition request.

Relationships

Inherits From

See Also

Audio Sources

Recognizing Speech in Live Audio

Perform speech recognition on audio coming from the microphone of an iOS device.

SFSpeechURLRecognitionRequest

A request to recognize speech in a recorded audio file.

SFSpeechAudioBufferRecognitionRequest

A request to recognize speech from captured audio content, such as audio from the device's microphone.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software