CLI and error messages

Author: ianardee

src/main/java/com/mindee/MindeeException.java

@@ -5,11 +5,11 @@
  */
 public class MindeeException extends RuntimeException {
 
-  public MindeeException(String errorMessage, Throwable err) {
-    super(errorMessage, err);
+  public MindeeException(String message, Throwable cause) {
+    super(message, cause);
   }
 
-  public MindeeException(String errorMessage) {
-    super(errorMessage);
+  public MindeeException(String message) {
+    super(message);
   }
 }

src/main/java/com/mindee/v2/MindeeClient.java

@@ -280,9 +280,9 @@ private <TResponse extends CommonResponse> TResponse pollAndFetch(
       attempts++;
     }
 
-    ErrorResponse error = resp.getJob().getError();
-    if (error != null) {
-      throw new MindeeHttpExceptionV2(error.getStatus(), error.getDetail());
+    ErrorResponse errorResponse = resp.getJob().getError();
+    if (errorResponse != null) {
+      throw new MindeeHttpExceptionV2(errorResponse);
     }
     throw new RuntimeException("Max retries exceeded (" + max + ").");
   }

src/main/java/com/mindee/v2/cli/BaseCommand.java

@@ -7,11 +7,15 @@
 import picocli.CommandLine;
 
 /**
- * Abstract base class for V2 inference CLI commands.
- * Handles common options (path, model-id, api-key, alias, output) and output formatting.
+ * Abstract base class for all V2 CLI commands.
+ * Handles common options and output formatting.
  */
 public abstract class BaseCommand implements Callable<Integer> {
-  @CommandLine.Option(names = { "-k", "--api-key" }, description = "Mindee V2 API key.")
+  @CommandLine.Option(
+      names = { "-k", "--api-key" },
+      description = "Mindee V2 API key.",
+      defaultValue = ""
+  )
   protected String apiKey;
 
   /** Output format for the command. */
@@ -24,8 +28,8 @@ public enum OutputType {
   @CommandLine.Option(
       names = { "-o", "--output" },
       description = "Specify how to output the data.\n"
-        + "- summary: a basic summary (default)\n"
-        + "- full: detail extraction results, including options\n"
+        + "- summary: basic formatted response (default)\n"
+        + "- full: complete formatted response\n"
         + "- raw: full JSON object",
       defaultValue = "summary"
   )
@@ -38,7 +42,7 @@ public enum OutputType {
    * @param response the response
    * @return the summary string
    */
-  protected abstract String getSummary(CommonResponse response);
+  protected abstract String getSummaryOutput(CommonResponse response);
 
   /**
    * Returns the full string for the given response.
@@ -62,7 +66,7 @@ protected void printOutput(CommonResponse response) throws Exception {
         System.out.println(mapper.writeValueAsString(jsonNode));
         break;
       default:
-        System.out.println(getSummary(response));
+        System.out.println(getSummaryOutput(response));
         break;
     }
   }

src/main/java/com/mindee/v2/cli/BaseInferenceCommand.java

@@ -20,7 +20,10 @@ public abstract class BaseInferenceCommand extends BaseCommand {
   @Option(names = { "-m", "--model-id" }, description = "ID of the model to use", required = true)
   protected String modelId;
 
-  @Option(names = { "-a", "--alias" }, description = "Alias for the file")
+  @Option(
+      names = { "-a", "--alias" },
+      description = "A free-form string to tag the request with your own identifier."
+  )
   protected String alias;
 
   @Option(
@@ -51,7 +54,7 @@ protected abstract CommonResponse executeRequest(
 
   @Override
   public Integer call() throws Exception {
-    var client = new MindeeClient(String.valueOf(apiKey));
+    var client = new MindeeClient(apiKey);
     var inputSource = new LocalInputSource(file);
     var response = executeRequest(client, inputSource);
     printOutput(response);

src/main/java/com/mindee/v2/cli/ClassificationCommand.java

@@ -8,11 +8,11 @@
 import picocli.CommandLine.Command;
 
 /**
- * CLI command for the V2 classification utility.
+ * CLI command for the V2 classification product.
  */
 @Command(
     name = "classification",
-    description = "Classification utility.",
+    description = "Classification product.",
     mixinStandardHelpOptions = true
 )
 public class ClassificationCommand extends BaseInferenceCommand {
@@ -31,7 +31,7 @@ protected CommonResponse executeRequest(
   }
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((ClassificationResponse) response).getInference().getResult().toString();
   }
 

src/main/java/com/mindee/v2/cli/CropCommand.java

@@ -8,9 +8,9 @@
 import picocli.CommandLine.Command;
 
 /**
- * CLI command for the V2 crop utility.
+ * CLI command for the V2 crop product.
  */
-@Command(name = "crop", description = "Crop utility.", mixinStandardHelpOptions = true)
+@Command(name = "crop", description = "Crop product.", mixinStandardHelpOptions = true)
 public class CropCommand extends BaseInferenceCommand {
 
   @Override
@@ -27,7 +27,7 @@ protected CommonResponse executeRequest(
   }
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((CropResponse) response).getInference().getResult().toString();
   }
 

src/main/java/com/mindee/v2/cli/ExtractionCommand.java

@@ -11,18 +11,14 @@
 import picocli.CommandLine.Option;
 
 /**
- * CLI command for the V2 generic all-purpose extraction utility.
+ * CLI command for the V2 extraction product.
  */
-@Command(
-    name = "extraction",
-    description = "Generic all-purpose extraction.",
-    mixinStandardHelpOptions = true
-)
+@Command(name = "extraction", description = "Extraction product.", mixinStandardHelpOptions = true)
 public class ExtractionCommand extends BaseInferenceCommand {
 
   @Option(
       names = { "-g", "--rag" },
-      description = "Enable RAG context. Only valid for 'extraction' product.",
+      description = "Enable RAG context. False by default.",
       defaultValue = "false"
   )
   private boolean rag;
@@ -77,7 +73,7 @@ protected CommonResponse executeRequest(
   }
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((ExtractionResponse) response).getInference().getResult().toString();
   }
 

src/main/java/com/mindee/v2/cli/OcrCommand.java

@@ -8,9 +8,9 @@
 import picocli.CommandLine.Command;
 
 /**
- * CLI command for the V2 OCR utility.
+ * CLI command for the V2 OCR product.
  */
-@Command(name = "ocr", description = "OCR utility.", mixinStandardHelpOptions = true)
+@Command(name = "ocr", description = "OCR product.", mixinStandardHelpOptions = true)
 public class OcrCommand extends BaseInferenceCommand {
 
   @Override
@@ -27,7 +27,7 @@ protected CommonResponse executeRequest(
   }
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((OcrResponse) response).getInference().getResult().toString();
   }
 

src/main/java/com/mindee/v2/cli/SearchModelsCommand.java

@@ -39,18 +39,22 @@ public enum ModelType {
 
   @Override
   public Integer call() throws Exception {
-    var client = new MindeeClient(String.valueOf(apiKey));
+    var client = new MindeeClient(apiKey);
     var response = client
       .search(
         ModelSearchResponse.class,
-        ModelSearchParameters.builder().name(name).modelType(String.valueOf(modelType)).build()
+        ModelSearchParameters
+          .builder()
+          .name(name)
+          .modelType(modelType != null ? modelType.name() : null)
+          .build()
       );
     printOutput(response);
     return 0;
   }
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((ModelSearchResponse) response).getModels().toString();
   }
 

src/main/java/com/mindee/v2/cli/SearchRagDocumentsCommand.java

@@ -27,7 +27,7 @@ public class SearchRagDocumentsCommand extends BaseCommand {
   private String filename;
 
   @Override
-  protected String getSummary(CommonResponse response) {
+  protected String getSummaryOutput(CommonResponse response) {
     return ((RagDocumentSearchResponse) response).getRagDocuments().toString();
   }
 
@@ -38,11 +38,14 @@ protected String getFullOutput(CommonResponse response) {
 
   @Override
   public Integer call() throws Exception {
-    var client = new MindeeClient(String.valueOf(apiKey));
+    var client = new MindeeClient(apiKey);
     var response = client
       .search(
         RagDocumentSearchResponse.class,
-        RagDocumentSearchParameters.builder(modelId).filename(filename).build()
+        RagDocumentSearchParameters
+          .builder(modelId)
+          .filename(filename != null ? filename : null)
+          .build()
       );
     printOutput(response);
     return 0;