rename InferenceOptions -> InferenceParameters

Author: sebastianMindee

docs/code_samples/default_v2.txt

@@ -1,5 +1,5 @@
 import com.mindee.MindeeClientV2;
-import com.mindee.InferenceOptions;
+import com.mindee.InferenceParameters;
 import com.mindee.input.LocalInputSource;
 import com.mindee.parsing.v2.InferenceResponse;
 import java.io.File;
@@ -20,7 +20,7 @@ public class SimpleMindeeClient {
 
     // Prepare the enqueueing options
     // Note: modelId is mandatory.
-    InferenceOptions options = InferenceOptions.builder(modelId).build();
+    InferenceParameters options = InferenceParameters.builder(modelId).build();
 
     // Parse the file
     InferenceResponse response =  mindeeClient.enqueueAndParse(

…in/java/com/mindee/InferenceOptions.java …java/com/mindee/InferenceParameters.javasrc/main/java/com/mindee/InferenceOptions.java renamed to src/main/java/com/mindee/InferenceParameters.java src/main/java/com/mindee/InferenceOptions.java renamed to src/main/java/com/mindee/InferenceParameters.java

@@ -12,7 +12,7 @@
  */
 @Getter
 @Data
-public final class InferenceOptions {
+public final class InferenceParameters {
   /**
    * ID of the model (required).
    */
@@ -49,7 +49,7 @@ public static Builder builder(String modelId) {
   }
 
   /**
-   * Fluent builder for {@link InferenceOptions}.
+   * Fluent builder for {@link InferenceParameters}.
    */
   public static final class Builder {
 
@@ -92,9 +92,9 @@ public Builder pollingOptions(AsyncPollingOptions pollingOptions) {
       return this;
     }
 
-    /** Build an immutable {@link InferenceOptions} instance. */
-    public InferenceOptions build() {
-      return new InferenceOptions(
+    /** Build an immutable {@link InferenceParameters} instance. */
+    public InferenceParameters build() {
+      return new InferenceParameters(
           modelId,
           rag,
           alias,

src/main/java/com/mindee/MindeeClientV2.java

@@ -44,14 +44,14 @@ public MindeeClientV2(PdfOperation pdfOperation, MindeeApiV2 mindeeApi) {
    */
   public JobResponse enqueue(
       LocalInputSource inputSource,
-      InferenceOptions options) throws IOException {
+      InferenceParameters params) throws IOException {
     LocalInputSource finalInput;
-    if (options.getPageOptions() != null) {
-      finalInput = new LocalInputSource(getSplitFile(inputSource, options.getPageOptions()), inputSource.getFilename());
+    if (params.getPageOptions() != null) {
+      finalInput = new LocalInputSource(getSplitFile(inputSource, params.getPageOptions()), inputSource.getFilename());
     } else {
       finalInput = inputSource;
     }
-    return mindeeApi.enqueuePost(finalInput, options);
+    return mindeeApi.enqueuePost(finalInput, params);
   }
 
   /**
@@ -78,7 +78,7 @@ public CommonResponse parseQueued(String jobId) {
    */
   public InferenceResponse enqueueAndParse(
       LocalInputSource inputSource,
-      InferenceOptions options) throws IOException, InterruptedException {
+      InferenceParameters options) throws IOException, InterruptedException {
 
     validatePollingOptions(options.getPollingOptions());
 

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

@@ -1,8 +1,7 @@
 package com.mindee.http;
 
-import com.mindee.InferenceOptions;
+import com.mindee.InferenceParameters;
 import com.mindee.input.LocalInputSource;
-import com.mindee.parsing.v2.CommonResponse;
 import com.mindee.parsing.v2.InferenceResponse;
 import com.mindee.parsing.v2.JobResponse;
 import java.io.IOException;
@@ -16,7 +15,7 @@ public abstract class MindeeApiV2 extends MindeeApiCommon {
    */
   public abstract JobResponse enqueuePost(
       LocalInputSource inputSource,
-      InferenceOptions options
+      InferenceParameters options
   ) throws IOException;
 
   /**

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

@@ -1,7 +1,7 @@
 package com.mindee.http;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.mindee.InferenceOptions;
+import com.mindee.InferenceParameters;
 import com.mindee.MindeeException;
 import com.mindee.MindeeSettingsV2;
 import com.mindee.input.LocalInputSource;
@@ -75,7 +75,7 @@ private MindeeHttpApiV2(
    */
   public JobResponse enqueuePost(
       LocalInputSource inputSource,
-      InferenceOptions options
+      InferenceParameters options
   ) {
     String url = this.mindeeSettings.getBaseUrl() + "/inferences/enqueue";
     HttpPost post = buildHttpPost(url, inputSource, options);
@@ -193,7 +193,7 @@ private MindeeHttpExceptionV2 getHttpError(ClassicHttpResponse response) {
 
   private HttpEntity buildHttpBody(
       LocalInputSource inputSource,
-      InferenceOptions options
+      InferenceParameters options
   ) {
     MultipartEntityBuilder builder = MultipartEntityBuilder.create();
     builder.setMode(HttpMultipartMode.EXTENDED);
@@ -228,7 +228,7 @@ private HttpEntity buildHttpBody(
   private HttpPost buildHttpPost(
       String url,
       LocalInputSource inputSource,
-      InferenceOptions options
+      InferenceParameters options
   ) {
     HttpPost post;
     try {

src/test/java/com/mindee/MindeeClientV2IT.java

@@ -40,8 +40,8 @@ void parseFile_emptyMultiPage_mustSucceed() throws IOException, InterruptedExcep
     LocalInputSource source = new LocalInputSource(
         new File("src/test/resources/file_types/pdf/multipage_cut-2.pdf"));
 
-    InferenceOptions options =
-        InferenceOptions.builder(modelId).build();
+    InferenceParameters options =
+        InferenceParameters.builder(modelId).build();
 
     InferenceResponse response = mindeeClient.enqueueAndParse(source, options);
 
@@ -64,8 +64,8 @@ void parseFile_filledSinglePage_mustSucceed() throws IOException, InterruptedExc
     LocalInputSource source = new LocalInputSource(
         new File("src/test/resources/products/financial_document/default_sample.jpg"));
 
-    InferenceOptions options =
-        InferenceOptions.builder(modelId).build();
+    InferenceParameters options =
+        InferenceParameters.builder(modelId).build();
 
     InferenceResponse response = mindeeClient.enqueueAndParse(source, options);
 
@@ -98,8 +98,8 @@ void invalidModel_mustThrowError() throws IOException {
     LocalInputSource source = new LocalInputSource(
         new File("src/test/resources/file_types/pdf/multipage_cut-2.pdf"));
 
-    InferenceOptions options =
-        InferenceOptions.builder("INVALID MODEL ID").build();
+    InferenceParameters options =
+        InferenceParameters.builder("INVALID MODEL ID").build();
 
     MindeeHttpExceptionV2 ex = assertThrows(
         MindeeHttpExceptionV2.class,

src/test/java/com/mindee/MindeeClientV2Test.java

@@ -34,7 +34,7 @@ class Enqueue {
     @DisplayName("sends exactly one HTTP call and yields a non-null response")
     void enqueue_post_async() throws IOException {
       MindeeApiV2 predictable = Mockito.mock(MindeeApiV2.class);
-      when(predictable.enqueuePost(any(LocalInputSource.class), any(InferenceOptions.class)))
+      when(predictable.enqueuePost(any(LocalInputSource.class), any(InferenceParameters.class)))
           .thenReturn(new JobResponse());
 
       MindeeClientV2 mindeeClient = makeClientWithMockedApi(predictable);
@@ -43,12 +43,12 @@ void enqueue_post_async() throws IOException {
           new LocalInputSource(new File("src/test/resources/file_types/pdf/blank_1.pdf"));
       JobResponse response = mindeeClient.enqueue(
           input,
-          InferenceOptions.builder("dummy-model-id").build()
+          InferenceParameters.builder("dummy-model-id").build()
       );
 
       assertNotNull(response, "enqueue() must return a response");
       verify(predictable, atMostOnce())
-          .enqueuePost(any(LocalInputSource.class), any(InferenceOptions.class));
+          .enqueuePost(any(LocalInputSource.class), any(InferenceParameters.class));
     }
   }