Examples with RecognitionJob com.ibm.watson.developer_cloud.speech_to_text.v1.model.RecognitionJob used on opensource projects

Example 6 with RecognitionJob

use of com.ibm.watson.developer_cloud.speech_to_text.v1.model.RecognitionJob in project java-sdk by watson-developer-cloud.

the class SpeechToText method createJob.

/**
 * Creates a job for an asynchronous recognition request.
 *
 * Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials
 * are used to create it. How you learn the status and results of a job depends on the parameters you include with the
 * job creation request: * By callback notification: Include the `callback_url` query parameter to specify a URL to
 * which the service is to send callback notifications when the status of the job changes. Optionally, you can also
 * include the `events` and `user_token` query parameters to subscribe to specific events and to specify a string that
 * is to be included with each notification for the job. * By polling the service: Omit the `callback_url`, `events`,
 * and `user_token` query parameters. You must then use the `GET /v1/recognitions` or `GET /v1/recognitions/{id}`
 * methods to check the status of the job, using the latter to retrieve the results when the job is complete. The two
 * approaches are not mutually exclusive. You can poll the service for job status or obtain results from the service
 * manually even if you include a callback URL. In both cases, you can include the `results_ttl` parameter to specify
 * how long the results are to remain available after the job is complete. Note that using the HTTPS `GET
 * /v1/recognitions/{id}` method to retrieve results is more secure than receiving them via callback notification over
 * HTTP because it provides confidentiality in addition to authentication and data integrity. The method supports the
 * same basic parameters as other HTTP and WebSocket recognition requests. The service imposes a data size limit of
 * 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple
 * channels, downmixes the audio to one-channel mono during transcoding. (For the `audio/l16` format, you can specify
 * the endianness.).
 *
 * @param createJobOptions the {@link CreateJobOptions} containing the options for the call
 * @return a {@link ServiceCall} with a response type of {@link RecognitionJob}
 */
public ServiceCall<RecognitionJob> createJob(CreateJobOptions createJobOptions) {
    Validator.notNull(createJobOptions, "createJobOptions cannot be null");
    String[] pathSegments = { "v1/recognitions" };
    RequestBuilder builder = RequestBuilder.post(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments));
    builder.header("Content-Type", createJobOptions.contentType());
    if (createJobOptions.model() != null) {
        builder.query("model", createJobOptions.model());
    }
    if (createJobOptions.callbackUrl() != null) {
        builder.query("callback_url", createJobOptions.callbackUrl());
    }
    if (createJobOptions.events() != null) {
        builder.query("events", createJobOptions.events());
    }
    if (createJobOptions.userToken() != null) {
        builder.query("user_token", createJobOptions.userToken());
    }
    if (createJobOptions.resultsTtl() != null) {
        builder.query("results_ttl", String.valueOf(createJobOptions.resultsTtl()));
    }
    if (createJobOptions.customizationId() != null) {
        builder.query("customization_id", createJobOptions.customizationId());
    }
    if (createJobOptions.acousticCustomizationId() != null) {
        builder.query("acoustic_customization_id", createJobOptions.acousticCustomizationId());
    }
    if (createJobOptions.customizationWeight() != null) {
        builder.query("customization_weight", String.valueOf(createJobOptions.customizationWeight()));
    }
    if (createJobOptions.version() != null) {
        builder.query("version", createJobOptions.version());
    }
    if (createJobOptions.inactivityTimeout() != null) {
        builder.query("inactivity_timeout", String.valueOf(createJobOptions.inactivityTimeout()));
    }
    if (createJobOptions.keywords() != null) {
        builder.query("keywords", RequestUtils.join(createJobOptions.keywords(), ","));
    }
    if (createJobOptions.keywordsThreshold() != null) {
        builder.query("keywords_threshold", String.valueOf(createJobOptions.keywordsThreshold()));
    }
    if (createJobOptions.maxAlternatives() != null) {
        builder.query("max_alternatives", String.valueOf(createJobOptions.maxAlternatives()));
    }
    if (createJobOptions.wordAlternativesThreshold() != null) {
        builder.query("word_alternatives_threshold", String.valueOf(createJobOptions.wordAlternativesThreshold()));
    }
    if (createJobOptions.wordConfidence() != null) {
        builder.query("word_confidence", String.valueOf(createJobOptions.wordConfidence()));
    }
    if (createJobOptions.timestamps() != null) {
        builder.query("timestamps", String.valueOf(createJobOptions.timestamps()));
    }
    if (createJobOptions.profanityFilter() != null) {
        builder.query("profanity_filter", String.valueOf(createJobOptions.profanityFilter()));
    }
    if (createJobOptions.smartFormatting() != null) {
        builder.query("smart_formatting", String.valueOf(createJobOptions.smartFormatting()));
    }
    if (createJobOptions.speakerLabels() != null) {
        builder.query("speaker_labels", String.valueOf(createJobOptions.speakerLabels()));
    }
    builder.body(InputStreamRequestBody.create(MediaType.parse(createJobOptions.contentType()), createJobOptions.audio()));
    return createServiceCall(builder.build(), ResponseConverterUtils.getObject(RecognitionJob.class));
}