AISDK-129: Add delete_after_seconds option to streaming and async clients (#26)

Author: KostasRev

README.md

@@ -13,7 +13,7 @@ The recommended way to use the Rev.ai Java SDK is to import it into the project
       <dependency>
         <groupId>ai.rev.speechtotext</groupId>
         <artifactId>revai-java-sdk-speechtotext</artifactId>
-        <version>1.1.1</version>
+        <version>1.2.0</version>
       </dependency>
 
 ## Build and install locally from source
@@ -74,7 +74,7 @@ RevAiJob revAiJob = apiClient.submitJobLocalFile(fileInputStream, String fileNam
 If you want to get fancy, all submit job methods have overrides that allow specifying
 [RevAiJobOptions](src/main/java/ai/rev/speechtotext/models/asynchronous/RevAiJobOptions.java) to configure job specific settings.
 In RevAiJobOptions, you could include `metadata`, `callback_url`,
-`skip_diarization`, `skip_punctuation`, `speaker_channels_count`, `custom_vocabularies`, `filter_profanity` and `remove_disfluencies` as optional parameters, these are described in the request body of
+`skip_diarization`, `skip_punctuation`, `speaker_channels_count`, `custom_vocabularies`, `filter_profanity`, `remove_disfluencies`, and `delete_after_seconds` as optional parameters, these are described in the request body of
 the [Submit Job](https://www.rev.ai/docs#operation/SubmitTranscriptionJob) endpoint.
 
 ### Checking your job's status
@@ -199,7 +199,7 @@ public class Listener implements RevAiWebSocketListener {
 }
 ```
 
-Now you will be able to connect and start the streaming session by calling the `streamingClient.connect()` method and passing in the Listener! You can supply an optional `SessionConfig` object, containing `metadata`, `filter_profanity` and `remove_disfluencies` as optional parameters, to the function in order to provide additional information for that session.
+Now you will be able to connect and start the streaming session by calling the `streamingClient.connect()` method and passing in the Listener! You can supply an optional `SessionConfig` object, containing `metadata`, `filter_profanity`, `remove_disfluencies`, and `delete_after_seconds` as optional parameters, to the function in order to provide additional information for that session.
 
 ```
 Listener listener = new Listener();

examples/AsyncTranscribeLocalMediaFile.java

@@ -34,6 +34,7 @@ public static void main(String[] args) {
     revAiJobOptions.setFilterProfanity(true);
     revAiJobOptions.setRemoveDisfluencies(true);
     revAiJobOptions.setSpeakerChannelsCount(null);
+    revAiJobOptions.setDeleteAfterSeconds(2592000); // 30 days in seconds
 
     RevAiJob submittedJob;
 

examples/AsyncTranscribeMediaUrl.java

@@ -34,11 +34,11 @@ public static void main(String[] args) {
     revAiJobOptions.setFilterProfanity(true);
     revAiJobOptions.setRemoveDisfluencies(true);
     revAiJobOptions.setSpeakerChannelsCount(null);
+    revAiJobOptions.setDeleteAfterSeconds(2592000); // 30 days in seconds
 
     RevAiJob submittedJob;
 
-    String mediaUrl =
-        "https://support.rev.com/hc/en-us/article_attachments/200043975/FTC_Sample_1_-_Single.mp3";
+    String mediaUrl = "https://www.rev.ai/FTC_Sample_1.mp3";
 
     try {
       // Submit the local file and transcription options

examples/CustomVocabulariesExample.java renamed to examples/CustomVocabularies.java

@@ -8,7 +8,7 @@
 import java.io.IOException;
 import java.util.Arrays;
 
-public class CustomVocabulariesExample {
+public class CustomVocabularies {
 
   public static void main(String[] args) {
     // Assign your access token to a String

examples/StreamingFromLocalFileExample.java renamed to examples/StreamingFromLocalFile.java

@@ -15,7 +15,7 @@
 import java.nio.ByteBuffer;
 import java.util.Arrays;
 
-public class StreamingFromLocalFileExample {
+public class StreamingFromLocalFile {
 
   public static void main(String[] args) throws InterruptedException {
     // Assign your access token to a String
@@ -34,6 +34,7 @@ public static void main(String[] args) throws InterruptedException {
     sessionConfig.setMetaData("Streaming from the Java SDK");
     sessionConfig.setFilterProfanity(true);
     sessionConfig.setRemoveDisfluencies(true);
+    sessionConfig.setDeleteAfterSeconds(2592000); // 30 days in seconds
 
     // Initialize your client with your access token
     StreamingClient streamingClient = new StreamingClient(accessToken);

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>ai.rev.speechtotext</groupId>
     <artifactId>revai-java-sdk-speechtotext</artifactId>
-    <version>1.1.1</version>
+    <version>1.2.0</version>
     <name>Rev.ai speech to text SDK for Java</name>
     <description>Java SDK for rev.ai speech to text API</description>
     <url>https://www.rev.ai/docs</url>

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

@@ -198,6 +198,10 @@ private String buildURL(
         urlBuilder.addQueryParameter(
             "remove_disfluencies", String.valueOf(sessionConfig.getRemoveDisfluencies()));
       }
+      if (sessionConfig.getDeleteAfterSeconds() != null) {
+        urlBuilder.addQueryParameter(
+            "delete_after_seconds", String.valueOf(sessionConfig.getDeleteAfterSeconds()));
+      }
     }
     return urlBuilder.build().toString()
         + "&content_type="

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

@@ -52,6 +52,10 @@ public class RevAiJobOptions {
   @SerializedName("remove_disfluencies")
   private Boolean removeDisfluencies;
 
+  /** Optional number of seconds after job completion when job is auto-deleted */
+  @SerializedName("delete_after_seconds")
+  private Integer deleteAfterSeconds;
+
   /**
    * Returns the media url.
    *
@@ -208,7 +212,7 @@ public void setFilterProfanity(Boolean filterProfanity) {
   /**
    * Returns the value of the removeDisfluencies Boolean
    *
-   * @return The remove disfluencies value.
+   * @return The removeDisfluencies value.
    */
   public Boolean getRemoveDisfluencies() {
     return removeDisfluencies;
@@ -223,4 +227,23 @@ public Boolean getRemoveDisfluencies() {
   public void setRemoveDisfluencies(Boolean removeDisfluencies) {
     this.removeDisfluencies = removeDisfluencies;
   }
+
+  /**
+   * Returns the value of deleteAfterSeconds.
+   *
+   * @return The deleteAfterSeconds value.
+   */
+  public Integer getDeleteAfterSeconds() {
+    return deleteAfterSeconds;
+  }
+
+  /**
+   * Specifies the number of seconds to be waited until the job is auto-deleted after its
+   * completion.
+   *
+   * @param deleteAfterSeconds The number of seconds after job completion when job is auto-deleted.
+   */
+  public void setDeleteAfterSeconds(Integer deleteAfterSeconds) {
+    this.deleteAfterSeconds = deleteAfterSeconds;
+  }
 }

src/main/java/ai/rev/speechtotext/models/streaming/SessionConfig.java

@@ -7,6 +7,7 @@ public class SessionConfig {
   private Boolean filterProfanity;
   private String customVocabularyId;
   private Boolean removeDisfluencies;
+  private Integer deleteAfterSeconds;
 
   /**
    * Returns the metadata.
@@ -86,4 +87,23 @@ public Boolean getRemoveDisfluencies() {
   public void setRemoveDisfluencies(Boolean removeDisfluencies) {
     this.removeDisfluencies = removeDisfluencies;
   }
+
+  /**
+   * Returns the value of deleteAfterSeconds.
+   *
+   * @return The deleteAfterSeconds value.
+   */
+  public Integer getDeleteAfterSeconds() {
+    return deleteAfterSeconds;
+  }
+
+  /**
+   * Specifies the number of seconds to be waited until the job is auto-deleted after its
+   * completion.
+   *
+   * @param deleteAfterSeconds The number of seconds after job completion when job is auto-deleted.
+   */
+  public void setDeleteAfterSeconds(Integer deleteAfterSeconds) {
+    this.deleteAfterSeconds = deleteAfterSeconds;
+  }
 }

src/test/java/ai/rev/speechtotext/integration/StreamingTest.java

@@ -125,6 +125,7 @@ private SessionConfig createSessionsConfig() {
     sessionConfig.setMetaData(testName.getMethodName());
     sessionConfig.setFilterProfanity(true);
     sessionConfig.setRemoveDisfluencies(true);
+    sessionConfig.setDeleteAfterSeconds(0);
     return sessionConfig;
   }