Package ai.rev.speechtotext.models.asynchronous

Class RevAiJobOptions

    • Constructor Detail

      • RevAiJobOptions

        public RevAiJobOptions()

    • Method Detail

      • getMediaUrl

        public String getMediaUrl()
        Returns the media url.
        Returns:
        The media url.

      • setMediaUrl

        public void setMediaUrl​(String mediaUrl)
        Specifies the url where the media can be downloaded.
        Parameters:
        mediaUrl - The direct download url to the file.

      • getCallbackUrl

        public String getCallbackUrl()
        Returns the callback url.
        Returns:
        the callback url.

      • setCallbackUrl

        public void setCallbackUrl​(String callbackUrl)
        Specifies the callback url that Rev.ai will POST to when job processing is complete. This property is optional.
        Parameters:
        callbackUrl - The url to POST to when job processing is complete.

      • getSkipDiarization

        public Boolean getSkipDiarization()
        Returns the value of the skip diarization Boolean.
        Returns:
        The skip diarization value.

      • setSkipDiarization

        public void setSkipDiarization​(Boolean skipDiarization)
        Specifies if speaker diarization will be skipped by the speech engine. This property is optional and defaults to false.
        Parameters:
        skipDiarization - The value of the Boolean.

      • getSkipPunctuation

        public Boolean getSkipPunctuation()
        Returns the value of the skip punctuation Boolean.
        Returns:
        The skip punctuation value.

      • setSkipPunctuation

        public void setSkipPunctuation​(Boolean skipPunctuation)
        Specifies if the "punct" elements will be skipped by the speech engine. This property is optional and defaults to false.
        Parameters:
        skipPunctuation - The value of the Boolean.

      • getSpeakerChannelsCount

        public Integer getSpeakerChannelsCount()
        Returns the speaker channel count.
        Returns:
        The speaker channel count.

      • setSpeakerChannelsCount

        public void setSpeakerChannelsCount​(Integer speakerChannelsCount)
        Specifies the number of speaker channels in the audio. Each speaker channel is processed separately. When set the account will be charged the file * duration multiplied by the number of specified channels. This property is optional and defaults to null.
        Parameters:
        speakerChannelsCount - The number of separate speaker channels in the audio.

      • setCustomVocabularies

        public void setCustomVocabularies​(List<CustomVocabulary> customVocabularies)
        Provides the custom vocabularies to be used by the speech engine when processing the transcript. List size is limited to 50 items. Providing custom vocabularies is optional.
        Parameters:
        customVocabularies - A list of custom vocabularies.
        See Also:
        CustomVocabulary

      • getMetadata

        public String getMetadata()
        Returns the metadata.
        Returns:
        A String that contains the metadata.

      • setMetadata

        public void setMetadata​(String metadata)
        Optional metadata that is provided during job submission limited to 512 characters.
        Parameters:
        metadata - A String to set as the metadata.

      • getFilterProfanity

        public Boolean getFilterProfanity()
        Returns the value of the filterProfanity Boolean
        Returns:
        The filter profanity value.

      • setFilterProfanity

        public void setFilterProfanity​(Boolean filterProfanity)
        Specifies whether or not the speech engine should filter profanity in the output. Setting the profanity filter is optional.
        Parameters:
        filterProfanity - The option to filter profanity.

      • getRemoveDisfluencies

        public Boolean getRemoveDisfluencies()
        Returns the value of the removeDisfluencies Boolean
        Returns:
        The removeDisfluencies value.

      • setRemoveDisfluencies

        public void setRemoveDisfluencies​(Boolean removeDisfluencies)
        Specifies whether or not the speech engine should remove disfluencies in the output. Setting the option to remove disfluencies is optional.
        Parameters:
        removeDisfluencies - The option to remove disfluencies.

      • getDeleteAfterSeconds

        public Integer getDeleteAfterSeconds()
        Returns the value of deleteAfterSeconds.
        Returns:
        The deleteAfterSeconds value.

      • setDeleteAfterSeconds

        public void setDeleteAfterSeconds​(Integer deleteAfterSeconds)
        Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
        Parameters:
        deleteAfterSeconds - The number of seconds after job completion when job is auto-deleted.

      • getLanguage

        public String getLanguage()
        Returns the value of language.
        Returns:
        the language value.

      • setLanguage

        public void setLanguage​(String language)
        Specifies language for ASR system using ISO 639-1 2-letter language code.
        Parameters:
        language - ISO 639-1 2-letter language code of desired ASR language.