Package ai.rev.speechtotext

Interface ApiInterface

public interface ApiInterface

The ApiInterface is a type-safe Retrofit interface that presents all the endpoints that are made to communicate with the Rev AI async API.

Field Summary

Fields

Modifier and Type	Field	Description
static String	REV_JSON_CONTENT_TYPE
static String	REV_TEXT_CONTENT_TYPE

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteJob(String jobID)
retrofit2.Call<RevAiAccount>	getAccount()
retrofit2.Call<okhttp3.ResponseBody>	getCaptionText(String jobID, Map<String,String> query, Map<String,String> contentType)
retrofit2.Call<RevAiJob>	getJobDetails(String jobID)
retrofit2.Call<List<RevAiJob>>	getListOfJobs(Map<String,String> options)
retrofit2.Call<RevAiTranscript>	getTranscriptObject(String jobID)
retrofit2.Call<Summary>	getTranscriptSummaryObject(String jobID)
retrofit2.Call<String>	getTranscriptSummaryText(String jobID)
retrofit2.Call<String>	getTranscriptText(String jobID)
retrofit2.Call<okhttp3.ResponseBody>	getTranslatedCaptionText(String jobID, String language, Map<String,String> query, Map<String,String> contentType)
retrofit2.Call<RevAiTranscript>	getTranslatedTranscriptObject(String jobID, String language)
retrofit2.Call<String>	getTranslatedTranscriptText(String jobID, String language)
retrofit2.Call<RevAiJob>	submitJobLocalFile(okhttp3.MultipartBody.Part file, RevAiJobOptions options)
retrofit2.Call<RevAiJob>	submitJobUrl(RevAiJobOptions options)

Field Detail

REV_JSON_CONTENT_TYPE

static final String REV_JSON_CONTENT_TYPE

See Also:

Constant Field Values

REV_TEXT_CONTENT_TYPE

static final String REV_TEXT_CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

getAccount

@GET("account")
retrofit2.Call<RevAiAccount> getAccount()

getJobDetails

@GET("jobs/{id}")
retrofit2.Call<RevAiJob> getJobDetails(@Path("id")
                                       String jobID)

getListOfJobs

@GET("jobs")
retrofit2.Call<List<RevAiJob>> getListOfJobs(@QueryMap
                                             Map<String,String> options)

getTranscriptObject

@Headers("Accept: application/vnd.rev.transcript.v1.0+json")
@GET("jobs/{id}/transcript")
retrofit2.Call<RevAiTranscript> getTranscriptObject(@Path("id")
                                                    String jobID)

getTranscriptText

@Headers("Accept: text/plain")
@GET("jobs/{id}/transcript")
retrofit2.Call<String> getTranscriptText(@Path("id")
                                         String jobID)

getTranslatedTranscriptObject

@Headers("Accept: application/vnd.rev.transcript.v1.0+json")
@GET("jobs/{id}/transcript/translation/{language}")
retrofit2.Call<RevAiTranscript> getTranslatedTranscriptObject(@Path("id")
                                                              String jobID,
                                                              @Path("language")
                                                              String language)

getTranslatedTranscriptText

@Headers("Accept: text/plain")
@GET("jobs/{id}/transcript/translation/{language}")
retrofit2.Call<String> getTranslatedTranscriptText(@Path("id")
                                                   String jobID,
                                                   @Path("language")
                                                   String language)

getTranscriptSummaryText

@Headers("Accept: text/plain")
@GET("jobs/{id}/transcript/summary")
retrofit2.Call<String> getTranscriptSummaryText(@Path("id")
                                                String jobID)

getTranscriptSummaryObject

@Headers("Accept: application/json")
@GET("jobs/{id}/transcript/summary")
retrofit2.Call<Summary> getTranscriptSummaryObject(@Path("id")
                                                   String jobID)

submitJobUrl

@POST("jobs")
retrofit2.Call<RevAiJob> submitJobUrl(@Body
                                      RevAiJobOptions options)

deleteJob

@DELETE("jobs/{id}")
retrofit2.Call<Void> deleteJob(@Path("id")
                               String jobID)

submitJobLocalFile

@Multipart
@POST("jobs")
retrofit2.Call<RevAiJob> submitJobLocalFile(@Part
                                            okhttp3.MultipartBody.Part file,
                                            @Part("options")
                                            RevAiJobOptions options)

getCaptionText

@GET("jobs/{id}/captions")
retrofit2.Call<okhttp3.ResponseBody> getCaptionText(@Path("id")
                                                    String jobID,
                                                    @QueryMap
                                                    Map<String,String> query,
                                                    @HeaderMap
                                                    Map<String,String> contentType)

getTranslatedCaptionText

@GET("jobs/{id}/captions/translation/{language}")
retrofit2.Call<okhttp3.ResponseBody> getTranslatedCaptionText(@Path("id")
                                                              String jobID,
                                                              @Path("language")
                                                              String language,
                                                              @QueryMap
                                                              Map<String,String> query,
                                                              @HeaderMap
                                                              Map<String,String> contentType)