Package ai.rev.speechtotext.models.asynchronous

Class RevAiJob

  • public class RevAiJob
extends Object
    A RevAi Job object provides all the information associated with a job submitted by the user.

    • Constructor Detail

      • RevAiJob

        public RevAiJob()

    • Method Detail

      • getJobId

        public String getJobId()
        Returns a String that contains the job ID.
        Returns:
        A String that contains the job ID.

      • setJobId

        public void setJobId​(String jobId)
        Sets the Job ID.
        Parameters:
        jobId - The String value to set as the job ID.

      • setJobStatus

        public void setJobStatus​(RevAiJobStatus jobStatus)
        Sets the job status to the provided RevAiJobStatus enumeration value.
        Parameters:
        jobStatus - The enumeration value to set as the job status.
        See Also:
        RevAiJobStatus

      • getCreatedOn

        public String getCreatedOn()
        Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.
        Returns:
        A String that contains the date and time the job was created on in ISO-8601 UTC form.

      • setCreatedOn

        public void setCreatedOn​(String createdOn)
        Sets the time and date the job was created on.
        Parameters:
        createdOn - The String value to set as the created on date and time.

      • getCompletedOn

        public String getCompletedOn()
        Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.
        Returns:
        A String that contains the date and time the job was completed on in ISO-8601 UTC form.

      • setCompletedOn

        public void setCompletedOn​(String completedOn)
        Set the date and time the job was completed on.
        Parameters:
        completedOn - The String value to set as the date and time the job was completed on.

      • getCallbackUrl

        public String getCallbackUrl()
        Returns the callback url provided in the submission request.
        Returns:
        A String containing the callback url provided in the submission request.

      • setCallbackUrl

        public void setCallbackUrl​(String callbackUrl)
        Sets the callback url.
        Parameters:
        callbackUrl - A String value to set as the callback url.

      • getDurationSeconds

        public Double getDurationSeconds()
        Returns the audio duration of the file in seconds.
        Returns:
        The audio duration of the file in seconds.

      • setDurationSeconds

        public void setDurationSeconds​(Double durationSeconds)
        Sets the audio duration.
        Parameters:
        durationSeconds - A Double value to set as audio duration.

      • getMediaUrl

        public String getMediaUrl()
        Returns the media url provided in the submission request.
        Returns:
        A String containing the media url provided in the submission request.

      • setMediaUrl

        public void setMediaUrl​(String mediaUrl)
        Sets the media url.
        Parameters:
        mediaUrl - A String value to set as the media url.

      • getMetadata

        public String getMetadata()
        Returns the metadata provided in the submission request.
        Returns:
        A String containing the metadata provided in the submission request.

      • setMetadata

        public void setMetadata​(String metadata)
        Sets the metadata.
        Parameters:
        metadata - A String to set as the metadata.

      • getName

        public String getName()
        Returns the name of the file provided in the submission request.
        Returns:
        A String that contains the name of the file provided in the submission request.

      • setName

        public void setName​(String name)
        Sets the file name.
        Parameters:
        name - A String to set as the file name.

      • setType

        public void setType​(RevAiJobType type)
        Sets the job type to the provided RevAiJobType enumeration.
        Parameters:
        type - The enumeration value to set as the job type.
        See Also:
        RevAiJobType

      • getFailureDetails

        public String getFailureDetails()
        Returns a detailed, human readable explanation of the failure.
        Returns:
        A detailed, human readable explanation of the failure.

      • setFailureDetails

        public void setFailureDetails​(String failureDetails)
        Sets the failure details to the provided value.
        Parameters:
        failureDetails - A String to set as the failure details.

      • getDeleteAfterSeconds

        public Integer getDeleteAfterSeconds()
        Returns the duration in seconds before job is deleted
        Returns:
        The duration in seconds.

      • setDeleteAfterSeconds

        public void setDeleteAfterSeconds​(Integer deleteAfterSeconds)
        Sets the duration in seconds before job is deleted
        Parameters:
        deleteAfterSeconds - An Integer value to set as seconds before deletion.

      • getSkipDiarization

        public Boolean getSkipDiarization()
        Returns value of skip diarization for job
        Returns:
        Whether job is skipping diarization

      • setSkipDiarization

        public void setSkipDiarization​(Boolean skipDiarization)
        Sets skip diarization option for job
        Parameters:
        skipDiarization - An Boolean value to set for skipping diarization

      • getSkipPunctuation

        public Boolean getSkipPunctuation()
        Returns value of skip punctuation for job
        Returns:
        Whether job is skipping punctuation

      • setSkipPunctuation

        public void setSkipPunctuation​(Boolean skipPunctuation)
        Sets skip punctuation option for job
        Parameters:
        skipPunctuation - An Boolean value to set for skipping punctuation

      • getRemoveDisfluencies

        public Boolean getRemoveDisfluencies()
        Returns value of remove disfluencies for job
        Returns:
        Whether job is removing disfluencies

      • setRemoveDisfluencies

        public void setRemoveDisfluencies​(Boolean removeDisfluencies)
        Sets remove disfluencies option for job
        Parameters:
        removeDisfluencies - An Boolean value to set for remove disfluencies

      • getFilterProfanity

        public Boolean getFilterProfanity()
        Returns value of filter profanity for job
        Returns:
        Whether job is filtering profanity

      • setFilterProfanity

        public void setFilterProfanity​(Boolean filterProfanity)
        Sets filter profanity option for job
        Parameters:
        filterProfanity - An Boolean value to set for filter profanity

      • getCustomVocabularyId

        public String getCustomVocabularyId()
        Returns custom vocabulary id (if specified) associated to the job
        Returns:
        User-supplied custom vocabulary ID

      • setCustomVocabularyId

        public void setCustomVocabularyId​(String customVocabularyId)
        Sets the user-supplied custom vocabulary ID for job
        Parameters:
        customVocabularyId - An String value to set for custom vocabulary ID

      • getSpeakerChannelsCount

        public Integer getSpeakerChannelsCount()
        Returns number of speaker channels (if specified) for job
        Returns:
        Total number of unique speaker channels

      • setSpeakerChannelsCount

        public void setSpeakerChannelsCount​(Integer speakerChannelsCount)
        Sets speaker channels count for job
        Parameters:
        speakerChannelsCount - An Integer value to set for speaker channels count

      • getLanguage

        public String getLanguage()
        Returns language of the job
        Returns:
        language of the job

      • setLanguage

        public void setLanguage​(String language)
        Sets the language for job
        Parameters:
        language - An String value to set for language

      • getTranscriber

        public String getTranscriber()
        Returns transcriber used for the job
        Returns:
        transcriber used for the job

      • setTranscriber

        public void setTranscriber​(String transcriber)
        Sets the transcriber used for job
        Parameters:
        transcriber - An String value to set for transcriber

      • getVerbatim

        public Boolean getVerbatim()
        Returns value of verbatim for job transcribed by human
        Returns:
        Whether job transcribed by human is verbatim

      • setVerbatim

        public void setVerbatim​(Boolean verbatim)
        Sets verbatim for job transcribed by human
        Parameters:
        verbatim - An Boolean value to set for verbatim

      • getRush

        public Boolean getRush()
        Returns value of rush for job transcribed by human
        Returns:
        Whether job transcribed by human has rush

      • setRush

        public void setRush​(Boolean rush)
        Sets rush option for job transcribed by human
        Parameters:
        rush - An Boolean value to set for rush

      • getSegmentsToTranscribe

        public List<SegmentToTranscribe> getSegmentsToTranscribe()
        Returns segments to transcribe for job transcribed by human
        Returns:
        List of segments to be transcribed

      • setSegmentsToTranscribe

        public void setSegmentsToTranscribe​(List<SegmentToTranscribe> segmentsToTranscribe)
        Sets segments to be transcribed for job transcribed by human
        Parameters:
        segmentsToTranscribe - List of segments to be transcribed

      • getSummarization

        public Summarization getSummarization()
        Returns summarization options for the job
        Returns:
        Summarization options for the job

      • setSummarization

        public void setSummarization​(Summarization summarization)
        Sets summarization options for the job

      • getTranslation

        public Translation getTranslation()
        Returns translation options for the job
        Returns:
        Translation options for the job

      • setTranslation

        public void setTranslation​(Translation translation)
        Sets translation options for the job