RecognitionJob

public struct RecognitionJob : Codable, Equatable

Information about a current asynchronous speech recognition job.

  • The current status of the job:

    • waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it.
    • processing: The service is actively processing the job.
    • completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification. Otherwise, you must retrieve the results by checking the individual job.
    • failed: The job failed.
    See more

    Declaration

    Swift

    public enum Status : String
  • id

    The ID of the asynchronous job.

    Declaration

    Swift

    public var id: String
  • The current status of the job:

    • waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it.
    • processing: The service is actively processing the job.
    • completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification. Otherwise, you must retrieve the results by checking the individual job.
    • failed: The job failed.

    Declaration

    Swift

    public var status: String
  • The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    Declaration

    Swift

    public var created: String
  • The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs and [Check a job[(#checkjob) methods.

    Declaration

    Swift

    public var updated: String?
  • url

    The URL to use to request information about the job with the Check a job method. This field is returned only by the Create a job method.

    Declaration

    Swift

    public var url: String?
  • The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the Check jobs method.

    Declaration

    Swift

    public var userToken: String?
  • If the status is completed, the results of the recognition request as an array that includes a single instance of a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    Declaration

    Swift

    public var results: [SpeechRecognitionResults]?
  • An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be returned only by the Create a job method.

    Declaration

    Swift

    public var warnings: [String]?