[maven-release-plugin] prepare release v1.0.36

# Conflicts:
#	pom.xml

.github/workflows/maven-publish.yml

@@ -49,6 +49,10 @@ jobs:
             ${{ runner.os }}-maven-
       - name: Build
         run: mvn -B -ntp clean install
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       - name: Publish to GitHub Packages Apache Maven
         #        if: >
         #          github.event_name != 'pull_request' &&

README.md

@@ -2,8 +2,35 @@
 
 <img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
 
-A Java library (wrapper/binding)
-for [Ollama](https://github.com/jmorganca/ollama/blob/main/docs/api.md) APIs.
+A Java library (wrapper/binding) for [Ollama](https://ollama.ai/) server.
+
+Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
+
+![GitHub stars](https://img.shields.io/github/stars/amithkoujalgi/ollama4j)
+![GitHub forks](https://img.shields.io/github/forks/amithkoujalgi/ollama4j)
+![GitHub watchers](https://img.shields.io/github/watchers/amithkoujalgi/ollama4j)
+![GitHub repo size](https://img.shields.io/github/repo-size/amithkoujalgi/ollama4j)
+![GitHub language count](https://img.shields.io/github/languages/count/amithkoujalgi/ollama4j)
+![GitHub top language](https://img.shields.io/github/languages/top/amithkoujalgi/ollama4j)
+![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=green)
+![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Famithkoujalgi%2Follama4j&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)
+
+[![codecov](https://codecov.io/gh/amithkoujalgi/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/amithkoujalgi/ollama4j)
+
+![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg)
+
+## Table of Contents
+
+- [How does it work?](#how-does-it-work)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [API Spec](#api-spec)
+- [Demo APIs](#try-out-the-apis-with-ollama-server)
+- [Development](#development)
+- [Contributions](#get-involved)
+- [References](#references)
+
+#### How does it work?
 
 ```mermaid
   flowchart LR
@@ -17,26 +44,6 @@ for [Ollama](https://github.com/jmorganca/ollama/blob/main/docs/api.md) APIs.
     end
 ```
 
-![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg)
-
-![GitHub stars](https://img.shields.io/github/stars/amithkoujalgi/ollama4j?style=social)
-![GitHub forks](https://img.shields.io/github/forks/amithkoujalgi/ollama4j?style=social)
-![GitHub watchers](https://img.shields.io/github/watchers/amithkoujalgi/ollama4j?style=social)
-![GitHub repo size](https://img.shields.io/github/repo-size/amithkoujalgi/ollama4j?style=plastic)
-![GitHub language count](https://img.shields.io/github/languages/count/amithkoujalgi/ollama4j?style=plastic)
-![GitHub top language](https://img.shields.io/github/languages/top/amithkoujalgi/ollama4j?style=plastic)
-![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=red&style=plastic)
-![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Famithkoujalgi%2Follama4j&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)
-
-## Table of Contents
-
-- [Requirements](#requirements)
-- [Installation](#installation)
-- [API Spec](#api-spec)
-- [Demo APIs](#try-out-the-apis-with-ollama-server)
-- [Development](#development)
-- [Contributions](#get-involved)
-
 #### Requirements
 
 ![Java](https://img.shields.io/badge/Java-11_+-green.svg?style=just-the-message&labelColor=gray)
@@ -76,7 +83,7 @@ Latest release:
 
 #### API Spec
 
-Find the full `Javadoc` (API specifications) [here](https://amithkoujalgi.github.io/ollama4j/).
+Find the full API specifications on the [website](https://amithkoujalgi.github.io/ollama4j/).
 
 #### Development
 
@@ -117,6 +124,7 @@ Actions CI workflow.
 - [x] Use lombok
 - [x] Update request body creation with Java objects
 - [ ] Async APIs for images
+- [ ] Add custom headers to requests
 - [ ] Add additional params for `ask` APIs such as:
     - `options`: additional model parameters for the Modelfile such as `temperature`
     - `system`: system prompt to (overrides what is defined in the Modelfile)
@@ -138,3 +146,7 @@ of contribution is much appreciated.
 
 The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/)
 project.
+
+### References
+
+- [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md)

docs/docs/apis-extras/basic-auth.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 2
+---
+
+# Set Basic Authentication
+
+This API lets you set the basic authentication for the Ollama client. This would help in scenarios where
+Ollama server would be setup behind a gateway/reverse proxy with basic auth.
+
+After configuring basic authentication, all subsequent requests will include the Basic Auth header.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.setBasicAuth("username", "password");
+    }
+}
+```

pom.xml

@@ -4,20 +4,20 @@
 
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.31</version>
+    <version>1.0.36</version>
 
-    <name>Ollama4j</name>
-    <description>Java library for interacting with Ollama API.</description>
-    <url>https://github.com/amithkoujalgi/ollama4j</url>
+  <name>Ollama4j</name>
+  <description>Java library for interacting with Ollama API.</description>
+  <url>https://github.com/amithkoujalgi/ollama4j</url>
 
-    <properties>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
-        <maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
-        <lombok.version>1.18.30</lombok.version>
-    </properties>
+  <properties>
+    <maven.compiler.source>11</maven.compiler.source>
+    <maven.compiler.target>11</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
+    <maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
+    <lombok.version>1.18.30</lombok.version>
+  </properties>
 
     <developers>
         <developer>
@@ -28,230 +28,273 @@
         </developer>
     </developers>
 
-    <licenses>
-        <license>
-            <name>MIT License</name>
-            <url>https://raw.githubusercontent.com/amithkoujalgi/ollama4j/main/LICENSE</url>
-        </license>
-    </licenses>
+  <licenses>
+    <license>
+      <name>MIT License</name>
+      <url>https://raw.githubusercontent.com/amithkoujalgi/ollama4j/main/LICENSE</url>
+    </license>
+  </licenses>
 
-    <scm>
-        <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
-        <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
-        <url>https://github.com/amithkoujalgi/ollama4j</url>
-        <tag>v1.0.31</tag>
-    </scm>
+  <scm>
+    <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
+    <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
+    <url>https://github.com/amithkoujalgi/ollama4j</url>
+    <tag>v1.0.36</tag>
+  </scm>
 
-    <build>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>3.3.0</version>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <goals>
+              <goal>jar-no-fork</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.5.0</version>
+        <executions>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <!--            <plugin>-->
+      <!--                <groupId>org.apache.maven.plugins</groupId>-->
+      <!--                <artifactId>maven-gpg-plugin</artifactId>-->
+      <!--                <version>1.5</version>-->
+      <!--                <executions>-->
+      <!--                    <execution>-->
+      <!--                        <id>sign-artifacts</id>-->
+      <!--                        <phase>verify</phase>-->
+      <!--                        <goals>-->
+      <!--                            <goal>sign</goal>-->
+      <!--                        </goals>-->
+      <!--                        <configuration>-->
+      <!--                            &lt;!&ndash; This is necessary for gpg to not try to use the pinentry programs &ndash;&gt;-->
+      <!--                            <gpgArguments>-->
+      <!--                                <arg>&#45;&#45;pinentry-mode</arg>-->
+      <!--                                <arg>loopback</arg>-->
+      <!--                            </gpgArguments>-->
+      <!--                        </configuration>-->
+      <!--                    </execution>-->
+      <!--                </executions>-->
+      <!--            </plugin>-->
+      <!-- Surefire Plugin for Unit Tests -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>${maven-surefire-plugin.version}</version>
+        <configuration>
+          <skipTests>${skipUnitTests}</skipTests>
+          <includes>
+            <include>**/unittests/*.java</include>
+          </includes>
+        </configuration>
+      </plugin>
+
+      <!-- Failsafe Plugin for Integration Tests -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-failsafe-plugin</artifactId>
+        <version>${maven-failsafe-plugin.version}</version>
+        <configuration>
+          <includes>
+            <include>**/integrationtests/*.java</include>
+          </includes>
+          <excludes>
+            <exclude>**/unittests/*.java</exclude>
+          </excludes>
+          <skipTests>${skipIntegrationTests}</skipTests>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>integration-test</goal>
+              <goal>verify</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-release-plugin</artifactId>
+        <version>3.0.1</version>
+        <configuration>
+          <!--                    <goals>install</goals>-->
+          <tagNameFormat>v@{project.version}</tagNameFormat>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <version>${lombok.version}</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.15.3</version>
+    </dependency>
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>1.4.12</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>2.0.9</version>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.10.0</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <version>4.1.0</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <distributionManagement>
+    <snapshotRepository>
+      <id>ossrh</id>
+      <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
+    </snapshotRepository>
+    <repository>
+      <id>ossrh</id>
+      <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>
+    </repository>
+  </distributionManagement>
+
+  <profiles>
+    <profile>
+      <id>unit-tests</id>
+      <properties>
+        <test.env>unit</test.env>
+        <skipUnitTests>false</skipUnitTests>
+        <skipIntegrationTests>true</skipIntegrationTests>
+      </properties>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <build>
         <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-source-plugin</artifactId>
-                <version>3.3.0</version>
-                <executions>
-                    <execution>
-                        <id>attach-sources</id>
-                        <goals>
-                            <goal>jar-no-fork</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.5.0</version>
-                <executions>
-                    <execution>
-                        <id>attach-javadocs</id>
-                        <goals>
-                            <goal>jar</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <!--            <plugin>-->
-            <!--                <groupId>org.apache.maven.plugins</groupId>-->
-            <!--                <artifactId>maven-gpg-plugin</artifactId>-->
-            <!--                <version>1.5</version>-->
-            <!--                <executions>-->
-            <!--                    <execution>-->
-            <!--                        <id>sign-artifacts</id>-->
-            <!--                        <phase>verify</phase>-->
-            <!--                        <goals>-->
-            <!--                            <goal>sign</goal>-->
-            <!--                        </goals>-->
-            <!--                        <configuration>-->
-            <!--                            &lt;!&ndash; This is necessary for gpg to not try to use the pinentry programs &ndash;&gt;-->
-            <!--                            <gpgArguments>-->
-            <!--                                <arg>&#45;&#45;pinentry-mode</arg>-->
-            <!--                                <arg>loopback</arg>-->
-            <!--                            </gpgArguments>-->
-            <!--                        </configuration>-->
-            <!--                    </execution>-->
-            <!--                </executions>-->
-            <!--            </plugin>-->
-            <!-- Surefire Plugin for Unit Tests -->
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-surefire-plugin</artifactId>
-                <version>${maven-surefire-plugin.version}</version>
-                <configuration>
-                    <skipTests>${skipUnitTests}</skipTests>
-                    <includes>
-                        <include>**/unittests/*.java</include>
-                    </includes>
-                </configuration>
-            </plugin>
-
-            <!-- Failsafe Plugin for Integration Tests -->
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-failsafe-plugin</artifactId>
-                <version>${maven-failsafe-plugin.version}</version>
-                <configuration>
-                    <includes>
-                        <include>**/integrationtests/*.java</include>
-                    </includes>
-                    <excludes>
-                        <exclude>**/unittests/*.java</exclude>
-                    </excludes>
-                    <skipTests>${skipIntegrationTests}</skipTests>
-                </configuration>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>integration-test</goal>
-                            <goal>verify</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-release-plugin</artifactId>
-                <version>3.0.1</version>
-                <configuration>
-                    <!--                    <goals>install</goals>-->
-                    <tagNameFormat>v@{project.version}</tagNameFormat>
-                </configuration>
-            </plugin>
+          <plugin>
+            <groupId>org.jacoco</groupId>
+            <artifactId>jacoco-maven-plugin</artifactId>
+            <version>0.8.7</version>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>prepare-agent</goal>
+                </goals>
+              </execution>
+              <execution>
+                <id>report</id>
+                <phase>test</phase>
+                <goals>
+                  <goal>report</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
         </plugins>
-    </build>
+      </build>
+    </profile>
+    <profile>
+      <id>integration-tests</id>
+      <properties>
+        <test.env>integration</test.env>
+        <skipUnitTests>true</skipUnitTests>
+        <skipIntegrationTests>false</skipIntegrationTests>
+      </properties>
+    </profile>
+    <profile>
+      <id>ci-cd</id>
+      <properties>
+        <test.env>unit</test.env>
+        <skipUnitTests>true</skipUnitTests>
+        <skipIntegrationTests>true</skipIntegrationTests>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-gpg-plugin</artifactId>
+            <version>3.1.0</version>
+            <executions>
+              <execution>
+                <id>sign-artifacts</id>
+                <phase>verify</phase>
+                <goals>
+                  <goal>sign</goal>
+                </goals>
+                <configuration>
+                  <!-- Prevent gpg from using pinentry programs. Fixes:
+                       gpg: signing failed: Inappropriate ioctl for device -->
+                  <gpgArguments>
+                    <arg>--pinentry-mode</arg>
+                    <arg>loopback</arg>
+                  </gpgArguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+          <plugin>
+            <groupId>org.sonatype.plugins</groupId>
+            <artifactId>nexus-staging-maven-plugin</artifactId>
+            <version>1.6.13</version>
+            <extensions>true</extensions>
+            <configuration>
+              <serverId>ossrh</serverId>
+              <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
+              <autoReleaseAfterClose>true</autoReleaseAfterClose>
+            </configuration>
+          </plugin>
 
-    <dependencies>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <version>${lombok.version}</version>
-            <scope>provided</scope>
-        </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>2.15.3</version>
-        </dependency>
-        <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <version>1.3.11</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>2.0.9</version>
-        </dependency>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-api</artifactId>
-            <version>5.10.0</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.mockito</groupId>
-            <artifactId>mockito-core</artifactId>
-            <version>4.1.0</version>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-
-    <distributionManagement>
-        <snapshotRepository>
-            <id>ossrh</id>
-            <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
-        </snapshotRepository>
-        <repository>
-            <id>ossrh</id>
-            <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>
-        </repository>
-    </distributionManagement>
-
-    <profiles>
-        <profile>
-            <id>unit-tests</id>
-            <properties>
-                <test.env>unit</test.env>
-                <skipUnitTests>false</skipUnitTests>
-                <skipIntegrationTests>true</skipIntegrationTests>
-            </properties>
-            <activation>
-                <activeByDefault>true</activeByDefault>
-            </activation>
-        </profile>
-        <profile>
-            <id>integration-tests</id>
-            <properties>
-                <test.env>integration</test.env>
-                <skipUnitTests>true</skipUnitTests>
-                <skipIntegrationTests>false</skipIntegrationTests>
-            </properties>
-        </profile>
-        <profile>
-            <id>ci-cd</id>
-            <properties>
-                <test.env>unit</test.env>
-                <skipUnitTests>true</skipUnitTests>
-                <skipIntegrationTests>true</skipIntegrationTests>
-            </properties>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-gpg-plugin</artifactId>
-                        <version>3.1.0</version>
-                        <executions>
-                            <execution>
-                                <id>sign-artifacts</id>
-                                <phase>verify</phase>
-                                <goals>
-                                    <goal>sign</goal>
-                                </goals>
-                                <configuration>
-                                    <!-- Prevent gpg from using pinentry programs. Fixes:
-                                         gpg: signing failed: Inappropriate ioctl for device -->
-                                    <gpgArguments>
-                                        <arg>--pinentry-mode</arg>
-                                        <arg>loopback</arg>
-                                    </gpgArguments>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.sonatype.plugins</groupId>
-                        <artifactId>nexus-staging-maven-plugin</artifactId>
-                        <version>1.6.13</version>
-                        <extensions>true</extensions>
-                        <configuration>
-                            <serverId>ossrh</serverId>
-                            <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
-                            <autoReleaseAfterClose>true</autoReleaseAfterClose>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-    </profiles>
+          <plugin>
+            <groupId>org.jacoco</groupId>
+            <artifactId>jacoco-maven-plugin</artifactId>
+            <version>0.8.7</version>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>prepare-agent</goal>
+                </goals>
+              </execution>
+              <execution>
+                <id>report</id>
+                <phase>test</phase>
+                <goals>
+                  <goal>report</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
 
 </project>

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

@@ -37,8 +37,7 @@ public class OllamaAPI {
   private final String host;
   private long requestTimeoutSeconds = 3;
   private boolean verbose = true;
-  private String username;
-  private String password;
+  private BasicAuth basicAuth;
 
   /**
    * Instantiates the Ollama API.
@@ -53,6 +52,11 @@ public class OllamaAPI {
     }
   }
 
+  /**
+   * Set request timeout in seconds. Default is 3 seconds.
+   *
+   * @param requestTimeoutSeconds the request timeout in seconds
+   */
   public void setRequestTimeoutSeconds(long requestTimeoutSeconds) {
     this.requestTimeoutSeconds = requestTimeoutSeconds;
   }
@@ -67,11 +71,13 @@ public class OllamaAPI {
   }
 
   /**
+   * Set basic authentication for accessing Ollama server that's behind a reverse-proxy/gateway.
    *
+   * @param username the username
+   * @param password the password
    */
   public void setBasicAuth(String username, String password) {
-    this.username = username;
-    this.password = password;
+    this.basicAuth = new BasicAuth(username, password);
   }
 
   /**
@@ -85,11 +91,9 @@ public class OllamaAPI {
     HttpRequest httpRequest = null;
     try {
       httpRequest =
-          HttpRequest.newBuilder()
-              .uri(new URI(url))
+          getRequestBuilderDefault(new URI(url))
               .header("Accept", "application/json")
               .header("Content-type", "application/json")
-              .timeout(Duration.ofSeconds(requestTimeoutSeconds))
               .GET()
               .build();
     } catch (URISyntaxException e) {
@@ -117,11 +121,9 @@ public class OllamaAPI {
     String url = this.host + "/api/tags";
     HttpClient httpClient = HttpClient.newHttpClient();
     HttpRequest httpRequest =
-        HttpRequest.newBuilder()
-            .uri(new URI(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .GET()
             .build();
     HttpResponse<String> response =
@@ -148,12 +150,10 @@ public class OllamaAPI {
     String url = this.host + "/api/pull";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(new URI(url))
+        getRequestBuilderDefault(new URI(url))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .build();
     HttpClient client = HttpClient.newHttpClient();
     HttpResponse<InputStream> response =
@@ -184,15 +184,13 @@ public class OllamaAPI {
    * @return the model details
    */
   public ModelDetail getModelDetails(String modelName)
-      throws IOException, OllamaBaseException, InterruptedException {
+      throws IOException, OllamaBaseException, InterruptedException, URISyntaxException {
     String url = this.host + "/api/show";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -214,15 +212,13 @@ public class OllamaAPI {
    * @param modelFilePath the path to model file that exists on the Ollama server.
    */
   public void createModelWithFilePath(String modelName, String modelFilePath)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/create";
     String jsonData = new CustomModelFilePathRequest(modelName, modelFilePath).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-Type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -250,15 +246,13 @@ public class OllamaAPI {
    * @param modelFileContents the path to model file that exists on the Ollama server.
    */
   public void createModelWithModelFileContents(String modelName, String modelFileContents)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/create";
     String jsonData = new CustomModelFileContentsRequest(modelName, modelFileContents).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-Type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -280,20 +274,17 @@ public class OllamaAPI {
    * Delete a model from Ollama server.
    *
    * @param modelName the name of the model to be deleted.
-   * @param ignoreIfNotPresent - ignore errors if the specified model is not present on Ollama
-   *     server.
+   * @param ignoreIfNotPresent ignore errors if the specified model is not present on Ollama server.
    */
   public void deleteModel(String modelName, boolean ignoreIfNotPresent)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/delete";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .method("DELETE", HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .build();
     HttpClient client = HttpClient.newHttpClient();
     HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
@@ -319,7 +310,8 @@ public class OllamaAPI {
     URI uri = URI.create(this.host + "/api/embeddings");
     String jsonData = new ModelEmbeddingsRequest(model, prompt).toString();
     HttpClient httpClient = HttpClient.newHttpClient();
-    HttpRequest.Builder requestBuilder = getRequestBuilderDefault(uri)
+    HttpRequest.Builder requestBuilder =
+        getRequestBuilderDefault(uri)
             .header("Accept", "application/json")
             .POST(HttpRequest.BodyPublishers.ofString(jsonData));
     HttpRequest request = requestBuilder.build();
@@ -339,12 +331,12 @@ public class OllamaAPI {
    * Ask a question to a model running on Ollama server. This is a sync/blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
-   * @return OllamaResult - that includes response text and time taken for response
+   * @param prompt the prompt/question text
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult ask(String model, String promptText)
+  public OllamaResult ask(String model, String prompt)
       throws OllamaBaseException, IOException, InterruptedException {
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt);
     return askSync(ollamaRequestModel);
   }
 
@@ -354,15 +346,16 @@ public class OllamaAPI {
    * async/non-blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @return the ollama async result callback handle
    */
-  public OllamaAsyncResultCallback askAsync(String model, String promptText) {
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
-    HttpClient httpClient = HttpClient.newHttpClient();
+  public OllamaAsyncResultCallback askAsync(String model, String prompt) {
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt);
+
     URI uri = URI.create(this.host + "/api/generate");
     OllamaAsyncResultCallback ollamaAsyncResultCallback =
-        new OllamaAsyncResultCallback(httpClient, uri, ollamaRequestModel, requestTimeoutSeconds);
+        new OllamaAsyncResultCallback(
+            getRequestBuilderDefault(uri), ollamaRequestModel, requestTimeoutSeconds);
     ollamaAsyncResultCallback.start();
     return ollamaAsyncResultCallback;
   }
@@ -372,17 +365,17 @@ public class OllamaAPI {
    * sync/blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @param imageFiles the list of image files to use for the question
-   * @return OllamaResult - that includes response text and time taken for response
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageFiles(String model, String promptText, List<File> imageFiles)
+  public OllamaResult askWithImageFiles(String model, String prompt, List<File> imageFiles)
       throws OllamaBaseException, IOException, InterruptedException {
     List<String> images = new ArrayList<>();
     for (File imageFile : imageFiles) {
       images.add(encodeFileToBase64(imageFile));
     }
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
     return askSync(ollamaRequestModel);
   }
 
@@ -391,17 +384,17 @@ public class OllamaAPI {
    * sync/blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @param imageURLs the list of image URLs to use for the question
-   * @return OllamaResult - that includes response text and time taken for response
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageURLs(String model, String promptText, List<String> imageURLs)
+  public OllamaResult askWithImageURLs(String model, String prompt, List<String> imageURLs)
       throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
     List<String> images = new ArrayList<>();
     for (String imageURL : imageURLs) {
       images.add(encodeByteArrayToBase64(loadImageBytesFromUrl(imageURL)));
     }
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
     return askSync(ollamaRequestModel);
   }
 
@@ -432,7 +425,8 @@ public class OllamaAPI {
     long startTime = System.currentTimeMillis();
     HttpClient httpClient = HttpClient.newHttpClient();
     URI uri = URI.create(this.host + "/api/generate");
-    HttpRequest.Builder requestBuilder = getRequestBuilderDefault(uri)
+    HttpRequest.Builder requestBuilder =
+        getRequestBuilderDefault(uri)
             .POST(
                 HttpRequest.BodyPublishers.ofString(
                     Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)));
@@ -455,9 +449,10 @@ public class OllamaAPI {
         } else if (statusCode == 401) {
           logger.warn("Status code: 401 (Unauthorized)");
           OllamaErrorResponseModel ollamaResponseModel =
-                  Utils.getObjectMapper().readValue("{\"error\":\"Unauthorized\"}", OllamaErrorResponseModel.class);
+              Utils.getObjectMapper()
+                  .readValue("{\"error\":\"Unauthorized\"}", OllamaErrorResponseModel.class);
           responseBuffer.append(ollamaResponseModel.getError());
-        }else {
+        } else {
           OllamaResponseModel ollamaResponseModel =
               Utils.getObjectMapper().readValue(line, OllamaResponseModel.class);
           if (!ollamaResponseModel.isDone()) {
@@ -467,7 +462,7 @@ public class OllamaAPI {
       }
     }
     if (statusCode != 200) {
-      logger.error("Status code " + statusCode + " instead 200");
+      logger.error("Status code " + statusCode);
       throw new OllamaBaseException(responseBuffer.toString());
     } else {
       long endTime = System.currentTimeMillis();
@@ -476,35 +471,38 @@ public class OllamaAPI {
   }
 
   /**
+   * Get default request builder.
    *
+   * @param uri URI to get a HttpRequest.Builder
+   * @return HttpRequest.Builder
    */
   private HttpRequest.Builder getRequestBuilderDefault(URI uri) {
     HttpRequest.Builder requestBuilder =
-            HttpRequest.newBuilder(uri)
-                    .header("Content-Type", "application/json")
-                    .timeout(Duration.ofSeconds(requestTimeoutSeconds));
-    if (basicAuthCredentialsSet()) {
+        HttpRequest.newBuilder(uri)
+            .header("Content-Type", "application/json")
+            .timeout(Duration.ofSeconds(requestTimeoutSeconds));
+    if (isBasicAuthCredentialsSet()) {
       requestBuilder.header("Authorization", getBasicAuthHeaderValue());
     }
     return requestBuilder;
   }
 
   /**
+   * Get basic authentication header value.
+   *
    * @return basic authentication header value (encoded credentials)
    */
   private String getBasicAuthHeaderValue() {
-    String credentialsToEncode = username + ":" + password;
+    String credentialsToEncode = basicAuth.getUsername() + ":" + basicAuth.getPassword();
     return "Basic " + Base64.getEncoder().encodeToString(credentialsToEncode.getBytes());
   }
 
   /**
+   * Check if Basic Auth credentials set.
+   *
    * @return true when Basic Auth credentials set
    */
-  private boolean basicAuthCredentialsSet() {
-    if (username != null && password !=  null) {
-      return true;
-    } else {
-      return false;
-    }
+  private boolean isBasicAuthCredentialsSet() {
+    return basicAuth != null;
   }
 }

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/BasicAuth.java

@@ -0,0 +1,13 @@
+package io.github.amithkoujalgi.ollama4j.core.models;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class BasicAuth {
+  private String username;
+  private String password;
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/OllamaAsyncResultCallback.java

@@ -6,7 +6,6 @@ import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
@@ -14,30 +13,44 @@ import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.LinkedList;
 import java.util.Queue;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
 
+@Data
+@EqualsAndHashCode(callSuper = true)
 @SuppressWarnings("unused")
 public class OllamaAsyncResultCallback extends Thread {
-  private final HttpClient client;
-  private final URI uri;
+  private final HttpRequest.Builder requestBuilder;
   private final OllamaRequestModel ollamaRequestModel;
   private final Queue<String> queue = new LinkedList<>();
   private String result;
   private boolean isDone;
-  private boolean succeeded;
+
+  /**
+   * -- GETTER -- Returns the status of the request. Indicates if the request was successful or a
+   * failure. If the request was a failure, the `getResponse()` method will return the error
+   * message.
+   */
+  @Getter private boolean succeeded;
 
   private long requestTimeoutSeconds;
 
-  private int httpStatusCode;
-  private long responseTime = 0;
+  /**
+   * -- GETTER -- Returns the HTTP response status code for the request that was made to Ollama
+   * server.
+   */
+  @Getter private int httpStatusCode;
+
+  /** -- GETTER -- Returns the response time in milliseconds. */
+  @Getter private long responseTime = 0;
 
   public OllamaAsyncResultCallback(
-      HttpClient client,
-      URI uri,
+      HttpRequest.Builder requestBuilder,
       OllamaRequestModel ollamaRequestModel,
       long requestTimeoutSeconds) {
-    this.client = client;
+    this.requestBuilder = requestBuilder;
     this.ollamaRequestModel = ollamaRequestModel;
-    this.uri = uri;
     this.isDone = false;
     this.result = "";
     this.queue.add("");
@@ -46,10 +59,11 @@ public class OllamaAsyncResultCallback extends Thread {
 
   @Override
   public void run() {
+    HttpClient httpClient = HttpClient.newHttpClient();
     try {
       long startTime = System.currentTimeMillis();
       HttpRequest request =
-          HttpRequest.newBuilder(uri)
+          requestBuilder
               .POST(
                   HttpRequest.BodyPublishers.ofString(
                       Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)))
@@ -57,7 +71,7 @@ public class OllamaAsyncResultCallback extends Thread {
               .timeout(Duration.ofSeconds(requestTimeoutSeconds))
               .build();
       HttpResponse<InputStream> response =
-          client.send(request, HttpResponse.BodyHandlers.ofInputStream());
+          httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
       int statusCode = response.statusCode();
       this.httpStatusCode = statusCode;
 
@@ -108,25 +122,6 @@ public class OllamaAsyncResultCallback extends Thread {
     return isDone;
   }
 
-  /**
-   * Returns the HTTP response status code for the request that was made to Ollama server.
-   *
-   * @return int - the status code for the request
-   */
-  public int getHttpStatusCode() {
-    return httpStatusCode;
-  }
-
-  /**
-   * Returns the status of the request. Indicates if the request was successful or a failure. If the
-   * request was a failure, the `getResponse()` method will return the error message.
-   *
-   * @return boolean - status
-   */
-  public boolean isSucceeded() {
-    return succeeded;
-  }
-
   /**
    * Returns the final response when the execution completes. Does not return intermediate results.
    *
@@ -140,15 +135,6 @@ public class OllamaAsyncResultCallback extends Thread {
     return queue;
   }
 
-  /**
-   * Returns the response time in milliseconds.
-   *
-   * @return long - response time in milliseconds.
-   */
-  public long getResponseTime() {
-    return responseTime;
-  }
-
   public void setRequestTimeoutSeconds(long requestTimeoutSeconds) {
     this.requestTimeoutSeconds = requestTimeoutSeconds;
   }

src/main/java/io/github/amithkoujalgi/ollama4j/core/utils/Utils.java

@@ -3,7 +3,7 @@ package io.github.amithkoujalgi.ollama4j.core.utils;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 public class Utils {
-    public static ObjectMapper getObjectMapper() {
-        return new ObjectMapper();
-    }
+  public static ObjectMapper getObjectMapper() {
+    return new ObjectMapper();
+  }
 }

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

@@ -11,12 +11,13 @@ import io.github.amithkoujalgi.ollama4j.core.types.OllamaModelType;
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.util.ArrayList;
+import java.util.Collections;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 class TestMockedAPIs {
   @Test
-  void testMockPullModel() {
+  void testPullModel() {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     try {
@@ -49,7 +50,7 @@ class TestMockedAPIs {
       doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath);
       ollamaAPI.createModelWithModelFileContents(model, modelFilePath);
       verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -62,7 +63,7 @@ class TestMockedAPIs {
       doNothing().when(ollamaAPI).deleteModel(model, true);
       ollamaAPI.deleteModel(model, true);
       verify(ollamaAPI, times(1)).deleteModel(model, true);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -75,7 +76,7 @@ class TestMockedAPIs {
       when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail());
       ollamaAPI.getModelDetails(model);
       verify(ollamaAPI, times(1)).getModelDetails(model);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -108,13 +109,43 @@ class TestMockedAPIs {
     }
   }
 
+  @Test
+  void testAskWithImageFiles() {
+    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+    String model = OllamaModelType.LLAMA2;
+    String prompt = "some prompt text";
+    try {
+      when(ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList());
+      verify(ollamaAPI, times(1)).askWithImageFiles(model, prompt, Collections.emptyList());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  void testAskWithImageURLs() {
+    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+    String model = OllamaModelType.LLAMA2;
+    String prompt = "some prompt text";
+    try {
+      when(ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList());
+      verify(ollamaAPI, times(1)).askWithImageURLs(model, prompt, Collections.emptyList());
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
   @Test
   void testAskAsync() {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
     when(ollamaAPI.askAsync(model, prompt))
-        .thenReturn(new OllamaAsyncResultCallback(null, null, null, 3));
+        .thenReturn(new OllamaAsyncResultCallback(null, null, 3));
     ollamaAPI.askAsync(model, prompt);
     verify(ollamaAPI, times(1)).askAsync(model, prompt);
   }