AISDK-190 Update sdks to support notification_config and source_config (#42)

Author: aaron-wilson-rev

README.md

@@ -11,15 +11,15 @@ See the [API docs](https://docs.rev.ai) for more information about the API.
 The recommended way to use the Rev AI Java SDK is to import it into the project using Maven.
 
       <dependency>
-        <groupId>ai.rev.speechtotext</groupId>
-        <artifactId>revai-java-sdk-speechtotext</artifactId>
-        <version>1.4.0</version>
+        <groupId>ai.rev</groupId>
+        <artifactId>revai-java-sdk</artifactId>
+        <version>2.1.0</version>
       </dependency>
 
 ## Build and install locally from source
 Once you've cloned the repo you can use Maven to build it locally and install it in your local Maven .m2 repository.
 
-    mvn install -Dmaven.test.skip=true
+    mvn install -DskipTests=true      
 
 ## Support
 
@@ -95,9 +95,14 @@ RevAiJob revAiJob = apiClient.submitJobUrl(urlLinkToFile, options);
 
 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`, `remove_disfluencies`, `delete_after_seconds` and `language` as optional parameters, these are described in the request body of
-the [Submit Job](https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob) endpoint.
+In RevAiJobOptions, you could include `metadata`,`notification_config`,
+`skip_diarization`, `skip_punctuation`, `speaker_channels_count`,`custom_vocabularies`,
+`filter_profanity`, `remove_disfluencies`, `delete_after_seconds`, and `language` as optional parameters.
+
+The url submission option also supports authentication headers by using the `source_config` option.
+
+All options are described in the request body of the
+[Submit Job](https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob) endpoint.
 
 ### Checking your job's status
 

examples/AsyncTranscribeLocalMediaFile.java

@@ -1,5 +1,6 @@
 package ai.rev;
 
+import ai.rev.speechtotext.ApiClient;
 import ai.rev.speechtotext.models.asynchronous.RevAiCaptionType;
 import ai.rev.speechtotext.models.asynchronous.RevAiJob;
 import ai.rev.speechtotext.models.asynchronous.RevAiJobOptions;
@@ -28,7 +29,7 @@ public static void main(String[] args) {
     RevAiJobOptions revAiJobOptions = new RevAiJobOptions();
     revAiJobOptions.setCustomVocabularies(Arrays.asList(customVocabulary));
     revAiJobOptions.setMetadata("My first submission");
-    revAiJobOptions.setCallbackUrl("https://example.com");
+    revAiJobOptions.setNotificationConfig("https://example.com");
     revAiJobOptions.setSkipPunctuation(false);
     revAiJobOptions.setSkipDiarization(false);
     revAiJobOptions.setFilterProfanity(true);

examples/AsyncTranscribeMediaUrl.java

@@ -1,5 +1,6 @@
 package ai.rev;
 
+import ai.rev.speechtotext.ApiClient;
 import ai.rev.speechtotext.models.asynchronous.RevAiCaptionType;
 import ai.rev.speechtotext.models.asynchronous.RevAiJob;
 import ai.rev.speechtotext.models.asynchronous.RevAiJobOptions;
@@ -10,6 +11,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
 
 public class AsyncTranscribeMediaUrl {
 
@@ -24,11 +27,24 @@ public static void main(String[] args) {
     CustomVocabulary customVocabulary =
         new CustomVocabulary(Arrays.asList("Robert Berwick", "Noam Chomsky", "Evelina Fedorenko"));
 
+    // Set up source configuration parameters
+    String mediaUrl = "https://www.rev.ai/FTC_Sample_1.mp3";
+    // Authorization header is optional; use it if needed to access the source media url
+    Map<String, String> sourceAuth = new HashMap<>();
+    sourceAuth.put("Authorization", "Bearer <source_token>");
+
+    // Set up notification configuration parameters
+    String callbackUrl = "https://example.com";
+    // Authorization header is optional; use it if needed to access the callback url
+    Map<String, String> notificationAuth = new HashMap<>();
+    notificationAuth.put("Authorization", "Bearer <notification_token>");
+
     // Initialize the RevAiJobOptions object and assign
     RevAiJobOptions revAiJobOptions = new RevAiJobOptions();
+    revAiJobOptions.setSourceConfig(mediaUrl, sourceAuth);
     revAiJobOptions.setCustomVocabularies(Arrays.asList(customVocabulary));
     revAiJobOptions.setMetadata("My first submission");
-    revAiJobOptions.setCallbackUrl("https://example.com");
+    revAiJobOptions.setNotificationConfig(callbackUrl, notificationAuth);
     revAiJobOptions.setSkipPunctuation(false);
     revAiJobOptions.setSkipDiarization(false);
     revAiJobOptions.setFilterProfanity(true);
@@ -40,11 +56,9 @@ public static void main(String[] args) {
 
     RevAiJob submittedJob;
 
-    String mediaUrl = "https://www.rev.ai/FTC_Sample_1.mp3";
-
     try {
-      // Submit the local file and transcription options
-      submittedJob = apiClient.submitJobUrl(mediaUrl, revAiJobOptions);
+      // Submit job with transcription options
+      submittedJob = apiClient.submitJobUrl(revAiJobOptions);
     } catch (IOException e) {
       throw new RuntimeException("Failed to submit url [" + mediaUrl + "] " + e.getMessage());
     }

examples/CustomVocabularies.java

@@ -1,12 +1,13 @@
-package ai.rev;
-
+import ai.rev.speechtotext.CustomVocabulariesClient;
 import ai.rev.speechtotext.models.vocabulary.CustomVocabulary;
 import ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation;
 import ai.rev.speechtotext.models.vocabulary.CustomVocabularyStatus;
 import ai.rev.speechtotext.models.vocabulary.CustomVocabularySubmission;
 
 import java.io.IOException;
 import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
 
 public class CustomVocabularies {
 
@@ -21,16 +22,21 @@ public static void main(String[] args) {
     CustomVocabulary customVocabulary =
         new CustomVocabulary(Arrays.asList("Robert Berwick", "Noam Chomsky", "Evelina Fedorenko"));
 
+    // Set up the notification url if desired
+    String notificationUrl = "https://example.com";
+    // Authorization header is optional; use it if needed to access the callback notification url
+    Map<String, String> notificationAuth = new HashMap<>();
+    notificationAuth.put("Authorization", "Bearer <callback_token>");
+
     CustomVocabularySubmission customVocabularySubmission = new CustomVocabularySubmission();
     customVocabularySubmission.setCustomVocabularies(Arrays.asList(customVocabulary));
-    customVocabularySubmission.setCallbackUrl("https://example.com");
+    customVocabularySubmission.setNotificationConfig(notificationUrl, notificationAuth);
     customVocabularySubmission.setMetadata("My first submission");
 
     CustomVocabularyInformation submittedCustomVocabularyInfo;
 
     try {
-      submittedCustomVocabularyInfo =
-          customVocabulariesClient.submitCustomVocabularies(customVocabularySubmission);
+      submittedCustomVocabularyInfo = customVocabulariesClient.submitCustomVocabularies(customVocabularySubmission);
     } catch (IOException e) {
       throw new RuntimeException("Failed to submit custom vocabulary " + e.getMessage());
     }
@@ -48,11 +54,9 @@ public static void main(String[] args) {
         retrievedVocabularyInfo =
             customVocabulariesClient.getCustomVocabularyInformation(customVocabularyId);
       } catch (IOException e) {
-        throw new RuntimeException(
-            "Failed to retrieve custom vocabulary info ["
-                + customVocabularyId
-                + "] "
-                + e.getMessage());
+        String message = String.format("Failed to retrieve custom vocabulary info [{0}] {1}", customVocabularyId,
+            e.getMessage());
+        throw new RuntimeException(message);
       }
 
       CustomVocabularyStatus retrievedVocabularyInfoStatus = retrievedVocabularyInfo.getStatus();

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>ai.rev</groupId>
     <artifactId>revai-java-sdk</artifactId>
-    <version>2.0.0</version>
+    <version>2.1.0</version>
     <name>Rev AI SDK for Java</name>
     <description>Java SDK for Rev AI API</description>
     <url>https://docs.rev.ai/</url>

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

@@ -182,9 +182,10 @@ public String getTranscriptText(String id) throws IOException {
   }
 
   /**
-   * The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe
+   * 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.
    *
+   * @deprecated Use submitJobUrl with the sourceConfig job option rather than a separate mediaUrl argument
    * @param mediaUrl A direct download link to the media.
    * @param options The transcription options associated with this job.
    * @return RevAiJob A representation of the transcription job.
@@ -194,6 +195,7 @@ public String getTranscriptText(String id) throws IOException {
    * @see <a
    *     href="https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob">https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob</a>
    */
+  @Deprecated
   public RevAiJob submitJobUrl(String mediaUrl, RevAiJobOptions options) throws IOException {
     if (mediaUrl == null) {
       throw new IllegalArgumentException("Media url must be provided");
@@ -216,7 +218,24 @@ public RevAiJob submitJobUrl(String mediaUrl, RevAiJobOptions options) throws IO
    * @see ApiClient#submitJobUrl(String, RevAiJobOptions)
    */
   public RevAiJob submitJobUrl(String mediaUrl) throws IOException {
-    return submitJobUrl(mediaUrl, null);
+    RevAiJobOptions options = new RevAiJobOptions();
+    options.setSourceConfig(mediaUrl);
+    return submitJobUrl(options);
+  }
+
+  /**
+   * 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.
+   *
+   * @param options The transcription options associated with this job.
+   * @return RevAiJob A representation of the transcription job.
+   * @throws IOException If the response has a status code > 399.
+   * @see RevAiJob
+   * @see <a
+   *     href="https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob">https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob</a>
+   */
+  public RevAiJob submitJobUrl(RevAiJobOptions options) throws IOException {
+    return apiInterface.submitJobUrl(options).execute().body();
   }
 
   /**

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

@@ -41,8 +41,7 @@ public CustomVocabulariesClient(String accessToken) {
    * CustomVocabularyInformation} object that provides details about the custom vocabulary
    * submission and its progress.
    *
-   * @param submission An object that contains the custom vocabularies as well as optional metadata
-   *     and callback url
+   * @param submission An object that contains the custom vocabularies and optional parameters
    * @return A {@link CustomVocabularyInformation} object.
    * @throws IOException If the response has a status code > 399.
    * @throws IllegalArgumentException If the list of custom vocabularies is null or empty.

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

@@ -0,0 +1,45 @@
+package ai.rev.speechtotext.models;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.util.Map;
+
+public class CustomerUrlData {
+  /**
+   * Customer provided url
+   */
+  @SerializedName("url")
+  private String url;
+
+  /**
+   * Authentication headers to access the url
+   * Only authorization is currently supported
+   * Example:
+   * Map<String, String> authHeaders = new HashMap<>();
+   * authHeaders.put("Authorization", "Bearer <token>");
+   * "
+   */
+  @SerializedName("auth_headers")
+  private Map<String, String> authHeaders;
+
+  public CustomerUrlData(String url, Map<String, String> authHeaders) {
+    this.url = url;
+    this.authHeaders = authHeaders;
+  }
+
+  public void setUrl(String url) {
+    this.url = url;
+  }
+
+  public void setAuthHeaders(Map<String, String> authHeaders) {
+    this.authHeaders = authHeaders;
+  }
+
+  public String getUrl() {
+    return url;
+  }
+
+  public Map<String, String> getAuthHeaders() {
+    return authHeaders;
+  }
+}