A B C D E F G H I M N O P R S T V 
All Classes All Packages

A

ai.rev.exceptions - package ai.rev.exceptions
 
ai.rev.helpers - package ai.rev.helpers
 
ai.rev.sentimentanalysis - package ai.rev.sentimentanalysis
 
ai.rev.sentimentanalysis.models - package ai.rev.sentimentanalysis.models
 
ai.rev.speechtotext - package ai.rev.speechtotext
 
ai.rev.speechtotext.models - package ai.rev.speechtotext.models
 
ai.rev.speechtotext.models.asynchronous - package ai.rev.speechtotext.models.asynchronous
 
ai.rev.speechtotext.models.streaming - package ai.rev.speechtotext.models.streaming
 
ai.rev.speechtotext.models.vocabulary - package ai.rev.speechtotext.models.vocabulary
 
ai.rev.topicextraction - package ai.rev.topicextraction
 
ai.rev.topicextraction.models - package ai.rev.topicextraction.models
 
ApiClient - Class in ai.rev.speechtotext
The ApiClient object provides methods to send and retrieve information from all the Rev AI API endpoints using the Retrofit HTTP client.
ApiClient(String) - Constructor for class ai.rev.speechtotext.ApiClient
Constructs the API client used to send HTTP requests to Rev AI.
ApiInterceptor - Class in ai.rev.helpers
An ApiInterceptor object appends authorization information to all API calls and is used to check the status of the request for debugging purposes.
ApiInterceptor(String, String) - Constructor for class ai.rev.helpers.ApiInterceptor
 
apiInterface - Variable in class ai.rev.sentimentanalysis.SentimentAnalysisClient
Interface that SentimentAnalysisClient methods use to make requests
apiInterface - Variable in class ai.rev.speechtotext.ApiClient
Interface that ApiClient methods use to make requests
apiInterface - Variable in class ai.rev.topicextraction.TopicExtractionClient
Interface that TopicExtractionClient methods use to make requests
ApiInterface - Interface in ai.rev.speechtotext
The ApiInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev AI async API.
ASYNC - ai.rev.speechtotext.models.asynchronous.RevAiJobType
The type used for asynchronous jobs.
AuthorizationException - Exception in ai.rev.exceptions
The AuthorizationException happens when an invalid token access is used to query any endpoint.
AuthorizationException(JSONObject) - Constructor for exception ai.rev.exceptions.AuthorizationException
 

B

buildContentString() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the content string compiled from the StreamContentType properties to be used in the query parameter for the request to the /stream endpoint.

C

ClientHelper - Class in ai.rev.helpers
 
ClientHelper() - Constructor for class ai.rev.helpers.ClientHelper
 
close() - Method in class ai.rev.speechtotext.StreamingClient
Will close the WebSocket connection by informing the server that it's the End of Stream
closeConnection() - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
Manually closes the connection when the code is running in a JVM
closeConnection() - Method in class ai.rev.speechtotext.ApiClient
Manually closes the connection when the code is running in a JVM
closeConnection() - Method in class ai.rev.topicextraction.TopicExtractionClient
Manually closes the connection when the code is running in a JVM
COMPLETE - ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
The status when custom vocabulary has been processed and completed.
COMPLETED - ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
The status when job processing has been completed.
COMPLETED - ai.rev.topicextraction.models.TopicExtractionJobStatus
The status when job processing has been completed.
connect(RevAiWebSocketListener, StreamContentType) - Method in class ai.rev.speechtotext.StreamingClient
Overload of StreamingClient.connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) without the optional metadata and sessionConfig.
connect(RevAiWebSocketListener, StreamContentType, SessionConfig) - Method in class ai.rev.speechtotext.StreamingClient
connect(RevAiWebSocketListener, StreamContentType, String) - Method in class ai.rev.speechtotext.StreamingClient
connect(RevAiWebSocketListener, StreamContentType, String, SessionConfig) - Method in class ai.rev.speechtotext.StreamingClient
Sends an HTTP request and upon authorization is upgraded to a WebSocket connection.
CONNECTED - ai.rev.speechtotext.models.streaming.MessageType
The type of message sent when the WebSocket connects.
ConnectedMessage - Class in ai.rev.speechtotext.models.streaming
Represents the connected message sent from Rev AI and contains the id of the stream
ConnectedMessage() - Constructor for class ai.rev.speechtotext.models.streaming.ConnectedMessage
 
create(InputStream, MediaType) - Static method in class ai.rev.speechtotext.FileStreamRequestBody
 
createOkHttpClient(String) - Static method in class ai.rev.helpers.ClientHelper
 
createRetrofitInstance(OkHttpClient, String, String) - Static method in class ai.rev.helpers.ClientHelper
 
CustomerUrlData - Class in ai.rev.speechtotext.models
 
CustomerUrlData(String, Map<String, String>) - Constructor for class ai.rev.speechtotext.models.CustomerUrlData
 
CustomVocabulariesClient - Class in ai.rev.speechtotext
The CustomVocabularyClient object provides methods to interact with the Custom Vocabulary Api.
CustomVocabulariesClient(String) - Constructor for class ai.rev.speechtotext.CustomVocabulariesClient
Constructs the custom vocabulary client used to create custom vocabularies for streaming.
CustomVocabulary - Class in ai.rev.speechtotext.models.vocabulary
A CustomVocabulary object provides all the custom phrases that are submitted along with a job.
CustomVocabulary(List<String>) - Constructor for class ai.rev.speechtotext.models.vocabulary.CustomVocabulary
Creates a new custom vocabulary with a list of phrases limited to alphabetic characters and spaces.
customVocabularyApiInterface - Variable in class ai.rev.speechtotext.CustomVocabulariesClient
Interface that CustomVocabularyClient methods use to make requests
CustomVocabularyApiInterface - Interface in ai.rev.speechtotext
The CustomVocabularyApiInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev AI custom vocabulary API.
CustomVocabularyFailureType - Enum in ai.rev.speechtotext.models.vocabulary
 
CustomVocabularyInformation - Class in ai.rev.speechtotext.models.vocabulary
 
CustomVocabularyInformation() - Constructor for class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
 
CustomVocabularyStatus - Enum in ai.rev.speechtotext.models.vocabulary
 
CustomVocabularySubmission - Class in ai.rev.speechtotext.models.vocabulary
 
CustomVocabularySubmission() - Constructor for class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
 

D

deleteCustomVocabulary(String) - Method in class ai.rev.speechtotext.CustomVocabulariesClient
This method sends a DELETE request to the /vocabularies/{id} endpoint.
deleteCustomVocabulary(String) - Method in interface ai.rev.speechtotext.CustomVocabularyApiInterface
 
deleteJob(String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
This method sends a DELETE request to the /jobs/{id} endpoint.
deleteJob(String) - Method in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
deleteJob(String) - Method in class ai.rev.speechtotext.ApiClient
This method sends a DELETE request to the /jobs/{id} endpoint.
deleteJob(String) - Method in interface ai.rev.speechtotext.ApiInterface
 
deleteJob(String) - Method in class ai.rev.topicextraction.TopicExtractionClient
This method sends a DELETE request to the /jobs/{id} endpoint.
deleteJob(String) - Method in interface ai.rev.topicextraction.TopicExtractionInterface
 
DOWNLOAD_FAILURE - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when the media provided in the submission request fails to download.

E

Element - Class in ai.rev.speechtotext.models.asynchronous
An Element object presents all the information the models inferred from a single interval of audio.
Element() - Constructor for class ai.rev.speechtotext.models.asynchronous.Element
 
EMPTY_MEDIA - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when the media provided doesn't contain any audio.
ErrorInterceptor - Class in ai.rev.helpers
The ErrorInterceptor class is used to intercept all responses with erroneous response codes.
ErrorInterceptor() - Constructor for class ai.rev.helpers.ErrorInterceptor
 

F

FAILED - ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
The status when job has failed.
FAILED - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
The status when transcription has failed.
FAILED - ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
The status when the custom vocabulary job has failed.
FAILED - ai.rev.topicextraction.models.TopicExtractionJobStatus
The status when job has failed.
FileStreamRequestBody - Class in ai.rev.speechtotext
Customized request body used for submitting local file jobs.
FileStreamRequestBody() - Constructor for class ai.rev.speechtotext.FileStreamRequestBody
 
FINAL - ai.rev.speechtotext.models.streaming.MessageType
The type of message sent when the WebSocket returns a final hypotheses.
ForbiddenStateException - Exception in ai.rev.exceptions
The ForbiddenStateException occurs when a user attempts to retrieve the result of an unprocessed job.
ForbiddenStateException(JSONObject) - Constructor for exception ai.rev.exceptions.ForbiddenStateException
 

G

getAccount() - Method in class ai.rev.speechtotext.ApiClient
This method sends a GET request to the /account endpoint and returns an RevAiAccount object.
getAccount() - Method in interface ai.rev.speechtotext.ApiInterface
 
getAuthHeaders() - Method in class ai.rev.speechtotext.models.CustomerUrlData
 
getBalanceSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount
Returns the remaining number of credits in seconds that can be used on the account.
getCallbackUrl() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the callback url provided in the submission request.
getCallbackUrl() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Deprecated.
Use notificationConfig and getNotificationConfig instead
getCallbackUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the callback url provided in the submission request.
getCallbackUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Deprecated.
Use notificationConfig and getNotificationConfig instead
getCallbackUrl() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns the callback url provided in the submission request.
getCallbackUrl() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Deprecated.
Set the notificationConfig option with setNotificationConfig, then use getNotificationConfig instead
getCallbackUrl() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the callback url provided in the submission request.
getCallbackUrl() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Deprecated.
Use notificationConfig and getNotificationConfig instead
getCaptions(String) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional caption type and channel ID.
getCaptions(String, RevAiCaptionType) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional channel ID.
getCaptions(String, RevAiCaptionType, Integer) - Method in class ai.rev.speechtotext.ApiClient
The method sends a GET request to the /jobs/{id}/captions endpoint and returns captions for the provided job ID in the form of an InputStream.
getCaptions(String, Integer) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.getCaptions(String, RevAiCaptionType, Integer) without the optional caption type.
getCaptionText(String, Map<String, String>, Map<String, String>) - Method in interface ai.rev.speechtotext.ApiInterface
 
getChannels() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the number of channels.
getCompletedOn() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.
getCompletedOn() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.
getCompletedOn() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns a String that contains the date and time the custom vocabulary was completed on in ISO-8601 UTC form.
getCompletedOn() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.
getConfidence() - Method in class ai.rev.speechtotext.models.asynchronous.Element
Returns the confidence score of the value provided in this transcript element.
getContent() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the content of the informant.
getContent() - Method in class ai.rev.topicextraction.models.Informant
Returns the content of the informant
getContentType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
Returns the String value of the enumeration.
getContentType() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the content type.
getCreatedOn() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.
getCreatedOn() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.
getCreatedOn() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns a String that contains the date and time the custom vocabulary was created on in ISO-8601 UTC form.
getCreatedOn() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.
getCustomVocabularies() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns a list of CustomVocabulary objects.
getCustomVocabularies() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Returns a list of CustomVocabulary objects.
getCustomVocabularyId() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns custom vocabulary id (if specified) associated to the job
getCustomVocabularyId() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the custom vocabulary ID.
getCustomVocabularyId() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the custom vocabulary ID.
getCustomVocabularyInformation(String) - Method in class ai.rev.speechtotext.CustomVocabulariesClient
This method sends a GET request to the /vocabularies/{id} endpoint and returns a CustomVocabularyInformation object.
getCustomVocabularyInformation(String) - Method in interface ai.rev.speechtotext.CustomVocabularyApiInterface
 
getDeleteAfterSeconds() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the duration in seconds before job is deleted
getDeleteAfterSeconds() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Returns the value of deleteAfterSeconds.
getDeleteAfterSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the duration in seconds before job is deleted
getDeleteAfterSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of deleteAfterSeconds.
getDeleteAfterSeconds() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of deleteAfterSeconds.
getDeleteAfterSeconds() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the duration in seconds before job is deleted
getDeleteAfterSeconds() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Returns the value of deleteAfterSeconds.
getDetailedPartials() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of detailed partials option
getDurationSeconds() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the audio duration of the file in seconds.
getElements() - Method in class ai.rev.speechtotext.models.asynchronous.Monologue
Returns a list of Element objects.
getElements() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Returns a list of Element objects.
getEmail() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount
Returns a String containing the account email.
getEndTimestamp() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the end timestamp of the content in the input.
getEndTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.Element
Returns the end timestamp for this audio interval.
getEndTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.SegmentToTranscribe
Returns the end timestamp for the segment to transcribe.
getEndTimestamp() - Method in class ai.rev.topicextraction.models.Informant
Returns the end timestamp of the content in the input
getEndTs() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Returns the ending timestamp of a transcribed audio sample.
getFailure() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the RevAiFailureType enumeration value.
getFailure() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the RevAiFailureType enumeration value.
getFailure() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns the CustomVocabularyFailureType enumeration value.
getFailure() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the RevAiFailureType enumeration value.
getFailureDetail() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns a detailed, human readable explanation of the failure.
getFailureDetails() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns a detailed, human readable explanation of the failure.
getFailureDetails() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns a detailed, human readable explanation of the failure.
getFailureDetails() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns a detailed, human readable explanation of the failure.
getFailureType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType
Returns the String value of the enumeration.
getFailureType() - Method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyFailureType
Returns the String value of the enumeration.
getFilterProfanity() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of filter profanity for job
getFilterProfanity() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of the filterProfanity Boolean
getFilterProfanity() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of the filter profanity option.
getFormat() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the format of the audio samples.
getId() - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
 
getId() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns a String that contains the Custom Vocabulary Id.
getInformants() - Method in class ai.rev.topicextraction.models.Topic
Returns the informants.
getJobDetails(String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
This method sends a GET request to the /jobs/{id} endpoint and returns a SentimentAnalysisJob object.
getJobDetails(String) - Method in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
getJobDetails(String) - Method in class ai.rev.speechtotext.ApiClient
This method sends a GET request to the /jobs/{id} endpoint and returns a RevAiJob object.
getJobDetails(String) - Method in interface ai.rev.speechtotext.ApiInterface
 
getJobDetails(String) - Method in class ai.rev.topicextraction.TopicExtractionClient
This method sends a GET request to the /jobs/{id} endpoint and returns a TopicExtractionJob object.
getJobDetails(String) - Method in interface ai.rev.topicextraction.TopicExtractionInterface
 
getJobId() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns a String that contains the job ID.
getJobId() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns a String that contains the job ID.
getJobId() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns a String that contains the job ID.
getJobStatus() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the SentimentAnalysisJobStatus enumeration value.
getJobStatus() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the RevAiJobStatus enumeration value.
getJobStatus() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the TopicExtractionJobStatus enumeration value.
getJobType() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType
Returns the String value of the enumeration.
getJson() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Returns the json.
getJson() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Returns the json.
getLanguage() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns language of the job
getLanguage() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns language of the job
getLanguage() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of language.
getLanguage() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of language.
getLanguage() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns language of the job
getLayout() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the channel layout.
getLength() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the character length of the content
getLength() - Method in class ai.rev.topicextraction.models.Informant
Returns the character length of the content
getListOfCustomVocabularyInformation() - Method in class ai.rev.speechtotext.CustomVocabulariesClient
This method sends a GET request to the /vocabularies endpoint and returns a list of CustomVocabularyInformation objects.
getListOfCustomVocabularyInformation() - Method in interface ai.rev.speechtotext.CustomVocabularyApiInterface
 
getListOfJobs() - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
Overload of SentimentAnalysisClient.getListOfJobs(Integer, String) without the optional limit and startingAfter parameter.
getListOfJobs() - Method in class ai.rev.speechtotext.ApiClient
Overload of ApiClient.getListOfJobs(Integer, String) without the optional limit and startingAfter parameter.
getListOfJobs() - Method in class ai.rev.topicextraction.TopicExtractionClient
Overload of TopicExtractionClient.getListOfJobs(Integer, String) without the optional limit and startingAfter parameter.
getListOfJobs(Integer) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
Overload of SentimentAnalysisClient.getListOfJobs(Integer, String) without the optional startingAfter parameter.
getListOfJobs(Integer) - Method in class ai.rev.speechtotext.ApiClient
Overload of ApiClient.getListOfJobs(Integer, String) without the optional startingAfter parameter.
getListOfJobs(Integer) - Method in class ai.rev.topicextraction.TopicExtractionClient
Overload of TopicExtractionClient.getListOfJobs(Integer, String) without the optional startingAfter parameter.
getListOfJobs(Integer, String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
This method sends a GET request to the /jobs endpoint and returns a list of SentimentAnalysisJob objects.
getListOfJobs(Integer, String) - Method in class ai.rev.speechtotext.ApiClient
This method sends a GET request to the /jobs endpoint and returns a list of RevAiJob objects.
getListOfJobs(Integer, String) - Method in class ai.rev.topicextraction.TopicExtractionClient
This method sends a GET request to the /jobs endpoint and returns a list of TopicExtractionJob objects.
getListOfJobs(String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
Overload of SentimentAnalysisClient.getListOfJobs(Integer, String) without the optional limit parameter.
getListOfJobs(String) - Method in class ai.rev.speechtotext.ApiClient
Overload of ApiClient.getListOfJobs(Integer, String) without the optional limit parameter.
getListOfJobs(String) - Method in class ai.rev.topicextraction.TopicExtractionClient
Overload of TopicExtractionClient.getListOfJobs(Integer, String) without the optional limit parameter.
getListOfJobs(Map<String, String>) - Method in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
getListOfJobs(Map<String, String>) - Method in interface ai.rev.speechtotext.ApiInterface
 
getListOfJobs(Map<String, String>) - Method in interface ai.rev.topicextraction.TopicExtractionInterface
 
getMediaType() - Method in class ai.rev.helpers.MockInterceptor
 
getMediaUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the media url provided in the submission request.
getMediaUrl() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Deprecated.
Set sourceConfig and use getSourceConfig instead
getMessages() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisResult
Get the messages of the result.
getMessageType() - Method in enum ai.rev.speechtotext.models.streaming.MessageType
Returns the String value of the enumeration.
getMetadata() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the metadata provided in the submission request.
getMetadata() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Returns the metadata.
getMetadata() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the metadata provided in the submission request.
getMetadata() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the metadata.
getMetadata() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns the metadata provided in the submission request.
getMetadata() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Returns the metadata.
getMetadata() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the metadata provided in the submission request.
getMetadata() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Returns the metadata.
getMetaData() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the metadata.
getMonologues() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiTranscript
Returns a list on Monologue objects.
getName() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the name of the file provided in the submission request.
getNotificationConfig() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Returns the notification config object.
getNotificationConfig() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the notification config object.
getNotificationConfig() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Returns the notification config.
getNotificationConfig() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Returns the notification config object.
getOffset() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the character index at which the content started in the input.
getOffset() - Method in class ai.rev.topicextraction.models.Informant
Returns the character index at which the content started in the input
getPhrases() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabulary
Returns a list of phrases
getRate() - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Returns the audio sample rate.
getRemoveDisfluencies() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of remove disfluencies for job
getRemoveDisfluencies() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of the removeDisfluencies Boolean
getRemoveDisfluencies() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of the remove disfluencies option.
getRequest() - Method in class ai.rev.helpers.MockInterceptor
 
getResponseCode() - Method in class ai.rev.helpers.MockInterceptor
 
getResultObject(String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
The method sends a GET request to the /jobs/{id}/result endpoint and returns a SentimentAnalysisResult object.
getResultObject(String) - Method in class ai.rev.topicextraction.TopicExtractionClient
The method sends a GET request to the /jobs/{id}/result endpoint and returns a TopicExtractionResult object.
getResultObject(String, Sentiment) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
The method sends a GET request to the /jobs/{id}/result endpoint and returns a SentimentAnalysisResult object.
getResultObject(String, Double) - Method in class ai.rev.topicextraction.TopicExtractionClient
The method sends a GET request to the /jobs/{id}/result endpoint and returns a TopicExtractionResult object.
getResultObject(String, Map<String, Object>) - Method in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
getResultObject(String, Map<String, Object>) - Method in interface ai.rev.topicextraction.TopicExtractionInterface
 
getRush() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of rush for job transcribed by human
getRush() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of rush
getSampleResponse() - Method in class ai.rev.helpers.MockInterceptor
 
getScore() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the score of the content.
getScore() - Method in class ai.rev.topicextraction.models.Topic
Returns the score.
getSdkVersion() - Static method in class ai.rev.helpers.SDKHelper
Helper function that reads the current sdk version from pom.xml.
getSegmentsToTranscribe() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns segments to transcribe for job transcribed by human
getSegmentsToTranscribe() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the segments in media to transcribe
getSentiment() - Method in enum ai.rev.sentimentanalysis.models.Sentiment
Returns the String value of the enumeration.
getSentiment() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the Sentiment of the informant.
getSkipDiarization() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of skip diarization for job
getSkipDiarization() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of the skip diarization Boolean.
getSkipPunctuation() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of skip punctuation for job
getSkipPunctuation() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of the skip punctuation Boolean.
getSourceConfig() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the source config object.
getSpeaker() - Method in class ai.rev.speechtotext.models.asynchronous.Monologue
Returns the speaker number for this monologue.
getSpeakerChannelsCount() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns number of speaker channels (if specified) for job
getSpeakerChannelsCount() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the speaker channel count.
getStartTimestamp() - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Returns the start timestamp of the content in the input.
getStartTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.Element
Returns the starting timestamp of this audio interval.
getStartTimestamp() - Method in class ai.rev.speechtotext.models.asynchronous.SegmentToTranscribe
Returns the starting timestamp of the segment to transcribe.
getStartTimestamp() - Method in class ai.rev.topicextraction.models.Informant
Returns the start timestamp of the content in the input
getStartTs() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of startTs.
getStatus() - Method in enum ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
Returns the String value of the enumeration.
getStatus() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
Returns the String value of the enumeration.
getStatus() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Returns the CustomVocabularyStatus enumeration value.
getStatus() - Method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
Returns the String value of the enumeration.
getStatus() - Method in enum ai.rev.topicextraction.models.TopicExtractionJobStatus
Returns the String value of the enumeration.
getTestMode() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of testMode
getText() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Returns the text.
getText() - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Returns the text.
getTopicName() - Method in class ai.rev.topicextraction.models.Topic
Returns the topic name.
getTopics() - Method in class ai.rev.topicextraction.models.TopicExtractionResult
Get the topics of the result.
getTranscriber() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns transcriber used for the job
getTranscriber() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the type of transcriber to use to transcribe the media file
getTranscriber() - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Returns the value of transcriber.
getTranscriptObject(String) - Method in class ai.rev.speechtotext.ApiClient
The method sends a GET request to the /jobs/{id}/transcript endpoint and returns a RevAiTranscript object.
getTranscriptObject(String) - Method in interface ai.rev.speechtotext.ApiInterface
 
getTranscriptText(String) - Method in class ai.rev.speechtotext.ApiClient
The method sends a GET request to the /jobs/{id}/transcript endpoint and returns the transcript as a String.
getTranscriptText(String) - Method in interface ai.rev.speechtotext.ApiInterface
 
getTs() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Returns the starting timestamp of a transcribed audio sample.
getType() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the RevAiJobType enumeration value.
getType() - Method in class ai.rev.speechtotext.models.asynchronous.Element
Returns the type of transcript element contained within this audio interval.
getType() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns the RevAiJobType enumeration value.
getType() - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
Returns the MessageType enumeration value.
getType() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the RevAiJobType enumeration value.
getUrl() - Method in class ai.rev.speechtotext.models.CustomerUrlData
 
getValue() - Method in class ai.rev.speechtotext.models.asynchronous.Element
Returns the value of the transcript element.
getVerbatim() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Returns value of verbatim for job transcribed by human
getVerbatim() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Returns the value of verbatim
getWordCount() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Returns the word count of the submission.
getWordCount() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Returns the word count of the submission.

H

Hypothesis - Class in ai.rev.speechtotext.models.streaming
Represents the message returned over WebSocket containing the transcription of audio data.
Hypothesis() - Constructor for class ai.rev.speechtotext.models.streaming.Hypothesis
 

I

IN_PROGRESS - ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
The status when job is in progress.
IN_PROGRESS - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
The status when transcription of the file is in progress.
IN_PROGRESS - ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
The status when the custom vocabulary job is in progress.
IN_PROGRESS - ai.rev.topicextraction.models.TopicExtractionJobStatus
The status when job is in progress.
Informant - Class in ai.rev.topicextraction.models
Represents a piece of the input which informed a choice of a topic.
Informant() - Constructor for class ai.rev.topicextraction.models.Informant
 
INSUFFICIENT_BALANCE - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when the account does not have enough credits remaining.
intercept(Interceptor.Chain) - Method in class ai.rev.helpers.ApiInterceptor
 
intercept(Interceptor.Chain) - Method in class ai.rev.helpers.ErrorInterceptor
 
intercept(Interceptor.Chain) - Method in class ai.rev.helpers.MockInterceptor
 
INTERNAL_PROCESSING - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when there is a processing error.
INTERNAL_PROCESSING - ai.rev.speechtotext.models.vocabulary.CustomVocabularyFailureType
The failure used when there is a processing error.
INVALID_MEDIA - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when the file submitted is not a valid or supported media file.
InvalidHeaderException - Exception in ai.rev.exceptions
The InvalidHeaderException occurs when a header that's passed along a query is not recognized by the API.
InvalidHeaderException(JSONObject) - Constructor for exception ai.rev.exceptions.InvalidHeaderException
 
InvalidParameterException - Exception in ai.rev.exceptions
The InvalidParameterException occurs when a parameter that's passed along a query is not recognized by the API.
InvalidParameterException(JSONObject) - Constructor for exception ai.rev.exceptions.InvalidParameterException
 
INVOICING_LIMIT_EXCEEDED - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when the account has reached or exceeded its invoicing limit.

M

MessageType - Enum in ai.rev.speechtotext.models.streaming
Specifies constants that define the WebSocket message type.
MockInterceptor - Class in ai.rev.helpers
A MockInterceptor object is used to mock the responses for testing purposes.
MockInterceptor(MediaType, Integer) - Constructor for class ai.rev.helpers.MockInterceptor
 
Monologue - Class in ai.rev.speechtotext.models.asynchronous
A Monologue object presents information about a segment of a transcript owned by an individual speaker.
Monologue() - Constructor for class ai.rev.speechtotext.models.asynchronous.Monologue
 

N

NEGATIVE - ai.rev.sentimentanalysis.models.Sentiment
Negative sentiment.
NEUTRAL - ai.rev.sentimentanalysis.models.Sentiment
Neutral sentiment.

O

onClose(int, String) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener
Supplies the close code and close reason received during a WebSocket CloseEvent.
onConnected(ConnectedMessage) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener
Supplies the connection message received from Rev AI.
onError(Throwable, Response) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener
Supplies the error and response received during a WebSocket ErrorEvent.
onHypothesis(Hypothesis) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener
Supplies the Hypothesis returned from Rev AI.
onOpen(Response) - Method in interface ai.rev.speechtotext.RevAiWebSocketListener
Supplies the response received during the handshake.

P

PARTIAL - ai.rev.speechtotext.models.streaming.MessageType
The type of message sent when the WebSocket returns a partial hypotheses.
POSITIVE - ai.rev.sentimentanalysis.models.Sentiment
Positive sentiment.

R

request - Variable in class ai.rev.helpers.MockInterceptor
 
ResourceNotFoundException - Exception in ai.rev.exceptions
The ResourceNotFoundException occurs when a job ID queried cannot be found.
ResourceNotFoundException(JSONObject) - Constructor for exception ai.rev.exceptions.ResourceNotFoundException
 
REV_JSON_CONTENT_TYPE - Static variable in interface ai.rev.speechtotext.ApiInterface
 
REV_SENTIMENT_CONTENT_TYPE - Static variable in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
REV_TEXT_CONTENT_TYPE - Static variable in interface ai.rev.speechtotext.ApiInterface
 
REV_TOPIC_CONTENT_TYPE - Static variable in interface ai.rev.topicextraction.TopicExtractionInterface
 
RevAiAccount - Class in ai.rev.speechtotext.models.asynchronous
The RevAiAccount object provides basic information about a Rev AI account associated with a valid access token.
RevAiAccount() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiAccount
 
RevAiApiException - Exception in ai.rev.exceptions
The RevAiApiException wraps standard Java IOException and enriches them with custom information.
RevAiApiException(String, JSONObject, int) - Constructor for exception ai.rev.exceptions.RevAiApiException
 
RevAiCaptionType - Enum in ai.rev.speechtotext.models.asynchronous
Specifies constants that define support caption formats.
RevAiFailureType - Enum in ai.rev.speechtotext.models.asynchronous
Specifies constants that define Rev AI failure types.
RevAiJob - Class in ai.rev.speechtotext.models.asynchronous
A RevAi Job object provides all the information associated with a job submitted by the user.
RevAiJob() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiJob
 
RevAiJobOptions - Class in ai.rev.speechtotext.models.asynchronous
A RevAiJobOptions object represents parameters that are submitted along a new job.
RevAiJobOptions() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
 
RevAiJobStatus - Enum in ai.rev.speechtotext.models.asynchronous
Specifies constants that define Rev AI job statuses.
RevAiJobType - Enum in ai.rev.speechtotext.models.asynchronous
Specifies constants that define Rev AI job types.
RevAiTranscript - Class in ai.rev.speechtotext.models.asynchronous
A RevAiTranscript object presents a list of monologues as the transcript of a specific job.
RevAiTranscript() - Constructor for class ai.rev.speechtotext.models.asynchronous.RevAiTranscript
 
RevAiWebSocketListener - Interface in ai.rev.speechtotext
Listens for events over the WebSocket connection to Rev AI

S

SDKHelper - Class in ai.rev.helpers
A helper class that provides methods for getting SDK information.
SDKHelper() - Constructor for class ai.rev.helpers.SDKHelper
 
SegmentToTranscribe - Class in ai.rev.speechtotext.models.asynchronous
A Segment object represents a segment of transcript that needs to be transcribed.
SegmentToTranscribe() - Constructor for class ai.rev.speechtotext.models.asynchronous.SegmentToTranscribe
 
sendAudioData(ByteString) - Method in class ai.rev.speechtotext.StreamingClient
Sends data over WebSocket in the form of a ByteString
Sentiment - Enum in ai.rev.sentimentanalysis.models
Specifies constants that define possible sentiments from our API.
SENTIMENTANALYSIS - ai.rev.speechtotext.models.asynchronous.RevAiJobType
The Type used for sentiment analysis jobs.
SentimentAnalysisClient - Class in ai.rev.sentimentanalysis
The SentimentAnalysisClient object provides methods to send and retrieve information from all the Rev AI Sentiment Analysis API endpoints using the Retrofit HTTP client.
SentimentAnalysisClient(String) - Constructor for class ai.rev.sentimentanalysis.SentimentAnalysisClient
Constructs the API client used to send HTTP requests to Rev AI.
SentimentAnalysisInterface - Interface in ai.rev.sentimentanalysis
The SentimentAnalysisInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev AI Sentiment Analysis API.
SentimentAnalysisJob - Class in ai.rev.sentimentanalysis.models
A Sentiment Analysis Job object provides all the information associated with a job submitted by the user.
SentimentAnalysisJob() - Constructor for class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
 
SentimentAnalysisJobOptions - Class in ai.rev.sentimentanalysis.models
A SentimentAnalysisJobOptions object represents parameters that are submitted along a new job.
SentimentAnalysisJobOptions() - Constructor for class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
 
SentimentAnalysisJobStatus - Enum in ai.rev.sentimentanalysis.models
Specifies constants that define Rev AI job statuses.
SentimentAnalysisResult - Class in ai.rev.sentimentanalysis.models
A Sentiment Analysis Result object provides all the information associated with the result of a job.
SentimentAnalysisResult() - Constructor for class ai.rev.sentimentanalysis.models.SentimentAnalysisResult
 
SentimentMessage - Class in ai.rev.sentimentanalysis.models
Represents a piece of the input which sentiment has been detected for.
SentimentMessage() - Constructor for class ai.rev.sentimentanalysis.models.SentimentMessage
 
SessionConfig - Class in ai.rev.speechtotext.models.streaming
The SessionConfig represents additional streaming options that can be provided.
SessionConfig() - Constructor for class ai.rev.speechtotext.models.streaming.SessionConfig
 
setAuthHeaders(Map<String, String>) - Method in class ai.rev.speechtotext.models.CustomerUrlData
 
setBalanceSeconds(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount
Sets the balanceSeconds value.
setCallbackUrl(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the callback url.
setCallbackUrl(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Deprecated.
Use setNotificationConfig instead
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the callback url.
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Deprecated.
Use setNotificationConfig instead
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the callback url.
setCallbackUrl(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Deprecated.
Use setNotificationConfig instead
setCallbackUrl(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the callback url.
setCallbackUrl(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Deprecated.
Use setNotificationConfig instead
setChannels(Integer) - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Specifies the number of audio channels that the audio samples contain.
setCompletedOn(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Set the date and time the job was completed on.
setCompletedOn(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Set the date and time the job was completed on.
setCompletedOn(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the date and time the custom vocabulary was completed on.
setCompletedOn(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Set the date and time the job was completed on.
setConfidence(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element
Sets the confidence score to the Double provided.
setContent(String) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the content of the informant.
setContent(String) - Method in class ai.rev.topicextraction.models.Informant
Sets the content of the informant
setContentType(String) - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Specifies the content type of the audio.
setCreatedOn(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the time and date the job was created on.
setCreatedOn(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the time and date the job was created on.
setCreatedOn(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the time and date the custom vocabulary was created on.
setCreatedOn(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the time and date the job was created on.
setCustomVocabularies(List<CustomVocabulary>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Provides the custom vocabularies to be used by the speech engine when processing the transcript.
setCustomVocabularies(List<CustomVocabulary>) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Provides the custom vocabularies to be used by the speech engine when processing the stream.
setCustomVocabularyId(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the user-supplied custom vocabulary ID for job
setCustomVocabularyId(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the ID of the custom vocabulary the speech engine should use while processing audio samples.
setCustomVocabularyId(String) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the ID of the custom vocabulary the speech engine should use while processing audio samples.
setDeleteAfterSeconds(Integer) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the duration in seconds before job is deleted
setDeleteAfterSeconds(Integer) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
setDeleteAfterSeconds(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the duration in seconds before job is deleted
setDeleteAfterSeconds(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
setDeleteAfterSeconds(Integer) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
setDeleteAfterSeconds(Integer) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the duration in seconds before job is deleted
setDeleteAfterSeconds(Integer) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
setDetailedPartials(Boolean) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies whether or not to return detailed partials.
setDurationSeconds(Double) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the audio duration.
setElements(Element[]) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Sets elements to the list of Element objects provided.
setElements(List<Element>) - Method in class ai.rev.speechtotext.models.asynchronous.Monologue
Sets elements to the list of Element objects provided.
setEmail(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiAccount
Sets the email value.
setEndTimestamp(Double) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the end timestamp of the content in the input.
setEndTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element
Sets the end timestamp for this audio interval.
setEndTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.SegmentToTranscribe
Sets the end timestamp for the segment to transcribe.
setEndTimestamp(Double) - Method in class ai.rev.topicextraction.models.Informant
Sets the end timestamp of the content in the input
setEndTs(Double) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Sets the ending timestamp.
setFailure(RevAiFailureType) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the failure to the provided RevAiFailureType enumeration.
setFailure(RevAiFailureType) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the failure to the provided RevAiFailureType enumeration.
setFailure(RevAiFailureType) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the failure to the provided RevAiFailureType enumeration.
setFailure(CustomVocabularyFailureType) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the failure details to the provided value.
setFailureDetail(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the failure detail to the provided value.
setFailureDetails(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the failure details to the provided value.
setFailureDetails(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the failure details to the provided value.
setFailureDetails(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the failure details to the provided value.
setFilterProfanity(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets filter profanity option for job
setFilterProfanity(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies whether or not the speech engine should filter profanity in the output.
setFilterProfanity(Boolean) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies whether or not the speech engine should filter profanity in the output.
setFormat(String) - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Specifies the format of the audio samples.
setHost(String) - Method in class ai.rev.speechtotext.StreamingClient
This methods sets the URL host name.
setId(String) - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
 
setId(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the custom vocabulary Id to the provided value.
setInformants(List<Informant>) - Method in class ai.rev.topicextraction.models.Topic
Specifies the list of informants.
setJobId(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the Job ID.
setJobId(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the Job ID.
setJobId(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the Job ID.
setJobStatus(SentimentAnalysisJobStatus) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the job status to the provided SentimentAnalysisJobStatus enumeration value.
setJobStatus(RevAiJobStatus) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the job status to the provided RevAiJobStatus enumeration value.
setJobStatus(TopicExtractionJobStatus) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the job status to the provided TopicExtractionJobStatus enumeration value.
setJson(RevAiTranscript) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Specifies a RevAiTranscript from the async api that will have sentiment analysis run on it
setJson(RevAiTranscript) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Specifies a RevAiTranscript from the async api that will have topic extraction run on it
setLanguage(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the language for job
setLanguage(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the language for job
setLanguage(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies language for ASR system using ISO 639-1 2-letter language code.
setLanguage(String) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the language to use for the streaming job.
setLanguage(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the language for job
setLayout(String) - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Specifies the layout of channels within the buffer.
setLength(Integer) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the character length of the content
setLength(Integer) - Method in class ai.rev.topicextraction.models.Informant
Sets the character length of the content
setMediaType(MediaType) - Method in class ai.rev.helpers.MockInterceptor
 
setMediaUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the media url.
setMediaUrl(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Deprecated.
Use setSourceConfig instead
setMessages(List<SentimentMessage>) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisResult
Set the messages of the result.
setMetadata(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the metadata.
setMetadata(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Optional metadata that is provided during job submission limited to 512 characters.
setMetadata(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the metadata.
setMetadata(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Optional metadata that is provided during job submission limited to 512 characters.
setMetadata(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the metadata.
setMetadata(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Optional metadata that is provided during custom vocabulary submission limited to 512 characters.
setMetadata(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the metadata.
setMetadata(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Optional metadata that is provided during job submission limited to 512 characters.
setMetaData(String) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the metadata to be used in the submission request to /jobs.
setMonologues(List<Monologue>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiTranscript
Sets the monologues to the list of monologues provided.
setName(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the file name.
setNotificationConfig(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setNotificationConfig(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setNotificationConfig(String) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Specifies the callback url that Rev AI will POST to when custom vocabulary processing is complete This property is optional.
setNotificationConfig(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setNotificationConfig(String, Map<String, String>) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setNotificationConfig(String, Map<String, String>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setNotificationConfig(String, Map<String, String>) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
Specifies the callback url that Rev AI will POST to when custom vocabulary processing is complete and the auth headers to use when calling the url This property is optional.
setNotificationConfig(String, Map<String, String>) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Optional property to specify the callback url that Rev AI will POST to when job processing is complete
setOffset(Integer) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the character index at which the content started in the input
setOffset(Integer) - Method in class ai.rev.topicextraction.models.Informant
Sets the character index at which the content started in the input
setPhrases(List<String>) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabulary
Sets the list of phrases to be used in the custom vocabulary.
setPort(int) - Method in class ai.rev.speechtotext.StreamingClient
This method sets a port number to be used in the WebSocket connect request.
setRate(Integer) - Method in class ai.rev.speechtotext.models.streaming.StreamContentType
Specifies the sample rate of the audio.
setRemoveDisfluencies(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets remove disfluencies option for job
setRemoveDisfluencies(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies whether or not the speech engine should remove disfluencies in the output.
setRemoveDisfluencies(Boolean) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies whether or not the speech engine should remove disfluencies in the output.
setRequest(Request) - Method in class ai.rev.helpers.MockInterceptor
 
setResponseCode(Integer) - Method in class ai.rev.helpers.MockInterceptor
 
setRush(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets rush option for job transcribed by human
setRush(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Sets whether job is given higher priority by human transcriber to be worked on sooner in exchange for a higher price.
setSampleResponse(String) - Method in class ai.rev.helpers.MockInterceptor
 
setScheme(String) - Method in class ai.rev.speechtotext.StreamingClient
This method sets the URL scheme to be used in the WebSocket connect request
setScore(Double) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the score of the content.
setScore(Double) - Method in class ai.rev.topicextraction.models.Topic
Specifies the score.
setSegmentsToTranscribe(List<SegmentToTranscribe>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets segments to be transcribed for job transcribed by human
setSegmentsToTranscribe(List<SegmentToTranscribe>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies specific segments of the media to transcribe.
setSentiment(Sentiment) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the Sentiment of the informant.
setSkipDiarization(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets skip diarization option for job
setSkipDiarization(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies if speaker diarization will be skipped by the speech engine.
setSkipPunctuation(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets skip punctuation option for job
setSkipPunctuation(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies if the "punct" elements will be skipped by the speech engine.
setSourceConfig(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the source media download url.
setSourceConfig(String, Map<String, String>) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the url and any optional auth headers to access the source media download url.
setSpeaker(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.Monologue
Sets the speaker number for this monologue.
setSpeakerChannelsCount(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets speaker channels count for job
setSpeakerChannelsCount(Integer) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the number of speaker channels in the audio.
setStartTimestamp(Double) - Method in class ai.rev.sentimentanalysis.models.SentimentMessage
Sets the start timestamp of the content in the input.
setStartTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.Element
Sets the starting timestamp for this audio interval.
setStartTimestamp(Double) - Method in class ai.rev.speechtotext.models.asynchronous.SegmentToTranscribe
Sets the starting timestamp for the segment to transcribe.
setStartTimestamp(Double) - Method in class ai.rev.topicextraction.models.Informant
Sets the start timestamp of the content in the input
setStartTs(Double) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the number of seconds to offset all hypotheses timings.
setStatus(CustomVocabularyStatus) - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
Sets the status to the provided CustomVocabularyStatus enumeration value.
setTestMode(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Sets whether job is a mocked job which will return a mock transcript.
setText(String) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJobOptions
Specifies plain text that will have sentiment analysis run on it.
setText(String) - Method in class ai.rev.topicextraction.models.TopicExtractionJobOptions
Specifies plain text that will have topic extraction run on it
setTopicName(String) - Method in class ai.rev.topicextraction.models.Topic
Specifies the topic name.
setTopics(List<Topic>) - Method in class ai.rev.topicextraction.models.TopicExtractionResult
Set the topics of the result.
setTranscriber(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the transcriber used for job
setTranscriber(String) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Specifies the type of transcriber to use to transcribe the media file
setTranscriber(String) - Method in class ai.rev.speechtotext.models.streaming.SessionConfig
Specifies the type of transcriber to use to transcribe the media.
setTs(Double) - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
Sets the starting timestamp.
setType(RevAiJobType) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the job type to the provided RevAiJobType enumeration.
setType(RevAiJobType) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets the job type to the provided RevAiJobType enumeration.
setType(RevAiJobType) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the job type to the provided RevAiJobType enumeration.
setType(MessageType) - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
Specifies the WebSocket message type.
setType(String) - Method in class ai.rev.speechtotext.models.asynchronous.Element
Sets the type to the String provided
setUrl(String) - Method in class ai.rev.speechtotext.models.CustomerUrlData
 
setValue(String) - Method in class ai.rev.speechtotext.models.asynchronous.Element
Sets the value of the transcript element to the String provided.
setVerbatim(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
Sets verbatim for job transcribed by human
setVerbatim(Boolean) - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJobOptions
Sets whether transcriber will transcribe every syllable including disfluencies.
setWordCount(Integer) - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
Sets the word count.
setWordCount(Integer) - Method in class ai.rev.topicextraction.models.TopicExtractionJob
Sets the word count.
SRT - ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
The SubRip caption file format.
STREAM - ai.rev.speechtotext.models.asynchronous.RevAiJobType
The type used for streaming jobs.
StreamContentType - Class in ai.rev.speechtotext.models.streaming
The StreamContentType describes the format of the audio being sent over the WebSocket.
StreamContentType() - Constructor for class ai.rev.speechtotext.models.streaming.StreamContentType
 
StreamingClient - Class in ai.rev.speechtotext
 
StreamingClient(String) - Constructor for class ai.rev.speechtotext.StreamingClient
Constructs the streaming client that is used to establish a WebSocket connection with the Rev AI server and stream audio data.
StreamingResponseMessage - Class in ai.rev.speechtotext.models.streaming
A parent class that can be used to serialize and deserialize the "type" in the WebSocket messages.
StreamingResponseMessage() - Constructor for class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
 
submitCustomVocabularies(CustomVocabularySubmission) - Method in class ai.rev.speechtotext.CustomVocabulariesClient
This method makes a POST request to the /vocabularies endpoint and returns a CustomVocabularyInformation object that provides details about the custom vocabulary submission and its progress.
submitCustomVocabularies(CustomVocabularySubmission) - Method in interface ai.rev.speechtotext.CustomVocabularyApiInterface
 
submitJob(SentimentAnalysisJobOptions) - Method in interface ai.rev.sentimentanalysis.SentimentAnalysisInterface
 
submitJob(TopicExtractionJobOptions) - Method in interface ai.rev.topicextraction.TopicExtractionInterface
 
submitJobJson(RevAiTranscript) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
An overload of SentimentAnalysisClient.submitJobText(String, SentimentAnalysisJobOptions) without the additional sentiment analysis options.
submitJobJson(RevAiTranscript) - Method in class ai.rev.topicextraction.TopicExtractionClient
An overload of TopicExtractionClient.submitJobText(String, TopicExtractionJobOptions) without the additional topic extraction options.
submitJobJson(RevAiTranscript, SentimentAnalysisJobOptions) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
The method sends a POST request to the /jobs endpoint, starts a sentiment analysis job for the provided RevAiTranscript and returns a SentimentAnalysisJob object.
submitJobJson(RevAiTranscript, TopicExtractionJobOptions) - Method in class ai.rev.topicextraction.TopicExtractionClient
The method sends a POST request to the /jobs endpoint, starts a topic extraction job for the provided RevAiTranscript and returns a TopicExtractionJob object.
submitJobLocalFile(InputStream) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename and transcription options.
submitJobLocalFile(InputStream, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename.
submitJobLocalFile(InputStream, String) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.submitJobLocalFile(InputStream, String, RevAiJobOptions) without the additional transcription options.
submitJobLocalFile(InputStream, String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient
The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file provided by InputStream and returns a RevAiJob object.
submitJobLocalFile(String) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.submitJobLocalFile(String, RevAiJobOptions) without the additional transcription options.
submitJobLocalFile(String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient
The method sends multipart/form request to the /jobs endpoint, starts an asynchronous job to transcribe the local media file provided and returns a RevAiJob object.
submitJobLocalFile(MultipartBody.Part, RevAiJobOptions) - Method in interface ai.rev.speechtotext.ApiInterface
 
submitJobText(String) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
An overload of SentimentAnalysisClient.submitJobText(String, SentimentAnalysisJobOptions) without the additional sentiment analysis options.
submitJobText(String) - Method in class ai.rev.topicextraction.TopicExtractionClient
An overload of TopicExtractionClient.submitJobText(String, TopicExtractionJobOptions) without the additional topic extraction options.
submitJobText(String, SentimentAnalysisJobOptions) - Method in class ai.rev.sentimentanalysis.SentimentAnalysisClient
The method sends a POST request to the /jobs endpoint, starts a sentiment analysis job for the provided text and returns a SentimentAnalysisJob object.
submitJobText(String, TopicExtractionJobOptions) - Method in class ai.rev.topicextraction.TopicExtractionClient
The method sends a POST request to the /jobs endpoint, starts a topic extraction job for the provided text and returns a TopicExtractionJob object.
submitJobUrl(RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient
Sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file located at the url provided, and returns a RevAiJob object.
submitJobUrl(RevAiJobOptions) - Method in interface ai.rev.speechtotext.ApiInterface
 
submitJobUrl(String) - Method in class ai.rev.speechtotext.ApiClient
An overload of ApiClient.submitJobUrl(String, RevAiJobOptions) without the additional transcription options.
submitJobUrl(String, RevAiJobOptions) - Method in class ai.rev.speechtotext.ApiClient
Deprecated.
Use submitJobUrl with the sourceConfig job option rather than a separate mediaUrl argument

T

ThrottlingLimitException - Exception in ai.rev.exceptions
ThrottlingLimitException occurs when the number of queries within a given period exceeds a throttling limit.
ThrottlingLimitException(JSONObject) - Constructor for exception ai.rev.exceptions.ThrottlingLimitException
 
Topic - Class in ai.rev.topicextraction.models
Represents a single topic in the input as well as all the information that comes with it.
Topic() - Constructor for class ai.rev.topicextraction.models.Topic
 
TOPICEXTRACTION - ai.rev.speechtotext.models.asynchronous.RevAiJobType
The type used for topic extraction jobs.
TopicExtractionClient - Class in ai.rev.topicextraction
The TopicExtractionClient object provides methods to send and retrieve information from all the Rev AI Topic Extraction API endpoints using the Retrofit HTTP client.
TopicExtractionClient(String) - Constructor for class ai.rev.topicextraction.TopicExtractionClient
Constructs the API client used to send HTTP requests to Rev AI.
TopicExtractionInterface - Interface in ai.rev.topicextraction
The TopicExtractionInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev AI Topic Extraction API.
TopicExtractionJob - Class in ai.rev.topicextraction.models
A Topic Extraction Job object provides all the information associated with a job submitted by the user.
TopicExtractionJob() - Constructor for class ai.rev.topicextraction.models.TopicExtractionJob
 
TopicExtractionJobOptions - Class in ai.rev.topicextraction.models
A TopicExtractionJobOptions object represents parameters that are submitted along a new job.
TopicExtractionJobOptions() - Constructor for class ai.rev.topicextraction.models.TopicExtractionJobOptions
 
TopicExtractionJobStatus - Enum in ai.rev.topicextraction.models
Specifies constants that define Rev AI job statuses.
TopicExtractionResult - Class in ai.rev.topicextraction.models
A Topic Extraction Result object provides all the information associated with the result of a job.
TopicExtractionResult() - Constructor for class ai.rev.topicextraction.models.TopicExtractionResult
 
toString() - Method in enum ai.rev.sentimentanalysis.models.Sentiment
 
toString() - Method in class ai.rev.sentimentanalysis.models.SentimentAnalysisJob
 
toString() - Method in enum ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
 
toString() - Method in class ai.rev.speechtotext.models.asynchronous.Element
 
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
 
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType
 
toString() - Method in class ai.rev.speechtotext.models.asynchronous.RevAiJob
 
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
 
toString() - Method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType
 
toString() - Method in class ai.rev.speechtotext.models.streaming.ConnectedMessage
 
toString() - Method in class ai.rev.speechtotext.models.streaming.Hypothesis
 
toString() - Method in enum ai.rev.speechtotext.models.streaming.MessageType
 
toString() - Method in class ai.rev.speechtotext.models.streaming.StreamingResponseMessage
 
toString() - Method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyFailureType
 
toString() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation
 
toString() - Method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
 
toString() - Method in class ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission
 
toString() - Method in class ai.rev.topicextraction.models.TopicExtractionJob
 
toString() - Method in enum ai.rev.topicextraction.models.TopicExtractionJobStatus
 
TRANSCRIBED - ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
The status when the file has been transcribed.
TRANSCRIPTION - ai.rev.speechtotext.models.asynchronous.RevAiFailureType
The failure used when an error occurs during transcription and prevents job completion.

V

valueOf(String) - Static method in enum ai.rev.sentimentanalysis.models.Sentiment
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.streaming.MessageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyFailureType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.rev.topicextraction.models.TopicExtractionJobStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum ai.rev.sentimentanalysis.models.Sentiment
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.sentimentanalysis.models.SentimentAnalysisJobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiFailureType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.asynchronous.RevAiJobType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.streaming.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyFailureType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.rev.topicextraction.models.TopicExtractionJobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
VTT - ai.rev.speechtotext.models.asynchronous.RevAiCaptionType
The WebVTT caption file format.
A B C D E F G H I M N O P R S T V 
All Classes All Packages