Package software.amazon.awssdk.services.transcribe.model

Interface TranscriptionJob.Builder

    • Method Detail

      • transcriptionJobName

        TranscriptionJob.Builder transcriptionJobName​(String transcriptionJobName)

        The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

        Parameters:
        transcriptionJobName - The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transcriptionJobStatus

        TranscriptionJob.Builder transcriptionJobStatus​(String transcriptionJobStatus)

        Provides the status of the specified transcription job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

        Parameters:
        transcriptionJobStatus - Provides the status of the specified transcription job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TranscriptionJobStatus, TranscriptionJobStatus

      • transcriptionJobStatus

        TranscriptionJob.Builder transcriptionJobStatus​(TranscriptionJobStatus transcriptionJobStatus)

        Provides the status of the specified transcription job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

        Parameters:
        transcriptionJobStatus - Provides the status of the specified transcription job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TranscriptionJobStatus, TranscriptionJobStatus

      • languageCode

        TranscriptionJob.Builder languageCode​(String languageCode)

        The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

        Parameters:
        languageCode - The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • languageCode

        TranscriptionJob.Builder languageCode​(LanguageCode languageCode)

        The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

        Parameters:
        languageCode - The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • mediaSampleRateHertz

        TranscriptionJob.Builder mediaSampleRateHertz​(Integer mediaSampleRateHertz)

        The sample rate, in hertz, of the audio track in your input media file.

        Parameters:
        mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mediaFormat

        TranscriptionJob.Builder mediaFormat​(String mediaFormat)

        The format of the input media file.

        Parameters:
        mediaFormat - The format of the input media file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MediaFormat, MediaFormat

      • mediaFormat

        TranscriptionJob.Builder mediaFormat​(MediaFormat mediaFormat)

        The format of the input media file.

        Parameters:
        mediaFormat - The format of the input media file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MediaFormat, MediaFormat

      • media

        TranscriptionJob.Builder media​(Media media)

        Provides the Amazon S3 location of the media file you used in your request.

        Parameters:
        media - Provides the Amazon S3 location of the media file you used in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transcript

        TranscriptionJob.Builder transcript​(Transcript transcript)

        Provides you with the Amazon S3 URI you can use to access your transcript.

        Parameters:
        transcript - Provides you with the Amazon S3 URI you can use to access your transcript.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        TranscriptionJob.Builder startTime​(Instant startTime)

        The date and time the specified transcription job began processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Parameters:
        startTime - The date and time the specified transcription job began processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        TranscriptionJob.Builder creationTime​(Instant creationTime)

        The date and time the specified transcription job request was made.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Parameters:
        creationTime - The date and time the specified transcription job request was made.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • completionTime

        TranscriptionJob.Builder completionTime​(Instant completionTime)

        The date and time the specified transcription job finished processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

        Parameters:
        completionTime - The date and time the specified transcription job finished processing.

        Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        TranscriptionJob.Builder failureReason​(String failureReason)

        If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

        The FailureReason field contains one of the following values:

        • Unsupported media format.

          The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

        • The media format provided does not match the detected media format.

          The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

        • Invalid sample rate for audio file.

          The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

        • The sample rate provided does not match the detected sample rate.

          The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

        • Invalid file size: file size too large.

          The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

        • Invalid number of channels: number of channels too large.

          Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

        Parameters:
        failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

        The FailureReason field contains one of the following values:

        • Unsupported media format.

          The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

        • The media format provided does not match the detected media format.

          The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

        • Invalid sample rate for audio file.

          The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

        • The sample rate provided does not match the detected sample rate.

          The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

        • Invalid file size: file size too large.

          The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

        • Invalid number of channels: number of channels too large.

          Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • settings

        TranscriptionJob.Builder settings​(Settings settings)

        Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

        Parameters:
        settings - Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelSettings

        TranscriptionJob.Builder modelSettings​(ModelSettings modelSettings)

        Provides information on the custom language model you included in your request.

        Parameters:
        modelSettings - Provides information on the custom language model you included in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobExecutionSettings

        TranscriptionJob.Builder jobExecutionSettings​(JobExecutionSettings jobExecutionSettings)

        Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

        Parameters:
        jobExecutionSettings - Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentRedaction

        TranscriptionJob.Builder contentRedaction​(ContentRedaction contentRedaction)

        Indicates whether redaction was enabled in your transcript.

        Parameters:
        contentRedaction - Indicates whether redaction was enabled in your transcript.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • identifyLanguage

        TranscriptionJob.Builder identifyLanguage​(Boolean identifyLanguage)

        Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

        Parameters:
        identifyLanguage - Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • identifyMultipleLanguages

        TranscriptionJob.Builder identifyMultipleLanguages​(Boolean identifyMultipleLanguages)

        Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

        Parameters:
        identifyMultipleLanguages - Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageOptionsWithStrings

        TranscriptionJob.Builder languageOptionsWithStrings​(Collection<String> languageOptions)

        Provides the language codes you specified in your request.

        Parameters:
        languageOptions - Provides the language codes you specified in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageOptionsWithStrings

        TranscriptionJob.Builder languageOptionsWithStrings​(String... languageOptions)

        Provides the language codes you specified in your request.

        Parameters:
        languageOptions - Provides the language codes you specified in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageOptions

        TranscriptionJob.Builder languageOptions​(Collection<LanguageCode> languageOptions)

        Provides the language codes you specified in your request.

        Parameters:
        languageOptions - Provides the language codes you specified in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageOptions

        TranscriptionJob.Builder languageOptions​(LanguageCode... languageOptions)

        Provides the language codes you specified in your request.

        Parameters:
        languageOptions - Provides the language codes you specified in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • identifiedLanguageScore

        TranscriptionJob.Builder identifiedLanguageScore​(Float identifiedLanguageScore)

        The confidence score associated with the language identified in your media file.

        Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

        Parameters:
        identifiedLanguageScore - The confidence score associated with the language identified in your media file.

        Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCodes

        TranscriptionJob.Builder languageCodes​(Collection<LanguageCodeItem> languageCodes)

        The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

        Parameters:
        languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCodes

        TranscriptionJob.Builder languageCodes​(LanguageCodeItem... languageCodes)

        The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

        Parameters:
        languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCodes

        TranscriptionJob.Builder languageCodes​(Consumer<LanguageCodeItem.Builder>... languageCodes)

        The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

        This is a convenience method that creates an instance of the LanguageCodeItem.Builder avoiding the need to create one manually via LanguageCodeItem.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #languageCodes(List).

        Parameters:
        languageCodes - a consumer that will call methods on LanguageCodeItem.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #languageCodes(java.util.Collection)

      • tags

        TranscriptionJob.Builder tags​(Collection<Tag> tags)

        The tags, each in the form of a key:value pair, assigned to the specified transcription job.

        Parameters:
        tags - The tags, each in the form of a key:value pair, assigned to the specified transcription job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        TranscriptionJob.Builder tags​(Tag... tags)

        The tags, each in the form of a key:value pair, assigned to the specified transcription job.

        Parameters:
        tags - The tags, each in the form of a key:value pair, assigned to the specified transcription job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        TranscriptionJob.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags, each in the form of a key:value pair, assigned to the specified transcription job.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • subtitles

        TranscriptionJob.Builder subtitles​(SubtitlesOutput subtitles)

        Indicates whether subtitles were generated with your transcription.

        Parameters:
        subtitles - Indicates whether subtitles were generated with your transcription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageIdSettingsWithStrings

        TranscriptionJob.Builder languageIdSettingsWithStrings​(Map<String,​LanguageIdSettings> languageIdSettings)

        Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

        Parameters:
        languageIdSettings - Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageIdSettings

        TranscriptionJob.Builder languageIdSettings​(Map<LanguageCode,​LanguageIdSettings> languageIdSettings)

        Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

        Parameters:
        languageIdSettings - Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • toxicityDetection

        TranscriptionJob.Builder toxicityDetection​(Collection<ToxicityDetectionSettings> toxicityDetection)

        Provides information about the toxicity detection settings applied to your transcription.

        Parameters:
        toxicityDetection - Provides information about the toxicity detection settings applied to your transcription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • toxicityDetection

        TranscriptionJob.Builder toxicityDetection​(ToxicityDetectionSettings... toxicityDetection)

        Provides information about the toxicity detection settings applied to your transcription.

        Parameters:
        toxicityDetection - Provides information about the toxicity detection settings applied to your transcription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.