AISDK-191: Add topic extraction client (#43)

Author: Kyle Bridburg

examples/AsyncTranscribeLocalMediaFile.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext;
+package ai.rev;
 
 import ai.rev.speechtotext.models.asynchronous.RevAiCaptionType;
 import ai.rev.speechtotext.models.asynchronous.RevAiJob;

examples/AsyncTranscribeMediaUrl.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext;
+package ai.rev;
 
 import ai.rev.speechtotext.models.asynchronous.RevAiCaptionType;
 import ai.rev.speechtotext.models.asynchronous.RevAiJob;

examples/CustomVocabularies.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext;
+package ai.rev;
 
 import ai.rev.speechtotext.models.vocabulary.CustomVocabulary;
 import ai.rev.speechtotext.models.vocabulary.CustomVocabularyInformation;

examples/StreamingFromLocalFile.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext;
+package ai.rev;
 
 import ai.rev.speechtotext.models.streaming.ConnectedMessage;
 import ai.rev.speechtotext.models.streaming.Hypothesis;

examples/TopicExtraction.java

@@ -0,0 +1,90 @@
+package ai.rev;
+
+import ai.rev.topicextraction.models.TopicExtractionJobOptions;
+import ai.rev.topicextraction.models.TopicExtractionJob;
+import ai.rev.topicextraction.models.TopicExtractionJobStatus;
+import ai.rev.topicextraction.models.TopicExtractionResult;
+import ai.rev.topicextraction.TopicExtractionClient;
+
+import java.io.IOException;
+import java.util.Arrays;
+
+public class TopicExtraction {
+
+  public static void main(String[] args) {
+    // Assign your access token to a String
+    String accessToken = "your_access_token";
+
+    // Initialize the TopicExtractionClient with your access token
+    TopicExtractionClient topicExtractionClient = new TopicExtractionClient(accessToken);
+
+    // Create TopicExtractionJobOptions for your submission
+    TopicExtractionJobOptions jobOptions = new TopicExtractionJobOptions();
+    String textSubmission = "An orange is a fruit of various citrus species in the family Rutaceae " +
+            "it primarily refers to Citrus sinensis which is also called sweet orange, " +
+            "to distinguish it from the related Citrus aurantium, referred to as bitter orange. " +
+            "The sweet orange reproduces asexually. varieties of sweet orange arise through mutations. " +
+            "The orange is a hybrid between pomelo (Citrus maxima) and mandarin (Citrus reticulata). " +
+            "The chloroplast genome, and therefore the maternal line, is that of pomelo. " +
+            "The sweet orange has had its full genome sequenced.";
+
+
+    TopicExtractionJob submittedJob;
+    try {
+      submittedJob = topicExtractionClient.submitJobText(textSubmission, jobOptions);
+    } catch (IOException e) {
+      throw new RuntimeException("Failed to submit topic extraction job " + e.getMessage());
+    }
+
+    String jobId = submittedJob.getJobId();
+    System.out.println("Job Id: " + jobId);
+    System.out.println("Job Status: " + submittedJob.getJobStatus());
+    System.out.println("Created On: " + submittedJob.getCreatedOn());
+
+    // Waits 5 seconds between each status check to see if job is complete
+    boolean isProcessingComplete = false;
+    while (!isProcessingComplete) {
+      TopicExtractionJob retrievedJob;
+      try {
+        retrievedJob = topicExtractionClient.getJobDetails(jobId);
+      } catch (IOException e) {
+        throw new RuntimeException(
+                "Failed to retrieve topic extraction job info ["
+                        + jobId
+                        + "] "
+                        + e.getMessage());
+      }
+
+      TopicExtractionJobStatus status = retrievedJob.getJobStatus();
+      if (status == TopicExtractionJobStatus.COMPLETED
+              || status == TopicExtractionJobStatus.FAILED) {
+        System.out.println(
+                "Processing for "
+                        + jobId
+                        + ": "
+                        + status);
+        isProcessingComplete = true;
+      } else {
+        try {
+          Thread.sleep(5000);
+        } catch (InterruptedException e) {
+          e.printStackTrace();
+        }
+      }
+    }
+
+    try {
+      TopicExtractionResult result =
+              topicExtractionClient.getResultObject(jobId);
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+
+    /*
+     * The job can now be deleted. Deleting the job will remove ALL information
+     * about the job from the Rev AI servers. Subsequent requests to Rev AI that
+     * use the deleted jobs Id will return 404's.
+     */
+    // apiClient.deleteJob(jobId);
+  }
+}

pom.xml

@@ -2,11 +2,11 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-    <groupId>ai.rev.speechtotext</groupId>
-    <artifactId>revai-java-sdk-speechtotext</artifactId>
-    <version>1.4.0</version>
-    <name>Rev AI speech to text SDK for Java</name>
-    <description>Java SDK for Rev AI speech to text API</description>
+    <groupId>ai.rev</groupId>
+    <artifactId>revai-java-sdk</artifactId>
+    <version>2.0.0</version>
+    <name>Rev AI SDK for Java</name>
+    <description>Java SDK for Rev AI API</description>
     <url>https://docs.rev.ai/</url>
     <licenses>
         <license>

src/main/java/ai/rev/speechtotext/exceptions/AuthorizationException.java renamed to src/main/java/ai/rev/exceptions/AuthorizationException.java

@@ -1,10 +1,10 @@
-package ai.rev.speechtotext.exceptions;
+package ai.rev.exceptions;
 
 import org.json.JSONObject;
 
 /**
- * The AuthorizationException happens when an invalid token access is used to query the account
- * information endpoint.
+ * The AuthorizationException happens when an invalid token access is used to query any
+ * endpoint.
  */
 public class AuthorizationException extends RevAiApiException {
 

src/main/java/ai/rev/speechtotext/exceptions/ForbiddenStateException.java renamed to src/main/java/ai/rev/exceptions/ForbiddenStateException.java

@@ -1,10 +1,10 @@
-package ai.rev.speechtotext.exceptions;
+package ai.rev.exceptions;
 
 import org.json.JSONObject;
 
 /**
- * The ForbiddenStateException occurs when a user attempts to retrieve the transcript or caption of
- * a unprocessed job.
+ * The ForbiddenStateException occurs when a user attempts to retrieve the result of
+ * an unprocessed job.
  */
 public class ForbiddenStateException extends RevAiApiException {
 

src/main/java/ai/rev/speechtotext/exceptions/InvalidHeaderException.java renamed to src/main/java/ai/rev/exceptions/InvalidHeaderException.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext.exceptions;
+package ai.rev.exceptions;
 
 import org.json.JSONObject;
 

src/main/java/ai/rev/speechtotext/exceptions/InvalidParameterException.java renamed to src/main/java/ai/rev/exceptions/InvalidParameterException.java

@@ -1,4 +1,4 @@
-package ai.rev.speechtotext.exceptions;
+package ai.rev.exceptions;
 
 import org.json.JSONObject;