public class RecognitionJob
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static interface |
RecognitionJob.Status
The current status of the job: * `waiting`: The service is preparing the job for processing.
|
Modifier and Type | Method and Description |
---|---|
String |
getCreated()
Gets the created.
|
String |
getId()
Gets the id.
|
List<SpeechRecognitionResults> |
getResults()
Gets the results.
|
String |
getStatus()
Gets the status.
|
String |
getUpdated()
Gets the updated.
|
String |
getUrl()
Gets the url.
|
String |
getUserToken()
Gets the userToken.
|
List<String> |
getWarnings()
Gets the warnings.
|
public String getId()
The ID of the asynchronous job.
public String getStatus()
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.
public String getCreated()
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`).
public String getUpdated()
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](#checkjobs) and [Check a job[(#checkjob) methods.
public String getUrl()
The URL to use to request information about the job with the [Check a job](#checkjob) method. This field is returned only by the [Create a job](#createjob) method.
public String getUserToken()
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](#checkjobs) method.
public List<SpeechRecognitionResults> getResults()
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](#checkjob) method.
public List<String> getWarnings()
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](#createjob) method. (If you use the `character_insertion_bias` parameter with a previous-generation model, the warning message refers to the parameter as `lambdaBias`.).
Copyright © 2023 IBM Cloud. All rights reserved.