REVAI-3854: SuperApi features (#59)

REVAI-3854: SuperApi features

Author: kirillatrev

pom.xml

@@ -44,7 +44,7 @@
         <dependency>
             <groupId>org.json</groupId>
             <artifactId>json</artifactId>
-            <version>20190722</version>
+            <version>20230227</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -77,7 +77,7 @@
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.8.6</version>
+            <version>2.8.9</version>
         </dependency>
         <dependency>
             <groupId>com.squareup.retrofit2</groupId>

src/main/java/ai/rev/speechtotext/ApiClient.java

@@ -1,11 +1,7 @@
 package ai.rev.speechtotext;
 
 import ai.rev.helpers.ClientHelper;
-import ai.rev.speechtotext.models.asynchronous.RevAiAccount;
-import ai.rev.speechtotext.models.asynchronous.RevAiCaptionType;
-import ai.rev.speechtotext.models.asynchronous.RevAiJob;
-import ai.rev.speechtotext.models.asynchronous.RevAiJobOptions;
-import ai.rev.speechtotext.models.asynchronous.RevAiTranscript;
+import ai.rev.speechtotext.models.asynchronous.*;
 import okhttp3.MediaType;
 import okhttp3.MultipartBody;
 import okhttp3.OkHttpClient;
@@ -169,6 +165,33 @@ public RevAiTranscript getTranscriptObject(String id) throws IOException {
     return apiInterface.getTranscriptObject(id).execute().body();
   }
 
+  /**
+   * The method sends a GET request to the /jobs/{id}/transcript/translation/{language} endpoint and returns translated transcript
+   * as a String.
+   *
+   * @param id The ID of the job to return a transcript for.
+   * @param language requested transcript language.
+   * @return The transcript as a String in text format.
+   * @throws IOException If the response has a status code > 399.
+   */
+  public String getTranslatedTranscriptText(String id,String language) throws IOException {
+    return apiInterface.getTranslatedTranscriptText(id,language).execute().body();
+  }
+
+  /**
+   * The method sends a GET request to the /jobs/{id}/transcript/translation/{language} endpoint and returns a {@link
+   * RevAiTranscript} object containing translated transcript.
+   *
+   * @param id The ID of the job to return a transcript for.
+   * @param language requested transcript language.
+   * @return RevAiTranscript The transcript object.
+   * @throws IOException If the response has a status code > 399.
+   * @see RevAiTranscript
+   */
+  public RevAiTranscript getTranslatedTranscriptObject(String id, String language) throws IOException {
+    return apiInterface.getTranslatedTranscriptObject(id,language).execute().body();
+  }
+
   /**
    * The method sends a GET request to the /jobs/{id}/transcript endpoint and returns the transcript
    * as a String.
@@ -181,6 +204,30 @@ public String getTranscriptText(String id) throws IOException {
     return apiInterface.getTranscriptText(id).execute().body();
   }
 
+  /**
+   * The method sends a GET request to the /jobs/{id}/transcript/summary endpoint and returns the transcript summary
+   * as a String.
+   *
+   * @param id The ID of the job to return a transcript summary for.
+   * @return The transcript summary as a String in text format.
+   * @throws IOException If the response has a status code > 399.
+   */
+  public String getTranscriptSummaryText(String id) throws IOException {
+    return apiInterface.getTranscriptSummaryText(id).execute().body();
+  }
+
+  /**
+   * The method sends a GET request to the /jobs/{id}/transcript/summary endpoint and returns the transcript summary
+   * as a {@link Summary} object.
+   *
+   * @param id The ID of the job to return a transcript summary for.
+   * @return The transcript summary as a String in text format.
+   * @throws IOException If the response has a status code > 399.
+   */
+  public Summary getTranscriptSummaryObject(String id) throws IOException {
+    return apiInterface.getTranscriptSummaryObject(id).execute().body();
+  }
+
   /**
    * 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 {@link RevAiJob} object.
@@ -355,7 +402,7 @@ public RevAiJob submitJobLocalFile(InputStream inputStream, RevAiJobOptions opti
 
   /**
    * 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.
+   * provided job ID in the form of an {@link InputStream}.
    *
    * @param id The ID of the job to return captions for.
    * @param captionType An enumeration of the desired caption type. Default is SRT.
@@ -384,6 +431,38 @@ public InputStream getCaptions(String id, RevAiCaptionType captionType, Integer
     return apiInterface.getCaptionText(id, query, contentHeader).execute().body().byteStream();
   }
 
+  /**
+   * The method sends a GET request to the /jobs/{id}/captions/translation/{language} endpoint and returns translated captions for the
+   * provided job ID in the form of an {@link InputStream}.
+   *
+   * @param id The ID of the job to return captions for.
+   * @param language requested translation language.
+   * @param captionType An enumeration of the desired caption type. Default is SRT.
+   * @param channelId Identifies the audio channel of the file to output captions for. Default is
+   *     null.
+   * @return InputStream A stream of bytes that represents the caption output.
+   * @throws IOException If the response has a status code > 399.
+   * @throws IllegalArgumentException If the job ID provided is null.
+   * @see <a
+   *     href="https://docs.rev.ai/api/asynchronous/reference/#operation/GetCaptions">https://docs.rev.ai/api/asynchronous/reference/#operation/GetCaptions</a>
+   */
+  public InputStream getTranslatedCaptions(String id, String language, RevAiCaptionType captionType, Integer channelId)
+          throws IOException {
+    if (id == null) {
+      throw new IllegalArgumentException("Job ID must be provided");
+    }
+    Map<String, String> query = new HashMap<>();
+    if (channelId != null) {
+      query.put("speaker_channel", channelId.toString());
+    }
+    if (captionType == null) {
+      captionType = RevAiCaptionType.SRT;
+    }
+    Map<String, String> contentHeader = new HashMap<>();
+    contentHeader.put("Accept", captionType.getContentType());
+    return apiInterface.getTranslatedCaptionText(id, language, query, contentHeader).execute().body().byteStream();
+  }
+
   /**
    * An overload of {@link ApiClient#getCaptions(String, RevAiCaptionType, Integer)} without the
    * optional channel ID.

src/main/java/ai/rev/speechtotext/ApiInterface.java

@@ -1,9 +1,6 @@
 package ai.rev.speechtotext;
 
-import ai.rev.speechtotext.models.asynchronous.RevAiAccount;
-import ai.rev.speechtotext.models.asynchronous.RevAiJob;
-import ai.rev.speechtotext.models.asynchronous.RevAiJobOptions;
-import ai.rev.speechtotext.models.asynchronous.RevAiTranscript;
+import ai.rev.speechtotext.models.asynchronous.*;
 import okhttp3.MultipartBody;
 import okhttp3.ResponseBody;
 import retrofit2.Call;
@@ -46,6 +43,22 @@ public interface ApiInterface {
   @GET("jobs/{id}/transcript")
   Call<String> getTranscriptText(@Path("id") String jobID);
 
+  @Headers("Accept: " + REV_JSON_CONTENT_TYPE)
+  @GET("jobs/{id}/transcript/translation/{language}")
+  Call<RevAiTranscript> getTranslatedTranscriptObject(@Path("id") String jobID, @Path("language") String language);
+
+  @Headers("Accept: " + REV_TEXT_CONTENT_TYPE)
+  @GET("jobs/{id}/transcript/translation/{language}")
+  Call<String> getTranslatedTranscriptText(@Path("id") String jobID, @Path("language") String language);
+
+  @Headers("Accept: " + REV_TEXT_CONTENT_TYPE)
+  @GET("jobs/{id}/transcript/summary")
+  Call<String> getTranscriptSummaryText(@Path("id") String jobID);
+
+  @Headers("Accept: application/json")
+  @GET("jobs/{id}/transcript/summary")
+  Call<Summary> getTranscriptSummaryObject(@Path("id") String jobID);
+
   @POST("jobs")
   Call<RevAiJob> submitJobUrl(@Body RevAiJobOptions options);
 
@@ -62,4 +75,11 @@ Call<ResponseBody> getCaptionText(
       @Path("id") String jobID,
       @QueryMap Map<String, String> query,
       @HeaderMap Map<String, String> contentType);
+
+  @GET("jobs/{id}/captions/translation/{language}")
+  Call<ResponseBody> getTranslatedCaptionText(
+          @Path("id") String jobID,
+          @Path("language") String language,
+          @QueryMap Map<String, String> query,
+          @HeaderMap Map<String, String> contentType);
 }

src/main/java/ai/rev/speechtotext/models/NlpModel.java

@@ -0,0 +1,33 @@
+package ai.rev.speechtotext.models;
+
+import com.google.gson.annotations.SerializedName;
+
+/** GPT Model type. STANDARD (GPT 3.5) or PREMIUM (GPT 4) */
+public enum NlpModel {
+
+    /** gpt 3.5. This is the default value. */
+    @SerializedName("standard")
+    STANDARD("standard"),
+
+    /** gpt 4. */
+    @SerializedName("premium")
+    PREMIUM("premium");
+
+    private final String model;
+
+    NlpModel(String model) {
+        this.model = model;
+    }
+
+    /**
+     * Returns the String value of the enumeration.
+     *
+     * @return The String value of the enumeration.
+     */
+    public String getModel() { return model; }
+
+    @Override
+    public String toString() {
+        return "{" + "model='" + model + '\'' + '}';
+    }
+}

src/main/java/ai/rev/speechtotext/models/asynchronous/RevAiJob.java

@@ -79,6 +79,12 @@ public class RevAiJob {
   @SerializedName("segments_to_transcribe")
   private List<SegmentToTranscribe> segmentsToTranscribe;
 
+  @SerializedName("summarization")
+  private Summarization summarization;
+
+  @SerializedName("translation")
+  private Translation translation;
+
   /**
    * Returns a String that contains the job ID.
    *
@@ -517,6 +523,38 @@ public void setSegmentsToTranscribe(List<SegmentToTranscribe> segmentsToTranscri
     this.segmentsToTranscribe = segmentsToTranscribe;
   }
 
+  /**
+   * Returns summarization options for the job
+   *
+   * @return Summarization options for the job
+   */
+  public Summarization getSummarization() {
+    return summarization;
+  }
+
+  /**
+   * Sets summarization options for the job
+   */
+  public void setSummarization(Summarization summarization) {
+    this.summarization = summarization;
+  }
+
+  /**
+   * Returns translation options for the job
+   *
+   * @return Translation options for the job
+   */
+  public Translation getTranslation() {
+    return translation;
+  }
+
+  /**
+   * Sets translation options for the job
+   */
+  public void setTranslation(Translation translation) {
+    this.translation = translation;
+  }
+
   @Override
   public String toString() {
     return "{"
@@ -552,7 +590,7 @@ public String toString() {
         + failureDetails
         + '\''
         + ", failure='"
-        + failure.getFailureType()
+        + getFailureTypeString(failure)
         + '\''
         + ", deleteAfterSeconds='"
         + deleteAfterSeconds
@@ -587,6 +625,18 @@ public String toString() {
         + ", segmentsToTranscribe='"
         + segmentsToTranscribe
         + '\''
+        + ", summarization='"
+        + summarization
+        + '\''
+        + ", translation='"
+        + translation
+        + '\''
         + '}';
   }
+
+  private static String getFailureTypeString(RevAiFailureType failure) {
+    if(failure == null)
+      return "";
+    return failure.getFailureType();
+  }
 }

src/main/java/ai/rev/speechtotext/models/asynchronous/RevAiJobOptions.java

@@ -136,6 +136,12 @@ public class RevAiJobOptions {
   @SerializedName("speaker_names")
   private List<SpeakerName> speakerNames;
 
+  @SerializedName("summarization_config")
+  private SummarizationOptions summarizationOptions;
+
+  @SerializedName("translation_config")
+  private TranslationOptions translationOptions;
+
   /**
    * Returns the media url.
    *
@@ -563,4 +569,40 @@ public List<SpeakerName> getSpeakerNames() {
   public void setSpeakerNames(List<SpeakerName> speakerNames) {
     this.speakerNames = speakerNames;
   }
+
+  /**
+   * Returns summarization options
+   *
+   * @return Summarization options
+   */
+  public SummarizationOptions getSummarizationOptions() {
+    return summarizationOptions;
+  }
+
+  /**
+   * Specifies summarization options.
+   *
+   * @param summarizationOptions Summarization options
+   */
+  public void setSummarizationOptions(SummarizationOptions summarizationOptions) {
+    this.summarizationOptions = summarizationOptions;
+  }
+
+  /**
+   * Returns translation options.
+   *
+   * @return  Translation options
+   */
+  public TranslationOptions getTranslationOptions() {
+    return translationOptions;
+  }
+
+  /**
+   * Specifies translation options.
+   *
+   * @param translationOptions Translation options
+   */
+  public void setTranslationOptions(TranslationOptions translationOptions) {
+    this.translationOptions = translationOptions;
+  }
 }