AISDK-161: Add support for detailed_partials (#32)

Author: Kevin Weng

examples/StreamingFromLocalFile.java

@@ -35,6 +35,7 @@ public static void main(String[] args) throws InterruptedException {
     sessionConfig.setFilterProfanity(true);
     sessionConfig.setRemoveDisfluencies(true);
     sessionConfig.setDeleteAfterSeconds(2592000); // 30 days in seconds
+    sessionConfig.setDetailedPartials(false);
     sessionConfig.setStartTs(0.0);
     sessionConfig.setTranscriber("machine");
 

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

@@ -202,6 +202,10 @@ private String buildURL(
         urlBuilder.addQueryParameter(
           "delete_after_seconds", String.valueOf(sessionConfig.getDeleteAfterSeconds()));
       }
+      if (sessionConfig.getDetailedPartials() != null) {
+        urlBuilder.addQueryParameter(
+          "detailed_partials", String.valueOf(sessionConfig.getDetailedPartials()));
+      }
       if (sessionConfig.getStartTs() != null) {
         urlBuilder.addQueryParameter("start_ts", String.valueOf(sessionConfig.getStartTs()));
       }

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

@@ -8,6 +8,7 @@ public class SessionConfig {
   private String customVocabularyId;
   private Boolean removeDisfluencies;
   private Integer deleteAfterSeconds;
+  private Boolean detailedPartials;
   private Double startTs;
   private String transcriber;
 
@@ -83,8 +84,9 @@ public Boolean getRemoveDisfluencies() {
    * the option to remove disfluencies is optional.
    *
    * @param removeDisfluencies The option to filter profanity.
-   * @see <a
-   *     href="https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Remove-Disfluencies-(Beta)">https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Remove-Disfluencies-(Beta)</a>
+   * @see <a href="https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Remove-Disfluencies">
+   *        https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Remove-Disfluencies
+   *      </a>
    */
   public void setRemoveDisfluencies(Boolean removeDisfluencies) {
     this.removeDisfluencies = removeDisfluencies;
@@ -109,6 +111,27 @@ public void setDeleteAfterSeconds(Integer deleteAfterSeconds) {
     this.deleteAfterSeconds = deleteAfterSeconds;
   }
 
+  /**
+   * Returns the value of detailed partials option
+   *
+   * @return The value of the detailed partials option.
+   */
+  public Boolean getDetailedPartials() {
+    return detailedPartials;
+  }
+
+  /**
+   * Specifies whether or not to return detailed partials. Setting the option is optional.
+   *
+   * @param detailedPartials The option to enable detailed partials.
+   * @see <a href="https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Detailed-Partials">
+   *        https://www.rev.ai/docs/streaming#section/WebSocket-Endpoint/Detailed-Partials
+   *      </a>
+   */
+  public void setDetailedPartials(Boolean detailedPartials) {
+    this.detailedPartials = detailedPartials;
+  }
+
   /**
    * Returns the value of startTs.
    *

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

@@ -84,6 +84,9 @@ private void assertPartialHypotheses(List<Hypothesis> partialHypotheses) {
           for (Element element : elements) {
             assertThat(element.getType()).as("Element type in partial").isEqualTo("text");
             assertThat(element.getValue()).as("Element value").isNotNull();
+            assertThat(element.getStartTimestamp()).as("Element time stamp").isNotNull();
+            assertThat(element.getEndTimestamp()).as("Element end time stamp").isNotNull();
+            assertThat(element.getConfidence()).as("Element confidence score").isNotNull();
           }
         });
   }
@@ -126,6 +129,7 @@ private SessionConfig createSessionsConfig() {
     sessionConfig.setFilterProfanity(true);
     sessionConfig.setRemoveDisfluencies(true);
     sessionConfig.setDeleteAfterSeconds(0);
+    sessionConfig.setDetailedPartials(true);
     sessionConfig.setStartTs(10.0);
     sessionConfig.setTranscriber("machine");
     return sessionConfig;

src/test/java/ai/rev/speechtotext/unit/RevAiStreamingClientOptionalParametersTest.java

@@ -105,6 +105,7 @@ public void StreamingClient_GivenOptionalParameterSet_ContainsNonNullParametersI
       @FromDataPoints("booleanValuesAndNull") Boolean filterProfanity,
       @FromDataPoints("booleanValuesAndNull") Boolean removeDisfluencies,
       @FromDataPoints("deleteAfterSecondsAndNull") Integer deleteAfterSeconds,
+      @FromDataPoints("booleanValuesAndNull") Boolean detailedPartials,
       @FromDataPoints("startTsAndNull") Double startTs,
       @FromDataPoints("transcriberAndNull") String transcriber)
       throws UnsupportedEncodingException {
@@ -113,6 +114,7 @@ public void StreamingClient_GivenOptionalParameterSet_ContainsNonNullParametersI
     sessionConfig.setCustomVocabularyId(customVocabularyId);
     sessionConfig.setRemoveDisfluencies(removeDisfluencies);
     sessionConfig.setDeleteAfterSeconds(deleteAfterSeconds);
+    sessionConfig.setDetailedPartials(detailedPartials);
     sessionConfig.setStartTs(startTs);
     sessionConfig.setTranscriber(transcriber);
 
@@ -153,6 +155,10 @@ private void assertStreamOptions(RecordedRequest request) throws UnsupportedEnco
       assertThat(request.getPath())
         .contains("delete_after_seconds=" + sessionConfig.getDeleteAfterSeconds());
     }
+    if (sessionConfig.getDetailedPartials() != null) {
+      assertThat(request.getPath())
+        .contains("detailed_partials=" + sessionConfig.getDetailedPartials());
+    }
     if (sessionConfig.getStartTs() != null) {
       assertThat(request.getPath())
         .contains("start_ts=" + sessionConfig.getStartTs());