Package ai.rev.topicextraction

Interface TopicExtractionInterface

public interface TopicExtractionInterface

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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	REV_TOPIC_CONTENT_TYPE

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteJob(String jobID)
retrofit2.Call<TopicExtractionJob>	getJobDetails(String jobID)
retrofit2.Call<List<TopicExtractionJob>>	getListOfJobs(Map<String,String> options)
retrofit2.Call<TopicExtractionResult>	getResultObject(String jobID, Map<String,Object> options)
retrofit2.Call<TopicExtractionJob>	submitJob(TopicExtractionJobOptions options)

Field Detail

REV_TOPIC_CONTENT_TYPE

static final String REV_TOPIC_CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

getJobDetails

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

getListOfJobs

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

getResultObject

@Headers("Accept: application/vnd.rev.topic.v1.0+json")
@GET("jobs/{id}/result")
retrofit2.Call<TopicExtractionResult> getResultObject(@Path("id")
                                                      String jobID,
                                                      @QueryMap
                                                      Map<String,Object> options)

submitJob

@POST("jobs")
retrofit2.Call<TopicExtractionJob> submitJob(@Body
                                             TopicExtractionJobOptions options)

deleteJob

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