✨ add support for workflow polling

Author: ianardee

src/main/java/com/mindee/PredictOptions.java

@@ -24,15 +24,28 @@ public class PredictOptions {
    * size.
    */
   Boolean fullText;
+  /**
+   * If set, will enqueue to a workflow queue instead of a product's endpoint.
+   */
+  String workflowId;
+  /**
+   * If set, will enable Retrieval-Augmented Generation.
+   * Only works if a valid workflowId is set.
+   */
+  Boolean rag;
 
   @Builder
   private PredictOptions(
       Boolean allWords,
       Boolean fullText,
-      Boolean cropper
+      Boolean cropper,
+      String workflowId,
+      Boolean rag
   ) {
     this.allWords = allWords == null ? Boolean.FALSE : allWords;
     this.fullText = fullText == null ? Boolean.FALSE : fullText;
     this.cropper = cropper == null ? Boolean.FALSE : cropper;
+    this.workflowId = workflowId;
+    this.rag = rag == null ? Boolean.FALSE : rag;
   }
 }

src/main/java/com/mindee/http/MindeeHttpApi.java

@@ -41,8 +41,9 @@
 public final class MindeeHttpApi extends MindeeApi {
 
   private static final ObjectMapper mapper = new ObjectMapper();
-  private final Function<Endpoint, String> buildBaseUrl = this::buildProductUrl;
-  private final Function<String, String> buildWorkflowBaseUrl = this::buildWorkflowUrl;
+  private final Function<Endpoint, String> buildProductPredictUrl = this::buildProductPredictUrl;
+  private final Function<String, String> buildWorkflowPredictUrl = this::buildWorkflowPredictUrl;
+  private final Function<String, String> buildWorkflowBaseUrl = this::buildWorkflowExecutionUrl;
   /**
    * The MindeeSetting needed to make the api call.
    */
@@ -53,24 +54,27 @@ public final class MindeeHttpApi extends MindeeApi {
    */
   private final HttpClientBuilder httpClientBuilder;
   /**
-   * The function used to generate the API endpoint URL.
+   * The function used to generate the synchronous API endpoint URL.
    * Only needs to be set if the api calls need to be directed through internal URLs.
    */
   private final Function<Endpoint, String> urlFromEndpoint;
-
   /**
-   * The function used to generate the API endpoint URL for workflow execution calls.
+   * The function used to generate the asynchronous API endpoint URL.
    * Only needs to be set if the api calls need to be directed through internal URLs.
    */
   private final Function<Endpoint, String> asyncUrlFromEndpoint;
+  /**
+   * The function used to generate the asynchronous API endpoint URL.
+   * Only needs to be set if the api calls need to be directed through internal URLs.
+   */
+  private final Function<String, String> asyncUrlFromWorkflow;
   /**
    * The function used to generate the Job status URL for Async calls.
    * Only needs to be set if the api calls need to be directed through internal URLs.
    */
   private final Function<Endpoint, String> documentUrlFromEndpoint;
-
   /**
-   * The function used to generate the Job status URL for Async calls.
+   * The function used to generate the Job status URL for workflow execution calls.
    * Only needs to be set if the api calls need to be directed through internal URLs.
    */
   private final Function<String, String> workflowUrlFromId;
@@ -82,6 +86,7 @@ public MindeeHttpApi(MindeeSettings mindeeSettings) {
         null,
         null,
         null,
+        null,
         null
     );
   }
@@ -93,7 +98,8 @@ private MindeeHttpApi(
       Function<Endpoint, String> urlFromEndpoint,
       Function<Endpoint, String> asyncUrlFromEndpoint,
       Function<Endpoint, String> documentUrlFromEndpoint,
-      Function<String, String> workflowUrlFromEndpoint
+      Function<String, String> workflowUrlFromEndpoint,
+      Function<String, String> asyncUrlFromWorkflow
   ) {
     this.mindeeSettings = mindeeSettings;
 
@@ -106,19 +112,25 @@ private MindeeHttpApi(
     if (urlFromEndpoint != null) {
       this.urlFromEndpoint = urlFromEndpoint;
     } else {
-      this.urlFromEndpoint = buildBaseUrl.andThen((url) -> url.concat("/predict"));
+      this.urlFromEndpoint = buildProductPredictUrl.andThen((url) -> url.concat("/predict"));
+    }
+
+    if (asyncUrlFromWorkflow != null) {
+      this.asyncUrlFromWorkflow = asyncUrlFromWorkflow;
+    } else {
+      this.asyncUrlFromWorkflow = this.buildWorkflowPredictUrl.andThen((url) -> url.concat("predict_async"));
     }
 
     if (asyncUrlFromEndpoint != null) {
       this.asyncUrlFromEndpoint = asyncUrlFromEndpoint;
     } else {
-      this.asyncUrlFromEndpoint = this.urlFromEndpoint.andThen((url) -> url.concat("_async"));
+      this.asyncUrlFromEndpoint = this.buildProductPredictUrl.andThen((url) -> url.concat("predict_async"));
     }
 
     if (documentUrlFromEndpoint != null) {
       this.documentUrlFromEndpoint = documentUrlFromEndpoint;
     } else {
-      this.documentUrlFromEndpoint = this.buildBaseUrl.andThen(
+      this.documentUrlFromEndpoint = this.buildProductPredictUrl.andThen(
           (url) -> url.concat("/documents/queue/"));
     }
 
@@ -340,7 +352,7 @@ private <ResponseT extends ApiResponse> MindeeHttpException getHttpError(
     return new MindeeHttpException(statusCode, message, details, errorCode);
   }
 
-  private String buildProductUrl(Endpoint endpoint) {
+  private String buildProductPredictUrl(Endpoint endpoint) {
     return this.mindeeSettings.getBaseUrl()
         + "/products/"
         + endpoint.getAccountName()
@@ -350,7 +362,11 @@ private String buildProductUrl(Endpoint endpoint) {
         + endpoint.getVersion();
   }
 
-  private String buildWorkflowUrl(String workflowId) {
+  private String buildWorkflowPredictUrl(String workflowId) {
+    return this.mindeeSettings.getBaseUrl() + "/workflows/" + workflowId;
+  }
+
+  private String buildWorkflowExecutionUrl(String workflowId) {
     return this.mindeeSettings.getBaseUrl() + "/workflows/" + workflowId + "/executions";
   }