- updated askWithImageFiles and askWithImageURLs APIs to use Options

- updated jacoco version

docs/src/css/custom.css

@@ -28,3 +28,13 @@
     --ifm-color-primary-lightest: #4fddbf;
     --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
 }
+
+article > header > h1 {
+    font-size: 2rem !important;
+}
+
+div > h1,
+header > h1,
+h2 > a {
+    font-size: 2rem !important;
+}

pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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">
+<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>io.github.amithkoujalgi</groupId>
@@ -203,7 +204,7 @@
                     <plugin>
                         <groupId>org.jacoco</groupId>
                         <artifactId>jacoco-maven-plugin</artifactId>
-            <version>0.8.7</version>
+                        <version>0.8.11</version>
                         <executions>
                             <execution>
                                 <goals>

src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java

@@ -372,15 +372,20 @@ public class OllamaAPI {
    * @param model the ollama model to ask the question to
    * @param prompt the prompt/question text
    * @param imageFiles the list of image files to use for the question
+   * @param options the Options object - <a
+   *     href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values">More
+   *     details on the options</a>
    * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageFiles(String model, String prompt, List<File> imageFiles)
+  public OllamaResult askWithImageFiles(
+      String model, String prompt, List<File> imageFiles, Options options)
       throws OllamaBaseException, IOException, InterruptedException {
     List<String> images = new ArrayList<>();
     for (File imageFile : imageFiles) {
       images.add(encodeFileToBase64(imageFile));
     }
     OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
+    ollamaRequestModel.setOptions(options.getOptionsMap());
     return askSync(ollamaRequestModel);
   }
 
@@ -391,15 +396,20 @@ public class OllamaAPI {
    * @param model the ollama model to ask the question to
    * @param prompt the prompt/question text
    * @param imageURLs the list of image URLs to use for the question
+   * @param options the Options object - <a
+   *     href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values">More
+   *     details on the options</a>
    * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageURLs(String model, String prompt, List<String> imageURLs)
+  public OllamaResult askWithImageURLs(
+      String model, String prompt, List<String> imageURLs, Options options)
       throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
     List<String> images = new ArrayList<>();
     for (String imageURL : imageURLs) {
       images.add(encodeByteArrayToBase64(loadImageBytesFromUrl(imageURL)));
     }
     OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
+    ollamaRequestModel.setOptions(options.getOptionsMap());
     return askSync(ollamaRequestModel);
   }
 
@@ -436,7 +446,7 @@ public class OllamaAPI {
                 HttpRequest.BodyPublishers.ofString(
                     Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)));
     HttpRequest request = requestBuilder.build();
-    logger.debug("Ask model '" + ollamaRequestModel + "' ...");
+    if (verbose) logger.info("Asking model: " + ollamaRequestModel);
     HttpResponse<InputStream> response =
         httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
     int statusCode = response.statusCode();
@@ -471,7 +481,10 @@ public class OllamaAPI {
       throw new OllamaBaseException(responseBuffer.toString());
     } else {
       long endTime = System.currentTimeMillis();
-      return new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
+      OllamaResult ollamaResult =
+          new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
+      if (verbose) logger.info("Model response: " + ollamaResult);
+      return ollamaResult;
     }
   }
 

src/test/java/io/github/amithkoujalgi/ollama4j/integrationtests/TestRealAPIs.java

@@ -4,12 +4,17 @@ import static org.junit.jupiter.api.Assertions.*;
 
 import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
 import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
 import io.github.amithkoujalgi.ollama4j.core.types.OllamaModelType;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.ConnectException;
 import java.net.URISyntaxException;
 import java.net.http.HttpConnectTimeoutException;
+import java.util.List;
+import java.util.Objects;
 import java.util.Properties;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Order;
@@ -32,10 +37,16 @@ class TestRealAPIs {
     }
   }
 
+  private File getImageFileFromClasspath(String fileName) {
+    ClassLoader classLoader = getClass().getClassLoader();
+    return new File(Objects.requireNonNull(classLoader.getResource(fileName)).getFile());
+  }
+
   @BeforeEach
   void setUp() {
     Properties properties = loadProperties();
     ollamaAPI = new OllamaAPI(properties.getProperty("ollama.api.url"));
+    ollamaAPI.setRequestTimeoutSeconds(20);
   }
 
   @Test
@@ -83,4 +94,80 @@ class TestRealAPIs {
       throw new RuntimeException(e);
     }
   }
+
+  @Test
+  @Order(3)
+  void testAskModelWithDefaultOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.ask(
+              OllamaModelType.LLAMA2,
+              "What is the capital of France? And what's France's connection with Mona Lisa?",
+              new OptionsBuilder().build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.ask(
+              OllamaModelType.LLAMA2,
+              "What is the capital of France? And what's France's connection with Mona Lisa?",
+              new OptionsBuilder().setTemperature(0.9f).build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptionsAndImageFiles() {
+    testEndpointReachability();
+    File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg");
+    try {
+      OllamaResult result =
+          ollamaAPI.askWithImageFiles(
+              OllamaModelType.LLAVA,
+              "What is in this image?",
+              List.of(imageFile),
+              new OptionsBuilder().build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptionsAndImageURLs() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.askWithImageURLs(
+              OllamaModelType.LLAVA,
+              "What is in this image?",
+              List.of(
+                  "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"),
+              new OptionsBuilder().build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+      throw new RuntimeException(e);
+    }
+  }
 }

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/TestMockedAPIs.java

@@ -118,10 +118,13 @@ class TestMockedAPIs {
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
     try {
-      when(ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList()))
+      when(ollamaAPI.askWithImageFiles(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
           .thenReturn(new OllamaResult("", 0, 200));
-      ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList());
-      verify(ollamaAPI, times(1)).askWithImageFiles(model, prompt, Collections.emptyList());
+      ollamaAPI.askWithImageFiles(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .askWithImageFiles(model, prompt, Collections.emptyList(), new OptionsBuilder().build());
     } catch (IOException | OllamaBaseException | InterruptedException e) {
       throw new RuntimeException(e);
     }
@@ -133,10 +136,13 @@ class TestMockedAPIs {
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
     try {
-      when(ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList()))
+      when(ollamaAPI.askWithImageURLs(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
           .thenReturn(new OllamaResult("", 0, 200));
-      ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList());
-      verify(ollamaAPI, times(1)).askWithImageURLs(model, prompt, Collections.emptyList());
+      ollamaAPI.askWithImageURLs(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .askWithImageURLs(model, prompt, Collections.emptyList(), new OptionsBuilder().build());
     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }

src/test/resources/test-config.properties

@@ -1 +1,2 @@
 ollama.api.url=http://192.168.29.223:11434
+ollama.model=llava