SpeechRecognitionResults

public struct SpeechRecognitionResults : Codable, Equatable

The complete results for a speech recognition request.

  • An array of SpeechRecognitionResult objects that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the result_index is set to the lowest index in the array that has changed; it is incremented for new results.

    Declaration

    Swift

    public var results: [SpeechRecognitionResult]?
  • An index that indicates a change point in the results array. The service increments the index only for additional results that it sends for new audio for the same request.

    Declaration

    Swift

    public var resultIndex: Int?
  • An array of SpeakerLabelsResult objects that identifies which words were spoken by which speakers in a multi-person exchange. The array is returned only if the speaker_labels parameter is true. When interim results are also requested for methods that support them, it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    Declaration

    Swift

    public var speakerLabels: [SpeakerLabelsResult]?
  • If processing metrics are requested, information about the service’s processing of the input audio. Processing metrics are not available with the synchronous Recognize audio method.

    Declaration

    Swift

    public var processingMetrics: ProcessingMetrics?
  • If audio metrics are requested, information about the signal characteristics of the input audio.

    Declaration

    Swift

    public var audioMetrics: AudioMetrics?
  • An array of warning messages associated with the request:

    • Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "{invalid_arg_1}, {invalid_arg_2}."
    • The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: "Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model." In both cases, the request succeeds despite the warnings.

    Declaration

    Swift

    public var warnings: [String]?