AISDK-207: Add Language Parameter to streaming client (#47)

revdotcom · May 18, 2022 · 09b1408 · 09b1408
1 parent 31a0c5a
commit 09b1408
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 3 deletions.
diff --git a/README.md b/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</groupId>
         <artifactId>revai-java-sdk</artifactId>
-        <version>2.1.0</version>
+        <version>2.2.0</version>
       </dependency>
 
 ## Build and install locally from source

diff --git a/examples/StreamingFromLocalFile.java b/examples/StreamingFromLocalFile.java
@@ -38,6 +38,7 @@ public static void main(String[] args) throws InterruptedException {
     sessionConfig.setDetailedPartials(false);
     sessionConfig.setStartTs(0.0);
     sessionConfig.setTranscriber("machine");
+    sessionConfig.setLanguage("en");
 
     // Initialize your client with your access token
     StreamingClient streamingClient = new StreamingClient(accessToken);

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

diff --git a/src/main/java/ai/rev/speechtotext/StreamingClient.java b/src/main/java/ai/rev/speechtotext/StreamingClient.java
@@ -214,6 +214,9 @@ private String buildURL(
       if (sessionConfig.getTranscriber() != null) {
         urlBuilder.addQueryParameter("transcriber", sessionConfig.getTranscriber());
       }
+      if (sessionConfig.getLanguage() != null) {
+        urlBuilder.addQueryParameter("language", sessionConfig.getLanguage());
+      }
     }
     return urlBuilder.build().toString()
       + "&content_type="

diff --git a/src/main/java/ai/rev/speechtotext/models/streaming/SessionConfig.java b/src/main/java/ai/rev/speechtotext/models/streaming/SessionConfig.java
@@ -11,6 +11,7 @@ public class SessionConfig {
   private Boolean detailedPartials;
   private Double startTs;
   private String transcriber;
+  private String language;
 
   /**
    * Returns the metadata.
@@ -159,4 +160,18 @@ public void setDetailedPartials(Boolean detailedPartials) {
    * @param transcriber The type of transcriber to use to transcribe the media.
    */
   public void setTranscriber(String transcriber) { this.transcriber = transcriber; }
+
+  /**
+   * Returns the value of language.
+   *
+   * @return The language value.
+   */
+  public String getLanguage() { return language; }
+
+  /**
+   * Specifies the language to use for the streaming job.
+   *
+   * @param language The language to use for the streaming job.
+   */
+  public void setLanguage(String language) { this.language = language; }
 }
diff --git a/src/test/java/ai/rev/speechtotext/integration/StreamingTest.java b/src/test/java/ai/rev/speechtotext/integration/StreamingTest.java
@@ -133,6 +133,7 @@ private SessionConfig createSessionsConfig() {
     sessionConfig.setDetailedPartials(true);
     sessionConfig.setStartTs(10.0);
     sessionConfig.setTranscriber("machine");
+    sessionConfig.setLanguage("en");
     return sessionConfig;
   }
 

diff --git a/src/test/java/ai/rev/speechtotext/unit/RevAiStreamingClientOptionalParametersTest.java b/src/test/java/ai/rev/speechtotext/unit/RevAiStreamingClientOptionalParametersTest.java
@@ -29,6 +29,7 @@ public class RevAiStreamingClientOptionalParametersTest {
   private static final String METADATA = "Best Metadata";
   private static final String FAKE_ACCESS_TOKEN = "foo";
   private static final String TRANSCRIBER = "machine";
+  private static final String LANGUAGE = "en";
 
   private MockWebServer mockWebServer;
   private StreamContentType defaultContentType;
@@ -65,6 +66,11 @@ public static String[] transcriberAndNull() {
     return new String[] {TRANSCRIBER, null};
   }
 
+  @DataPoints("languageAndNull")
+  public static String[] languageAndNull() {
+    return new String[] {LANGUAGE, null};
+  }
+
   public RevAiStreamingClientOptionalParametersTest() {
     this.defaultContentType = new StreamContentType();
     defaultContentType.setContentType("audio/x-raw");
@@ -107,7 +113,8 @@ public void StreamingClient_GivenOptionalParameterSet_ContainsNonNullParametersI
       @FromDataPoints("deleteAfterSecondsAndNull") Integer deleteAfterSeconds,
       @FromDataPoints("booleanValuesAndNull") Boolean detailedPartials,
       @FromDataPoints("startTsAndNull") Double startTs,
-      @FromDataPoints("transcriberAndNull") String transcriber)
+      @FromDataPoints("transcriberAndNull") String transcriber,
+      @FromDataPoints("languageAndNull") String language)
       throws UnsupportedEncodingException {
     sessionConfig.setMetaData(metadata);
     sessionConfig.setFilterProfanity(filterProfanity);
@@ -117,6 +124,7 @@ public void StreamingClient_GivenOptionalParameterSet_ContainsNonNullParametersI
     sessionConfig.setDetailedPartials(detailedPartials);
     sessionConfig.setStartTs(startTs);
     sessionConfig.setTranscriber(transcriber);
+    sessionConfig.setLanguage(language);
 
     streamingClient.connect(
         Mockito.mock(RevAiWebSocketListener.class), defaultContentType, sessionConfig);
@@ -167,6 +175,10 @@ private void assertStreamOptions(RecordedRequest request) throws UnsupportedEnco
       assertThat(request.getPath())
         .contains("transcriber=" + sessionConfig.getTranscriber());
     }
+    if (sessionConfig.getLanguage() != null) {
+      assertThat(request.getPath())
+        .contains("language=" + sessionConfig.getLanguage());
+    }
     assertThat(request.getPath()).contains("access_token=" + FAKE_ACCESS_TOKEN);
   }
 }