[maven-release-plugin] prepare for next development iteration

Update README to include gradle project set up options

.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' &&

.github/workflows/publish-docs.yml

@@ -50,6 +50,12 @@ jobs:
       - name: Build with Maven
         run: mvn --file pom.xml -U clean package && cp -r ./target/apidocs/. ./docs/build/apidocs
 
+      - name: Doxygen Action
+        uses: mattnotmitt/doxygen-action@v1.1.0
+        with:
+          doxyfile-path: "./Doxyfile"
+          working-directory: "."
+
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

Doxyfile

@@ -0,0 +1,413 @@
+# Doxyfile 1.10.0
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "Ollama4j"
+PROJECT_NUMBER         =
+PROJECT_BRIEF          = "A Java library (wrapper/binding) for Ollama server."
+PROJECT_LOGO           = ./logo-small.png
+PROJECT_ICON           = ./logo-small.png
+OUTPUT_DIRECTORY       = ./docs/build/doxygen
+CREATE_SUBDIRS         = NO
+CREATE_SUBDIRS_LEVEL   = 8
+ALLOW_UNICODE_NAMES    = NO
+OUTPUT_LANGUAGE        = English
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       = "The $name class" \
+                         "The $name widget" \
+                         "The $name file" \
+                         is \
+                         provides \
+                         specifies \
+                         contains \
+                         represents \
+                         a \
+                         an \
+                         the
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        =
+STRIP_FROM_INC_PATH    =
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = NO
+JAVADOC_BANNER         = NO
+QT_AUTOBRIEF           = NO
+MULTILINE_CPP_IS_BRIEF = NO
+PYTHON_DOCSTRING       = YES
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 4
+ALIASES                =
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = YES
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
+OPTIMIZE_OUTPUT_SLICE  = NO
+EXTENSION_MAPPING      =
+MARKDOWN_SUPPORT       = YES
+TOC_INCLUDE_HEADINGS   = 5
+MARKDOWN_ID_STYLE      = DOXYGEN
+AUTOLINK_SUPPORT       = YES
+BUILTIN_STL_SUPPORT    = NO
+CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
+IDL_PROPERTY_SUPPORT   = YES
+DISTRIBUTE_GROUP_DOC   = NO
+GROUP_NESTED_COMPOUNDS = NO
+SUBGROUPING            = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS  = NO
+TYPEDEF_HIDES_STRUCT   = NO
+LOOKUP_CACHE_SIZE      = 0
+NUM_PROC_THREADS       = 1
+TIMESTAMP              = NO
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_PRIV_VIRTUAL   = NO
+EXTRACT_PACKAGE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+EXTRACT_ANON_NSPACES   = NO
+RESOLVE_UNNAMED_PARAMS = YES
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = SYSTEM
+HIDE_SCOPE_NAMES       = NO
+HIDE_COMPOUND_REFERENCE= NO
+SHOW_HEADERFILE        = YES
+SHOW_INCLUDE_FILES     = YES
+SHOW_GROUPED_MEMB_INC  = NO
+FORCE_LOCAL_INCLUDES   = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+SORT_BRIEF_DOCS        = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES       = NO
+SORT_BY_SCOPE_NAME     = NO
+STRICT_PROTO_MATCHING  = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       =
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_FILES             = YES
+SHOW_NAMESPACES        = YES
+FILE_VERSION_FILTER    =
+LAYOUT_FILE            =
+CITE_BIB_FILES         =
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_IF_INCOMPLETE_DOC = YES
+WARN_NO_PARAMDOC       = NO
+WARN_IF_UNDOC_ENUM_VAL = NO
+WARN_AS_ERROR          = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LINE_FORMAT       = "at line $line of file $file"
+WARN_LOGFILE           =
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = ./src/main
+INPUT_ENCODING         = UTF-8
+INPUT_FILE_ENCODING    =
+FILE_PATTERNS          = *.c \
+                         *.cc \
+                         *.cxx \
+                         *.cxxm \
+                         *.cpp \
+                         *.cppm \
+                         *.ccm \
+                         *.c++ \
+                         *.c++m \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.idl \
+                         *.ddl \
+                         *.odl \
+                         *.h \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.ixx \
+                         *.l \
+                         *.cs \
+                         *.d \
+                         *.php \
+                         *.php4 \
+                         *.php5 \
+                         *.phtml \
+                         *.inc \
+                         *.m \
+                         *.markdown \
+                         *.md \
+                         *.mm \
+                         *.dox \
+                         *.py \
+                         *.pyw \
+                         *.f90 \
+                         *.f95 \
+                         *.f03 \
+                         *.f08 \
+                         *.f18 \
+                         *.f \
+                         *.for \
+                         *.vhd \
+                         *.vhdl \
+                         *.ucf \
+                         *.qsf \
+                         *.ice
+RECURSIVE              = YES
+EXCLUDE                =
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       =
+EXCLUDE_SYMBOLS        =
+EXAMPLE_PATH           =
+EXAMPLE_PATTERNS       = *
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             =
+INPUT_FILTER           =
+FILTER_PATTERNS        =
+FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_PATTERNS =
+USE_MDFILE_AS_MAINPAGE =
+FORTRAN_COMMENT_AFTER  = 72
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = YES
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = YES
+SOURCE_TOOLTIPS        = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+CLANG_ASSISTED_PARSING = NO
+CLANG_ADD_INC_PATHS    = YES
+CLANG_OPTIONS          =
+CLANG_DATABASE_PATH    =
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+IGNORE_PREFIX          =
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            =
+HTML_FOOTER            =
+HTML_STYLESHEET        =
+HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE        = LIGHT
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_DYNAMIC_MENUS     = YES
+HTML_DYNAMIC_SECTIONS  = NO
+HTML_CODE_FOLDING      = YES
+HTML_COPY_CLIPBOARD    = YES
+HTML_PROJECT_COOKIE    =
+HTML_INDEX_NUM_ENTRIES = 100
+GENERATE_DOCSET        = NO
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+DOCSET_FEEDURL         =
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME  = Publisher
+GENERATE_HTMLHELP      = NO
+CHM_FILE               =
+HHC_LOCATION           =
+GENERATE_CHI           = NO
+CHM_INDEX_ENCODING     =
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+SITEMAP_URL            =
+GENERATE_QHP           = NO
+QCH_FILE               =
+QHP_NAMESPACE          = org.doxygen.Project
+QHP_VIRTUAL_FOLDER     = doc
+QHP_CUST_FILTER_NAME   =
+QHP_CUST_FILTER_ATTRS  =
+QHP_SECT_FILTER_ATTRS  =
+QHG_LOCATION           =
+GENERATE_ECLIPSEHELP   = NO
+ECLIPSE_DOC_ID         = org.doxygen.Project
+DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = YES
+FULL_SIDEBAR           = NO
+ENUM_VALUES_PER_LINE   = 4
+TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = NO
+OBFUSCATE_EMAILS       = YES
+HTML_FORMULA_FORMAT    = png
+FORMULA_FONTSIZE       = 10
+FORMULA_MACROFILE      =
+USE_MATHJAX            = NO
+MATHJAX_VERSION        = MathJax_2
+MATHJAX_FORMAT         = HTML-CSS
+MATHJAX_RELPATH        =
+MATHJAX_EXTENSIONS     =
+MATHJAX_CODEFILE       =
+SEARCHENGINE           = YES
+SERVER_BASED_SEARCH    = NO
+EXTERNAL_SEARCH        = NO
+SEARCHENGINE_URL       =
+SEARCHDATA_FILE        = searchdata.xml
+EXTERNAL_SEARCH_ID     =
+EXTRA_SEARCH_MAPPINGS  =
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = YES
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         =
+MAKEINDEX_CMD_NAME     = makeindex
+LATEX_MAKEINDEX_CMD    = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4
+EXTRA_PACKAGES         =
+LATEX_HEADER           =
+LATEX_FOOTER           =
+LATEX_EXTRA_STYLESHEET =
+LATEX_EXTRA_FILES      =
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+LATEX_BIB_STYLE        = plain
+LATEX_EMOJI_DIRECTORY  =
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    =
+RTF_EXTENSIONS_FILE    =
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_SUBDIR             =
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_PROGRAMLISTING     = YES
+XML_NS_MEMB_FILE_SCOPE = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+GENERATE_DOCBOOK       = NO
+DOCBOOK_OUTPUT         = docbook
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# Configuration options related to Sqlite3 output
+#---------------------------------------------------------------------------
+GENERATE_SQLITE3       = NO
+SQLITE3_OUTPUT         = sqlite3
+SQLITE3_RECREATE_DB    = YES
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           =
+INCLUDE_FILE_PATTERNS  =
+PREDEFINED             =
+EXPAND_AS_DEFINED      =
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+TAGFILES               =
+GENERATE_TAGFILE       =
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+EXTERNAL_PAGES         = YES
+#---------------------------------------------------------------------------
+# Configuration options related to diagram generator tools
+#---------------------------------------------------------------------------
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+DOT_NUM_THREADS        = 0
+DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
+DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
+DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
+DOT_FONTPATH           =
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+UML_LIMIT_NUM_FIELDS   = 10
+DOT_UML_DETAILS        = NO
+DOT_WRAP_THRESHOLD     = 17
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+CALLER_GRAPH           = NO
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DIR_GRAPH_MAX_DEPTH    = 1
+DOT_IMAGE_FORMAT       = png
+INTERACTIVE_SVG        = NO
+DOT_PATH               =
+DOTFILE_DIRS           =
+DIA_PATH               =
+DIAFILE_DIRS           =
+PLANTUML_JAR_PATH      =
+PLANTUML_CFG_FILE      =
+PLANTUML_INCLUDE_PATH  =
+DOT_GRAPH_MAX_NODES    = 50
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+MSCGEN_TOOL            =
+MSCFILE_DIRS           =

Makefile

@@ -7,7 +7,22 @@ ut:
 it:
 	mvn clean verify -Pintegration-tests
 
+doxygen:
+	doxygen Doxyfile
+
 list-releases:
 	curl 'https://central.sonatype.com/api/internal/browse/component/versions?sortField=normalizedVersion&sortDirection=asc&page=0&size=12&filter=namespace%3Aio.github.amithkoujalgi%2Cname%3Aollama4j' \
       --compressed \
-      --silent | jq '.components[].version'
+      --silent | jq '.components[].version'
+
+build-docs:
+	npm i --prefix docs && npm run build --prefix docs
+
+start-docs:
+	npm i --prefix docs && npm run start --prefix docs
+
+start-cpu:
+	docker run -it -v ~/ollama:/root/.ollama -p 11434:11434 ollama/ollama
+
+start-gpu:
+	docker run -it --gpus=all -v ~/ollama:/root/.ollama -p 11434:11434 ollama/ollama

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,39 +44,19 @@ 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=for-the-badge&labelColor=gray)
+![Java](https://img.shields.io/badge/Java-11_+-green.svg?style=just-the-message&labelColor=gray)
 
-[![][ollama-shield]][ollama] Or  [![][ollama-docker-shield]][ollama-docker]
+[![][ollama-shield]][ollama] **Or** [![][ollama-docker-shield]][ollama-docker]
 
 [ollama]: https://ollama.ai/
 
-[ollama-shield]: https://img.shields.io/badge/Ollama-Local_Installation-blue.svg?style=for-the-badge&labelColor=gray
+[ollama-shield]: https://img.shields.io/badge/Ollama-Local_Installation-blue.svg?style=just-the-message&labelColor=gray
 
 [ollama-docker]: https://hub.docker.com/r/ollama/ollama
 
-[ollama-docker-shield]: https://img.shields.io/badge/Ollama-Docker-blue.svg?style=for-the-badge&labelColor=gray
+[ollama-docker-shield]: https://img.shields.io/badge/Ollama-Docker-blue.svg?style=just-the-message&labelColor=gray
 
 #### Installation
 
@@ -60,21 +67,42 @@ In your Maven project, add this dependency:
 <dependency>
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.29</version>
+    <version>1.0.70</version>
 </dependency>
 ```
 
-Latest release: ![Maven Central](https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j)
+or
+
+In your Gradle project, add the dependency using the Kotlin DSL or the Groovy DSL:
+
+```kotlin
+dependencies {
+
+    val ollama4jVersion = "1.0.70"
+
+    implementation("io.github.amithkoujalgi:ollama4j:$ollama4jVersion")
+}
+ ```
+
+```groovy
+dependencies {
+    implementation("io.github.amithkoujalgi:ollama4j:1.0.70")
+}
+```
+
+Latest release:
+
+![Maven Central](https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j)
 
 [![][lib-shield]][lib]
 
 [lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j
 
-[lib-shield]: https://img.shields.io/badge/ollama4j-get_latest_version-blue.svg?style=for-the-badge&labelColor=gray
+[lib-shield]: https://img.shields.io/badge/ollama4j-get_latest_version-blue.svg?style=just-the-message&labelColor=gray
 
 #### 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
 
@@ -101,6 +129,16 @@ make it
 Releases (newer artifact versions) are done automatically on pushing the code to the `main` branch through GitHub
 Actions CI workflow.
 
+#### Who's using Ollama4j?
+
+- `Datafaker`: a library to generate fake data
+    - https://github.com/datafaker-net/datafaker-experimental/tree/main/ollama-api
+- `Vaadin Web UI`: UI-Tester for Interactions with Ollama via ollama4j
+    - https://github.com/TEAMPB/ollama4j-vaadin-ui
+- `ollama-translator`: Minecraft 1.20.6 spigot plugin allows to easily break language barriers by using ollama on the
+  server to translate all messages into a specfic target language.
+    - https://github.com/liebki/ollama-translator
+
 #### Traction
 
 [![Star History Chart](https://api.star-history.com/svg?repos=amithkoujalgi/ollama4j&type=Date)](https://star-history.com/#amithkoujalgi/ollama4j&Date)
@@ -115,14 +153,16 @@ Actions CI workflow.
 - [x] Use lombok
 - [x] Update request body creation with Java objects
 - [ ] Async APIs for images
-- [ ] 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)
-    - `template`: the full prompt or prompt template (overrides what is defined in the Modelfile)
-    - `context`: the context parameter returned from a previous request, which can be used to keep a
+- [ ] Add custom headers to requests
+- [x] Add additional params for `ask` APIs such as:
+    - [x] `options`: additional model parameters for the Modelfile such as `temperature` -
+      Supported [params](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values).
+    - [x] `system`: system prompt to (overrides what is defined in the Modelfile)
+    - [x] `template`: the full prompt or prompt template (overrides what is defined in the Modelfile)
+    - [x] `context`: the context parameter returned from a previous request, which can be used to keep a
       short
       conversational memory
-    - `stream`: Add support for streaming responses from the model
+    - [x] `stream`: Add support for streaming responses from the model
 - [ ] Add test cases
 - [ ] Handle exceptions better (maybe throw more appropriate exceptions)
 
@@ -136,3 +176,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/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "APIs - Extras",
-  "position": 10,
+  "position": 4,
   "link": {
     "type": "generated-index",
     "description": "Details of APIs to handle bunch of extra stuff."

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");
+    }
+}
+```

docs/docs/apis-extras/options-builder.md

@@ -0,0 +1,78 @@
+---
+sidebar_position: 1
+---
+
+# Options Builder
+
+This lets you build options for the `ask()` API.
+
+Following are the parameters supported by Ollama:
+
+| Parameter      | Description                                                                                                                                                                                                                                             | Value Type | Example Usage        |
+|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------|
+| mirostat       | Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)                                                                                                                                         | int        | mirostat 0           |
+| mirostat_eta   | Influences how quickly the algorithm responds to feedback from the generated text. A lower learning rate will result in slower adjustments, while a higher learning rate will make the algorithm more responsive. (Default: 0.1)                        | float      | mirostat_eta 0.1     |
+| mirostat_tau   | Controls the balance between coherence and diversity of the output. A lower value will result in more focused and coherent text. (Default: 5.0)                                                                                                         | float      | mirostat_tau 5.0     |
+| num_ctx        | Sets the size of the context window used to generate the next token. (Default: 2048)                                                                                                                                                                    | int        | num_ctx 4096         |
+| num_gqa        | The number of GQA groups in the transformer layer. Required for some models, for example it is 8 for llama2:70b                                                                                                                                         | int        | num_gqa 1            |
+| num_gpu        | The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable metal support, 0 to disable.                                                                                                                                            | int        | num_gpu 50           |
+| num_thread     | Sets the number of threads to use during computation. By default, Ollama will detect this for optimal performance. It is recommended to set this value to the number of physical CPU cores your system has (as opposed to the logical number of cores). | int        | num_thread 8         |
+| repeat_last_n  | Sets how far back for the model to look back to prevent repetition. (Default: 64, 0 = disabled, -1 = num_ctx)                                                                                                                                           | int        | repeat_last_n 64     |
+| repeat_penalty | Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions more strongly, while a lower value (e.g., 0.9) will be more lenient. (Default: 1.1)                                                                     | float      | repeat_penalty 1.1   |
+| temperature    | The temperature of the model. Increasing the temperature will make the model answer more creatively. (Default: 0.8)                                                                                                                                     | float      | temperature 0.7      |
+| seed           | Sets the random number seed to use for generation. Setting this to a specific number will make the model generate the same text for the same prompt. (Default: 0)                                                                                       | int        | seed 42              |
+| stop           | Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return. Multiple stop patterns may be set by specifying multiple separate `stop` parameters in a modelfile.                                      | string     | stop "AI assistant:" |
+| tfs_z          | Tail free sampling is used to reduce the impact of less probable tokens from the output. A higher value (e.g., 2.0) will reduce the impact more, while a value of 1.0 disables this setting. (default: 1)                                               | float      | tfs_z 1              |
+| num_predict    | Maximum number of tokens to predict when generating text. (Default: 128, -1 = infinite generation, -2 = fill context)                                                                                                                                   | int        | num_predict 42       |
+| top_k          | Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative. (Default: 40)                                                                        | int        | top_k 40             |
+| top_p          | Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text. (Default: 0.9)                                                                 | float      | top_p 0.9            |
+
+Link to [source](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values).
+
+Also, see how to set those Ollama parameters using
+the `OptionsBuilder`
+from [javadoc](https://amithkoujalgi.github.io/ollama4j/apidocs/io/github/amithkoujalgi/ollama4j/core/utils/OptionsBuilder.html).
+
+## Build an empty `Options` object
+
+```java
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        Options options = new OptionsBuilder().build();
+    }
+}
+```
+
+## Build the `Options` object with values
+
+```java
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        Options options =
+                new OptionsBuilder()
+                        .setMirostat(10)
+                        .setMirostatEta(0.5f)
+                        .setNumGpu(2)
+                        .setTemperature(1.5f)
+                        .build();
+    }
+}
+```

docs/docs/apis-generate/_category_.json

@@ -1,6 +1,6 @@
 {
-  "label": "APIs - Ask",
-  "position": 10,
+  "label": "APIs - Generate",
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "Details of APIs to interact with LLMs."

docs/docs/apis-generate/chat.md

@@ -0,0 +1,205 @@
+---
+sidebar_position: 7
+---
+
+# Chat
+
+This API lets you create a conversation with LLMs. Using this API enables you to ask questions to the model including
+information using the history of already asked questions and the respective answers.
+
+## Create a new conversation and use chat history to augment follow up questions
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(OllamaModelType.LLAMA2);
+
+        // create first user question
+        OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What is the capital of France?")
+                .build();
+
+        // start conversation with model
+        OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+
+        System.out.println("First answer: " + chatResult.getResponse());
+
+        // create next userQuestion
+        requestModel = builder.withMessages(chatResult.getChatHistory()).withMessage(OllamaChatMessageRole.USER, "And what is the second largest city?").build();
+
+        // "continue" conversation with model
+        chatResult = ollamaAPI.chat(requestModel);
+
+        System.out.println("Second answer: " + chatResult.getResponse());
+
+        System.out.println("Chat History: " + chatResult.getChatHistory());
+    }
+}
+
+```
+
+You will get a response similar to:
+
+> First answer: Should be Paris!
+>
+> Second answer: Marseille.
+>
+> Chat History:
+
+```json
+[
+  {
+    "role": "user",
+    "content": "What is the capital of France?",
+    "images": []
+  },
+  {
+    "role": "assistant",
+    "content": "Should be Paris!",
+    "images": []
+  },
+  {
+    "role": "user",
+    "content": "And what is the second largest city?",
+    "images": []
+  },
+  {
+    "role": "assistant",
+    "content": "Marseille.",
+    "images": []
+  }
+]
+```
+
+## Create a conversation where the answer is streamed
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel());
+        OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER,
+                        "What is the capital of France? And what's France's connection with Mona Lisa?")
+                .build();
+
+        // define a handler (Consumer<String>)
+        OllamaStreamHandler streamHandler = (s) -> {
+            System.out.println(s);
+        };
+
+        OllamaChatResult chatResult = ollamaAPI.chat(requestModel, streamHandler);
+    }
+}
+```
+
+You will get a response similar to:
+
+> The
+> The capital
+> The capital of
+> The capital of France
+> The capital of France is
+> The capital of France is Paris
+> The capital of France is Paris.
+
+## Use a simple Console Output Stream Handler
+
+```java
+import io.github.amithkoujalgi.ollama4j.core.impl.ConsoleOutputStreamHandler;
+
+public class Main {
+    public static void main(String[] args) throws Exception {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(OllamaModelType.LLAMA2);
+        OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "List all cricket world cup teams of 2019. Name the teams!")
+                .build();
+        OllamaStreamHandler streamHandler = new ConsoleOutputStreamHandler();
+        ollamaAPI.chat(requestModel, streamHandler);
+    }
+}
+```
+
+## Create a new conversation with individual system prompt
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(OllamaModelType.LLAMA2);
+
+        // create request with system-prompt (overriding the model defaults) and user question
+        OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.SYSTEM, "You are a silent bot that only says 'NI'. Do not say anything else under any circumstances!")
+                .withMessage(OllamaChatMessageRole.USER, "What is the capital of France? And what's France's connection with Mona Lisa?")
+                .build();
+
+        // start conversation with model
+        OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+
+        System.out.println(chatResult.getResponse());
+    }
+}
+
+```
+
+You will get a response similar to:
+
+> NI.
+
+## Create a conversation about an image (requires model with image recognition skills)
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(OllamaModelType.LLAVA);
+
+        // Load Image from File and attach to user message (alternatively images could also be added via URL)
+        OllamaChatRequestModel requestModel =
+                builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?",
+                        List.of(getImageFileFromClasspath("dog-on-a-boat.jpg"))).build();
+
+        OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+        System.out.println("First answer: " + chatResult.getResponse());
+
+        builder.reset();
+
+        // Use history to ask further questions about the image or assistant answer
+        requestModel =
+                builder.withMessages(chatResult.getChatHistory())
+                        .withMessage(OllamaChatMessageRole.USER, "What's the dogs breed?").build();
+
+        chatResult = ollamaAPI.chat(requestModel);
+        System.out.println("Second answer: " + chatResult.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> First Answer: The image shows a dog sitting on the bow of a boat that is docked in calm water. The boat has two
+> levels, with the lower level containing seating and what appears to be an engine cover. The dog seems relaxed and
+> comfortable on the boat, looking out over the water. The background suggests it might be late afternoon or early
+> evening, given the warm lighting and the low position of the sun in the sky.
+>
+> Second Answer: Based on the image, it's difficult to definitively determine the breed of the dog. However, the dog
+> appears to be medium-sized with a short coat and a brown coloration, which might suggest that it is a Golden Retriever
+> or a similar breed. Without more details like ear shape and tail length, it's not possible to identify the exact breed
+> confidently.

docs/docs/apis-generate/generate-async.md

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# Ask - Async
+# Generate - Async
 
 This API lets you ask questions to the LLMs in a asynchronous way.
 These APIs correlate to
@@ -19,13 +19,13 @@ public class Main {
 
         String prompt = "Who are you?";
 
-        OllamaAsyncResultCallback callback = ollamaAPI.askAsync(OllamaModelType.LLAMA2, prompt);
+        OllamaAsyncResultCallback callback = ollamaAPI.generateAsync(OllamaModelType.LLAMA2, prompt);
 
         while (!callback.isComplete() || !callback.getStream().isEmpty()) {
             // poll for data from the response stream
             String result = callback.getStream().poll();
-            if (response != null) {
-                System.out.print(result.getResponse());
+            if (result != null) {
+                System.out.print(result);
             }
             Thread.sleep(100);
         }

docs/docs/apis-generate/generate-embeddings.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 ---
 
 # Generate Embeddings
@@ -30,17 +30,17 @@ public class Main {
 
 You will get a response similar to:
 
-```json
+```javascript
  [
-  0.5670403838157654,
-  0.009260174818336964,
-  0.23178744316101074,
-  -0.2916173040866852,
-  -0.8924556970596313,
-  0.8785552978515625,
-  -0.34576427936553955,
-  0.5742510557174683,
-  -0.04222835972905159,
-  -0.137906014919281
+    0.5670403838157654,
+    0.009260174818336964,
+    0.23178744316101074,
+    -0.2916173040866852,
+    -0.8924556970596313,
+    0.8785552978515625,
+    -0.34576427936553955,
+    0.5742510557174683,
+    -0.04222835972905159,
+    -0.137906014919281
 ]
 ```

docs/docs/apis-generate/generate-with-image-files.md

@@ -2,20 +2,20 @@
 sidebar_position: 3
 ---
 
-# Ask - With Image Files
+# Generate - With Image Files
 
 This API lets you ask questions along with the image files to the LLMs.
 These APIs correlate to
 the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
 
-:::caution
+:::note
 
 Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
 recommended.
 
 :::
 
-## Ask (Sync)
+## Synchronous mode
 
 If you have this image downloaded and you pass the path to the downloaded image to the following code:
 
@@ -29,7 +29,7 @@ public class Main {
         OllamaAPI ollamaAPI = new OllamaAPI(host);
         ollamaAPI.setRequestTimeoutSeconds(10);
 
-        OllamaResult result = ollamaAPI.askWithImageFiles(OllamaModelType.LLAVA,
+        OllamaResult result = ollamaAPI.generateWithImageFiles(OllamaModelType.LLAVA,
                 "What's in this image?",
                 List.of(
                         new File("/path/to/image")));

docs/docs/apis-generate/generate-with-image-urls.md

@@ -2,13 +2,13 @@
 sidebar_position: 4
 ---
 
-# Ask - With Image URLs
+# Generate - With Image URLs
 
 This API lets you ask questions along with the image files to the LLMs.
 These APIs correlate to
 the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
 
-:::caution
+:::note
 
 Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
 recommended.
@@ -29,7 +29,7 @@ public class Main {
         OllamaAPI ollamaAPI = new OllamaAPI(host);
         ollamaAPI.setRequestTimeoutSeconds(10);
 
-        OllamaResult result = ollamaAPI.askWithImageURLs(OllamaModelType.LLAVA,
+        OllamaResult result = ollamaAPI.generateWithImageURLs(OllamaModelType.LLAVA,
                 "What's in this image?",
                 List.of(
                         "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"));

docs/docs/apis-generate/generate.md

@@ -2,12 +2,17 @@
 sidebar_position: 1
 ---
 
-# Ask - Sync
+# Generate - Sync
 
 This API lets you ask questions to the LLMs in a synchronous way.
 These APIs correlate to
 the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
 
+Use the `OptionBuilder` to build the `Options` object
+with [extra parameters](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values).
+Refer
+to [this](/docs/apis-extras/options-builder).
+
 ## Try asking a question about the model.
 
 ```java
@@ -19,11 +24,13 @@ public class Main {
 
         OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-        OllamaResult result = ollamaAPI.ask(OllamaModelType.LLAMA2, "Who are you?");
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.LLAMA2, "Who are you?", new OptionsBuilder().build());
 
         System.out.println(result.getResponse());
     }
 }
+
 ```
 
 You will get a response similar to:
@@ -34,6 +41,41 @@ You will get a response similar to:
 > require
 > natural language understanding and generation capabilities.
 
+## Try asking a question, receiving the answer streamed
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        // define a stream handler (Consumer<String>)
+        OllamaStreamHandler streamHandler = (s) -> {
+           System.out.println(s);
+        };
+
+        // Should be called using seperate thread to gain non blocking streaming effect.
+        OllamaResult result = ollamaAPI.generate(config.getModel(),
+          "What is the capital of France? And what's France's connection with Mona Lisa?",
+          new OptionsBuilder().build(), streamHandler);
+        
+        System.out.println("Full response: " +result.getResponse());
+    }
+}
+```
+You will get a response similar to:
+
+> The
+> The capital
+> The capital of
+> The capital of France
+> The capital of France is 
+> The capital of France is Paris
+> The capital of France is Paris.
+> Full response: The capital of France is Paris.
+
 ## Try asking a question from general topics.
 
 ```java
@@ -47,11 +89,13 @@ public class Main {
 
         String prompt = "List all cricket world cup teams of 2019.";
 
-        OllamaResult result = ollamaAPI.ask(OllamaModelType.LLAMA2, prompt);
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.LLAMA2, prompt, new OptionsBuilder().build());
 
         System.out.println(result.getResponse());
     }
 }
+
 ```
 
 You'd then get a response from the model:
@@ -84,12 +128,15 @@ public class Main {
         String host = "http://localhost:11434/";
         OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-        String prompt = SamplePrompts.getSampleDatabasePromptWithQuestion(
-                "List all customer names who have bought one or more products");
-        OllamaResult result = ollamaAPI.ask(OllamaModelType.SQLCODER, prompt);
+        String prompt =
+                SamplePrompts.getSampleDatabasePromptWithQuestion(
+                        "List all customer names who have bought one or more products");
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.SQLCODER, prompt, new OptionsBuilder().build());
         System.out.println(result.getResponse());
     }
 }
+
 ```
 
 _Note: Here I've used

docs/docs/apis-generate/prompt-builder.md

@@ -0,0 +1,73 @@
+---
+sidebar_position: 5
+---
+
+# Prompt Builder
+
+This is designed for prompt engineering. It allows you to easily build the prompt text for zero-shot, one-shot, few-shot
+inferences.
+
+```java
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.types.OllamaModelType;
+import io.github.amithkoujalgi.ollama4j.core.utils.PromptBuilder;
+
+public class AskPhi {
+    public static void main(String[] args) throws Exception {
+
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(10);
+
+        String model = OllamaModelType.PHI;
+
+        PromptBuilder promptBuilder =
+                new PromptBuilder()
+                        .addLine("You are an expert coder and understand different programming languages.")
+                        .addLine("Given a question, answer ONLY with code.")
+                        .addLine("Produce clean, formatted and indented code in markdown format.")
+                        .addLine(
+                                "DO NOT include ANY extra text apart from code. Follow this instruction very strictly!")
+                        .addLine("If there's any additional information you want to add, use comments within code.")
+                        .addLine("Answer only in the programming language that has been asked for.")
+                        .addSeparator()
+                        .addLine("Example: Sum 2 numbers in Python")
+                        .addLine("Answer:")
+                        .addLine("```python")
+                        .addLine("def sum(num1: int, num2: int) -> int:")
+                        .addLine("    return num1 + num2")
+                        .addLine("```")
+                        .addSeparator()
+                        .add("How do I read a file in Go and print its contents to stdout?");
+
+        OllamaResult response = ollamaAPI.generate(model, promptBuilder.build(), new OptionsBuilder().build());
+        System.out.println(response.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+```go
+package main
+
+import (
+    "fmt"
+    "io/ioutil"
+)
+
+func readFile(fileName string) {
+    file, err := ioutil.ReadFile(fileName)
+    if err != nil {
+        fmt.Fprintln(os.Stderr, "Error reading file:", err.Error())
+        return
+    }
+
+    f, _ := ioutil.ReadFile("file.txt")
+    if f != nil {
+        fmt.Println(f.String())
+    }
+}
+```

docs/docs/apis-model-management/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "APIs - Model Management",
-  "position": 4,
+  "position": 2,
   "link": {
     "type": "generated-index",
     "description": "Details of APIs to manage LLMs."

docs/docs/apis-model-management/create-model.md

@@ -6,6 +6,8 @@ sidebar_position: 4
 
 This API lets you create a custom model on the Ollama server.
 
+### Create a model from an existing Modelfile in the Ollama server
+
 ```java title="CreateModel.java"
 public class CreateModel {
 
@@ -15,9 +17,144 @@ public class CreateModel {
 
         OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-        ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server");
+        ollamaAPI.createModelWithFilePath("mario", "/path/to/mario/modelfile/on/ollama-server");
     }
 }
 ```
 
-Once created, you can see it when you use [list models](./list-models) API.
+### Create a model by passing the contents of Modelfile
+
+```java title="CreateModel.java"
+public class CreateModel {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.createModelWithModelFileContents("mario", "FROM llama2\nSYSTEM You are mario from Super Mario Bros.");
+    }
+}
+```
+
+Once created, you can see it when you use [list models](./list-models) API.
+
+### Example of a `Modelfile`
+
+```
+FROM llama2
+# sets the temperature to 1 [higher is more creative, lower is more coherent]
+PARAMETER temperature 1
+# sets the context window size to 4096, this controls how many tokens the LLM can use as context to generate the next token
+PARAMETER num_ctx 4096
+
+# sets a custom system message to specify the behavior of the chat assistant
+SYSTEM You are Mario from super mario bros, acting as an assistant.
+```
+
+### Format of the `Modelfile`
+
+```modelfile
+# comment
+INSTRUCTION arguments
+```
+
+| Instruction                         | Description                                                    |
+|-------------------------------------|----------------------------------------------------------------|
+| [`FROM`](#from-required) (required) | Defines the base model to use.                                 |
+| [`PARAMETER`](#parameter)           | Sets the parameters for how Ollama will run the model.         |
+| [`TEMPLATE`](#template)             | The full prompt template to be sent to the model.              |
+| [`SYSTEM`](#system)                 | Specifies the system message that will be set in the template. |
+| [`ADAPTER`](#adapter)               | Defines the (Q)LoRA adapters to apply to the model.            |
+| [`LICENSE`](#license)               | Specifies the legal license.                                   |
+
+#### PARAMETER
+
+The `PARAMETER` instruction defines a parameter that can be set when the model is run.
+
+| Parameter      | Description                                                                                                                                                                                                                                             | Value Type | Example Usage        |
+|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------|
+| mirostat       | Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)                                                                                                                                         | int        | mirostat 0           |
+| mirostat_eta   | Influences how quickly the algorithm responds to feedback from the generated text. A lower learning rate will result in slower adjustments, while a higher learning rate will make the algorithm more responsive. (Default: 0.1)                        | float      | mirostat_eta 0.1     |
+| mirostat_tau   | Controls the balance between coherence and diversity of the output. A lower value will result in more focused and coherent text. (Default: 5.0)                                                                                                         | float      | mirostat_tau 5.0     |
+| num_ctx        | Sets the size of the context window used to generate the next token. (Default: 2048)                                                                                                                                                                    | int        | num_ctx 4096         |
+| num_gqa        | The number of GQA groups in the transformer layer. Required for some models, for example it is 8 for llama2:70b                                                                                                                                         | int        | num_gqa 1            |
+| num_gpu        | The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable metal support, 0 to disable.                                                                                                                                            | int        | num_gpu 50           |
+| num_thread     | Sets the number of threads to use during computation. By default, Ollama will detect this for optimal performance. It is recommended to set this value to the number of physical CPU cores your system has (as opposed to the logical number of cores). | int        | num_thread 8         |
+| repeat_last_n  | Sets how far back for the model to look back to prevent repetition. (Default: 64, 0 = disabled, -1 = num_ctx)                                                                                                                                           | int        | repeat_last_n 64     |
+| repeat_penalty | Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions more strongly, while a lower value (e.g., 0.9) will be more lenient. (Default: 1.1)                                                                     | float      | repeat_penalty 1.1   |
+| temperature    | The temperature of the model. Increasing the temperature will make the model answer more creatively. (Default: 0.8)                                                                                                                                     | float      | temperature 0.7      |
+| seed           | Sets the random number seed to use for generation. Setting this to a specific number will make the model generate the same text for the same prompt. (Default: 0)                                                                                       | int        | seed 42              |
+| stop           | Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return. Multiple stop patterns may be set by specifying multiple separate `stop` parameters in a modelfile.                                      | string     | stop "AI assistant:" |
+| tfs_z          | Tail free sampling is used to reduce the impact of less probable tokens from the output. A higher value (e.g., 2.0) will reduce the impact more, while a value of 1.0 disables this setting. (default: 1)                                               | float      | tfs_z 1              |
+| num_predict    | Maximum number of tokens to predict when generating text. (Default: 128, -1 = infinite generation, -2 = fill context)                                                                                                                                   | int        | num_predict 42       |
+| top_k          | Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative. (Default: 40)                                                                        | int        | top_k 40             |
+| top_p          | Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text. (Default: 0.9)                                                                 | float      | top_p 0.9            |
+
+#### TEMPLATE
+
+`TEMPLATE` of the full prompt template to be passed into the model. It may include (optionally) a system message and a
+user's prompt. This is used to create a full custom prompt, and syntax may be model specific. You can usually find the
+template for a given model in the readme for that model.
+
+#### Template Variables
+
+| Variable        | Description                                                                                                   |
+|-----------------|---------------------------------------------------------------------------------------------------------------|
+| `{{ .System }}` | The system message used to specify custom behavior, this must also be set in the Modelfile as an instruction. |
+| `{{ .Prompt }}` | The incoming prompt, this is not specified in the model file and will be set based on input.                  |
+| `{{ .First }}`  | A boolean value used to render specific template information for the first generation of a session.           |
+
+```modelfile
+TEMPLATE """
+{{- if .First }}
+### System:
+{{ .System }}
+{{- end }}
+
+### User:
+{{ .Prompt }}
+
+### Response:
+"""
+
+SYSTEM """<system message>"""
+```
+
+### SYSTEM
+
+The `SYSTEM` instruction specifies the system message to be used in the template, if applicable.
+
+```modelfile
+SYSTEM """<system message>"""
+```
+
+### ADAPTER
+
+The `ADAPTER` instruction specifies the LoRA adapter to apply to the base model. The value of this instruction should be
+an absolute path or a path relative to the Modelfile and the file must be in a GGML file format. The adapter should be
+tuned from the base model otherwise the behaviour is undefined.
+
+```modelfile
+ADAPTER ./ollama-lora.bin
+```
+
+### LICENSE
+
+The `LICENSE` instruction allows you to specify the legal license under which the model used with this Modelfile is
+shared or distributed.
+
+```modelfile
+LICENSE """
+<license text>
+"""
+```
+
+## Notes
+
+- the **`Modelfile` is not case sensitive**. In the examples, uppercase instructions are used to make it easier to
+  distinguish it from arguments.
+- Instructions can be in any order. In the examples, the `FROM` instruction is first to keep it easily readable.
+
+Read more about Modelfile: https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md

docs/docs/intro.md

@@ -2,10 +2,38 @@
 sidebar_position: 1
 ---
 
-# Intro
+# Introduction
 
 Let's get started with **Ollama4j**.
 
+## 🦙 What is Ollama?
+
+[Ollama](https://ollama.ai/) is an advanced AI tool that allows users to easily set up and run large language models
+locally (in CPU and GPU
+modes). With Ollama, users can leverage powerful language models such as Llama 2 and even customize and create their own
+models.
+
+## 👨‍💻 Why Ollama4j?
+
+Ollama4j was built for the simple purpose of integrating Ollama with Java applications.
+
+```mermaid
+  flowchart LR
+    o4j[Ollama4j]
+    o[Ollama Server]
+    o4j -->|Communicates with| o;
+    m[Models]
+    p[Your Java Project]
+    subgraph Your Java Environment
+        direction TB
+        p -->|Uses| o4j
+    end
+    subgraph Ollama Setup
+        direction TB
+        o -->|Manages| m
+    end
+```
+
 ## Getting Started
 
 ### What you'll need

docs/docusaurus.config.js

@@ -76,9 +76,10 @@ const config = {
                         type: 'docSidebar',
                         sidebarId: 'tutorialSidebar',
                         position: 'left',
-                        label: 'Usage',
+                        label: 'Docs',
                     },
                     {to: 'https://amithkoujalgi.github.io/ollama4j/apidocs/', label: 'Javadoc', position: 'left'},
+                    {to: 'https://amithkoujalgi.github.io/ollama4j/doxygen/html/', label: 'Doxygen', position: 'left'},
                     {to: '/blog', label: 'Blog', position: 'left'},
                     {
                         href: 'https://github.com/amithkoujalgi/ollama4j',
@@ -131,8 +132,13 @@ const config = {
             prism: {
                 theme: prismThemes.github,
                 darkTheme: prismThemes.dracula,
+                additionalLanguages: ['java'],
             },
         }),
+    markdown: {
+        mermaid: true,
+    },
+    themes: ['@docusaurus/theme-mermaid']
 };
 
 export default config;

docs/package.json

@@ -16,6 +16,7 @@
   "dependencies": {
     "@docusaurus/core": "3.0.1",
     "@docusaurus/preset-classic": "3.0.1",
+    "@docusaurus/theme-mermaid": "^3.0.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",

docs/src/css/custom.css

@@ -6,25 +6,35 @@
 
 /* You can override the default Infima variables here. */
 :root {
-  --ifm-color-primary: #2e8555;
-  --ifm-color-primary-dark: #29784c;
-  --ifm-color-primary-darker: #277148;
-  --ifm-color-primary-darkest: #205d3b;
-  --ifm-color-primary-light: #33925d;
-  --ifm-color-primary-lighter: #359962;
-  --ifm-color-primary-lightest: #3cad6e;
-  --ifm-code-font-size: 95%;
-  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+    --ifm-color-primary: #2e8555;
+    --ifm-color-primary-dark: #29784c;
+    --ifm-color-primary-darker: #277148;
+    --ifm-color-primary-darkest: #205d3b;
+    --ifm-color-primary-light: #33925d;
+    --ifm-color-primary-lighter: #359962;
+    --ifm-color-primary-lightest: #3cad6e;
+    --ifm-code-font-size: 95%;
+    --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
 [data-theme='dark'] {
-  --ifm-color-primary: #25c2a0;
-  --ifm-color-primary-dark: #21af90;
-  --ifm-color-primary-darker: #1fa588;
-  --ifm-color-primary-darkest: #1a8870;
-  --ifm-color-primary-light: #29d5b0;
-  --ifm-color-primary-lighter: #32d8b4;
-  --ifm-color-primary-lightest: #4fddbf;
-  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+    --ifm-color-primary: #25c2a0;
+    --ifm-color-primary-dark: #21af90;
+    --ifm-color-primary-darker: #1fa588;
+    --ifm-color-primary-darkest: #1a8870;
+    --ifm-color-primary-light: #29d5b0;
+    --ifm-color-primary-lighter: #32d8b4;
+    --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

@@ -4,7 +4,7 @@
 
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.30</version>
+    <version>1.0.73-SNAPSHOT</version>
 
     <name>Ollama4j</name>
     <description>Java library for interacting with Ollama API.</description>
@@ -39,7 +39,7 @@
         <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.30</tag>
+        <tag>v1.0.16</tag>
     </scm>
 
     <build>
@@ -99,7 +99,7 @@
                 <configuration>
                     <skipTests>${skipUnitTests}</skipTests>
                     <includes>
-                        <include>**/unittests/*.java</include>
+                        <include>**/unittests/**/*.java</include>
                     </includes>
                 </configuration>
             </plugin>
@@ -149,12 +149,17 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.15.3</version>
+            <version>2.17.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+            <version>2.17.1</version>
         </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.3.11</version>
+            <version>1.4.12</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -174,6 +179,12 @@
             <version>4.1.0</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20240205</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <distributionManagement>
@@ -198,6 +209,29 @@
             <activation>
                 <activeByDefault>true</activeByDefault>
             </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.11</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>
         <profile>
             <id>integration-tests</id>
@@ -249,6 +283,26 @@
                             <autoReleaseAfterClose>true</autoReleaseAfterClose>
                         </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>
         </profile>

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

@@ -0,0 +1,7 @@
+package io.github.amithkoujalgi.ollama4j.core;
+
+import java.util.function.Consumer;
+
+public interface OllamaStreamHandler extends Consumer<String>{
+    void accept(String message);
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/impl/ConsoleOutputStreamHandler.java

@@ -0,0 +1,14 @@
+package io.github.amithkoujalgi.ollama4j.core.impl;
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+
+public class ConsoleOutputStreamHandler implements OllamaStreamHandler {
+    private final StringBuffer response = new StringBuffer();
+
+    @Override
+    public void accept(String message) {
+        String substr = message.substring(response.length());
+        response.append(substr);
+        System.out.print(substr);
+    }
+}

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/Model.java

@@ -1,14 +1,22 @@
 package io.github.amithkoujalgi.ollama4j.core.models;
 
+import java.time.LocalDateTime;
+import java.time.OffsetDateTime;
+
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
 import lombok.Data;
 
 @Data
 public class Model {
 
   private String name;
+  private String model;
   @JsonProperty("modified_at")
-  private String modifiedAt;
+  private OffsetDateTime modifiedAt;
+  @JsonProperty("expires_at")
+  private OffsetDateTime expiresAt;
   private String digest;
   private long size;
   @JsonProperty("details")
@@ -33,4 +41,13 @@ public class Model {
     return name.split(":")[1];
   }
 
+    @Override
+  public String toString() {
+    try {
+      return Utils.getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
 }

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

@@ -2,7 +2,8 @@ package io.github.amithkoujalgi.ollama4j.core.models;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import java.util.Map;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
 import lombok.Data;
 
 @Data
@@ -16,5 +17,14 @@ public class ModelDetail {
   private String parameters;
   private String template;
   private String system;
-  private Map<String, String> details;
+  private ModelMeta details;
+
+    @Override
+  public String toString() {
+    try {
+      return Utils.getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
 }

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

@@ -2,6 +2,8 @@ package io.github.amithkoujalgi.ollama4j.core.models;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
 import lombok.Data;
 
 @Data
@@ -21,4 +23,13 @@ public class ModelMeta {
 
   @JsonProperty("quantization_level")
   private String quantizationLevel;
+
+    @Override
+  public String toString() {
+    try {
+      return Utils.getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
 }

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

@@ -1,12 +1,13 @@
 package io.github.amithkoujalgi.ollama4j.core.models;
 
 import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateResponseModel;
 import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
 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 +15,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 OllamaRequestModel ollamaRequestModel;
+  private final HttpRequest.Builder requestBuilder;
+  private final OllamaGenerateRequestModel 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,
-      OllamaRequestModel ollamaRequestModel,
+      HttpRequest.Builder requestBuilder,
+      OllamaGenerateRequestModel 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 +61,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 +73,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;
 
@@ -73,8 +89,8 @@ public class OllamaAsyncResultCallback extends Thread {
             queue.add(ollamaResponseModel.getError());
             responseBuffer.append(ollamaResponseModel.getError());
           } else {
-            OllamaResponseModel ollamaResponseModel =
-                Utils.getObjectMapper().readValue(line, OllamaResponseModel.class);
+            OllamaGenerateResponseModel ollamaResponseModel =
+                Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class);
             queue.add(ollamaResponseModel.getResponse());
             if (!ollamaResponseModel.isDone()) {
               responseBuffer.append(ollamaResponseModel.getResponse());
@@ -109,28 +125,9 @@ public class OllamaAsyncResultCallback extends Thread {
   }
 
   /**
-   * Returns the HTTP response status code for the request that was made to Ollama server.
+   * Returns the final completion/response when the execution completes. Does not return intermediate results.
    *
-   * @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.
-   *
-   * @return String - response text
+   * @return String completion/response text
    */
   public String getResponse() {
     return result;
@@ -140,15 +137,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/models/OllamaCommonRequestModel.java

@@ -0,0 +1,35 @@
+package io.github.amithkoujalgi.ollama4j.core.models;
+
+import java.util.Map;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
+import io.github.amithkoujalgi.ollama4j.core.utils.BooleanToJsonFormatFlagSerializer;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import lombok.Data;
+
+@Data
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public abstract class OllamaCommonRequestModel {
+  
+  protected String model;  
+  @JsonSerialize(using = BooleanToJsonFormatFlagSerializer.class)
+  @JsonProperty(value = "format")
+  protected Boolean returnFormatJson;
+  protected Map<String, Object> options;
+  protected String template;
+  protected boolean stream;
+  @JsonProperty(value = "keep_alive")
+  protected String keepAlive;
+
+  
+  public String toString() {
+    try {
+      return Utils.getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+}

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

@@ -1,8 +1,6 @@
 package io.github.amithkoujalgi.ollama4j.core.models;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import java.util.List;
 import lombok.Data;
 
 @Data

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

@@ -1,35 +0,0 @@
-package io.github.amithkoujalgi.ollama4j.core.models;
-
-
-import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
-
-import com.fasterxml.jackson.core.JsonProcessingException;
-import java.util.List;
-import lombok.Data;
-
-@Data
-public class OllamaRequestModel {
-
-  private String model;
-  private String prompt;
-  private List<String> images;
-
-  public OllamaRequestModel(String model, String prompt) {
-    this.model = model;
-    this.prompt = prompt;
-  }
-
-  public OllamaRequestModel(String model, String prompt, List<String> images) {
-    this.model = model;
-    this.prompt = prompt;
-    this.images = images;
-  }
-
-  public String toString() {
-    try {
-      return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
-    } catch (JsonProcessingException e) {
-      throw new RuntimeException(e);
-    }
-  }
-}

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

@@ -13,9 +13,9 @@ import lombok.Getter;
 public class OllamaResult {
   /**
    * -- GETTER --
-   *  Get the response text
+   *  Get the completion/response text
    *
-   * @return String - response text
+   * @return String completion/response text
    */
   private final String response;
 

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessage.java

@@ -0,0 +1,45 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
+import io.github.amithkoujalgi.ollama4j.core.utils.FileToBase64Serializer;
+
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Defines a single Message to be used inside a chat request against the ollama /api/chat endpoint.
+ *
+ * @see <a href="https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion">Generate chat completion</a>
+ */
+@Data
+@AllArgsConstructor
+@RequiredArgsConstructor
+@NoArgsConstructor
+public class OllamaChatMessage {
+
+    @NonNull
+    private OllamaChatMessageRole role;
+
+    @NonNull
+    private String content;
+
+    @JsonSerialize(using = FileToBase64Serializer.class)
+    private List<byte[]> images;
+    
+      @Override
+  public String toString() {
+    try {
+      return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatMessageRole.java

@@ -0,0 +1,19 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Defines the possible Chat Message roles.
+ */
+public enum OllamaChatMessageRole {
+    SYSTEM("system"),
+    USER("user"),
+    ASSISTANT("assistant");
+
+    @JsonValue
+    private String roleName;
+
+    private OllamaChatMessageRole(String roleName){
+        this.roleName = roleName;
+    }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestBuilder.java

@@ -0,0 +1,110 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+
+/**
+ * Helper class for creating {@link OllamaChatRequestModel} objects using the builder-pattern.
+ */
+public class OllamaChatRequestBuilder {
+
+    private static final Logger LOG = LoggerFactory.getLogger(OllamaChatRequestBuilder.class);
+
+    private OllamaChatRequestBuilder(String model, List<OllamaChatMessage> messages){
+        request = new OllamaChatRequestModel(model, messages);
+    }
+
+    private OllamaChatRequestModel request;
+
+    public static OllamaChatRequestBuilder getInstance(String model){
+        return new OllamaChatRequestBuilder(model, new ArrayList<>());
+    }
+
+    public OllamaChatRequestModel build(){
+        return request;
+    }
+
+    public void reset(){
+        request = new OllamaChatRequestModel(request.getModel(), new ArrayList<>());
+    }
+
+    public OllamaChatRequestBuilder withMessage(OllamaChatMessageRole role, String content, List<File> images){
+        List<OllamaChatMessage> messages = this.request.getMessages();
+
+        List<byte[]> binaryImages = images.stream().map(file -> {
+            try {
+                return Files.readAllBytes(file.toPath());
+            } catch (IOException e) {
+                LOG.warn(String.format("File '%s' could not be accessed, will not add to message!",file.toPath()), e);
+                return new byte[0];
+            }
+        }).collect(Collectors.toList());
+
+        messages.add(new OllamaChatMessage(role,content,binaryImages));
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withMessage(OllamaChatMessageRole role, String content, String... imageUrls){
+        List<OllamaChatMessage> messages = this.request.getMessages();
+        List<byte[]> binaryImages = null;
+        if(imageUrls.length>0){
+            binaryImages = new ArrayList<>();
+            for (String imageUrl : imageUrls) {
+                try{
+                    binaryImages.add(Utils.loadImageBytesFromUrl(imageUrl));
+                }
+                    catch (URISyntaxException e){
+                        LOG.warn(String.format("URL '%s' could not be accessed, will not add to message!",imageUrl), e);
+                }
+                catch (IOException e){
+                    LOG.warn(String.format("Content of URL '%s' could not be read, will not add to message!",imageUrl), e);
+                }
+            }
+        }
+        
+        messages.add(new OllamaChatMessage(role,content,binaryImages));
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withMessages(List<OllamaChatMessage> messages){
+        this.request.getMessages().addAll(messages);
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withOptions(Options options){
+        this.request.setOptions(options.getOptionsMap());
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withGetJsonResponse(){
+        this.request.setReturnFormatJson(true);
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withTemplate(String template){
+        this.request.setTemplate(template);
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withStreaming(){
+        this.request.setStream(true);
+        return this;
+    }
+
+    public OllamaChatRequestBuilder withKeepAlive(String keepAlive){
+        this.request.setKeepAlive(keepAlive);
+        return this;
+    }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatRequestModel.java

@@ -0,0 +1,39 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import java.util.List;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaCommonRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Defines a Request to use against the ollama /api/chat endpoint.
+ *
+ * @see <a href=
+ *      "https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion">Generate
+ *      Chat Completion</a>
+ */
+@Getter
+@Setter
+public class OllamaChatRequestModel extends OllamaCommonRequestModel implements OllamaRequestBody {
+
+  private List<OllamaChatMessage> messages;
+
+  public OllamaChatRequestModel() {}
+
+  public OllamaChatRequestModel(String model, List<OllamaChatMessage> messages) {
+    this.model = model;
+    this.messages = messages;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (!(o instanceof OllamaChatRequestModel)) {
+      return false;
+    }
+
+    return this.toString().equals(o.toString());
+  }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatResponseModel.java

@@ -0,0 +1,23 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class OllamaChatResponseModel {
+    private String model;
+    private @JsonProperty("created_at") String createdAt;
+    private @JsonProperty("done_reason") String doneReason;
+    private OllamaChatMessage message;
+    private boolean done;
+    private String error;
+    private List<Integer> context;
+    private @JsonProperty("total_duration") Long totalDuration;
+    private @JsonProperty("load_duration") Long loadDuration;
+    private @JsonProperty("prompt_eval_duration") Long promptEvalDuration;
+    private @JsonProperty("eval_duration") Long evalDuration;
+    private @JsonProperty("prompt_eval_count") Integer promptEvalCount;
+    private @JsonProperty("eval_count") Integer evalCount;
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatResult.java

@@ -0,0 +1,32 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import java.util.List;
+
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+
+/**
+ * Specific chat-API result that contains the chat history sent to the model and appends the answer as {@link OllamaChatResult} given by the
+ * {@link OllamaChatMessageRole#ASSISTANT} role.
+ */
+public class OllamaChatResult extends OllamaResult{
+
+    private List<OllamaChatMessage> chatHistory;
+
+    public OllamaChatResult(String response, long responseTime, int httpStatusCode,
+            List<OllamaChatMessage> chatHistory) {
+        super(response, responseTime, httpStatusCode);
+        this.chatHistory = chatHistory;
+        appendAnswerToChatHistory(response);
+    }
+
+    public List<OllamaChatMessage> getChatHistory() {
+        return chatHistory;
+    } 
+
+    private void appendAnswerToChatHistory(String answer){
+        OllamaChatMessage assistantMessage = new OllamaChatMessage(OllamaChatMessageRole.ASSISTANT, answer);
+        this.chatHistory.add(assistantMessage);
+    }
+    
+    
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/chat/OllamaChatStreamObserver.java

@@ -0,0 +1,31 @@
+package io.github.amithkoujalgi.ollama4j.core.models.chat;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+
+public class OllamaChatStreamObserver {
+
+    private OllamaStreamHandler streamHandler;
+
+    private List<OllamaChatResponseModel> responseParts = new ArrayList<>();
+
+    private String message = "";
+
+    public OllamaChatStreamObserver(OllamaStreamHandler streamHandler) {
+        this.streamHandler = streamHandler;
+    }
+
+    public void notify(OllamaChatResponseModel currentResponsePart){
+        responseParts.add(currentResponsePart);
+        handleCurrentResponsePart(currentResponsePart);
+    }
+    
+    protected void handleCurrentResponsePart(OllamaChatResponseModel currentResponsePart){
+        message = message + currentResponsePart.getMessage().getContent();
+        streamHandler.accept(message);
+    }
+
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/embeddings/OllamaEmbeddingResponseModel.java

@@ -1,4 +1,4 @@
-package io.github.amithkoujalgi.ollama4j.core.models;
+package io.github.amithkoujalgi.ollama4j.core.models.embeddings;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
@@ -7,7 +7,7 @@ import lombok.Data;
 
 @SuppressWarnings("unused")
 @Data
-public class EmbeddingResponse {
+public class OllamaEmbeddingResponseModel {
     @JsonProperty("embedding")
     private List<Double> embedding;
 }

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/embeddings/OllamaEmbeddingsRequestBuilder.java

@@ -0,0 +1,31 @@
+package io.github.amithkoujalgi.ollama4j.core.models.embeddings;
+
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
+
+public class OllamaEmbeddingsRequestBuilder {
+
+    private OllamaEmbeddingsRequestBuilder(String model, String prompt){
+        request = new OllamaEmbeddingsRequestModel(model, prompt);
+    }
+
+    private OllamaEmbeddingsRequestModel request;
+
+    public static OllamaEmbeddingsRequestBuilder getInstance(String model, String prompt){
+        return new OllamaEmbeddingsRequestBuilder(model, prompt);
+    }
+
+    public OllamaEmbeddingsRequestModel build(){
+        return request;
+    }
+
+    public OllamaEmbeddingsRequestBuilder withOptions(Options options){
+        this.request.setOptions(options.getOptionsMap());
+        return this;
+    }
+
+    public OllamaEmbeddingsRequestBuilder withKeepAlive(String keepAlive){
+        this.request.setKeepAlive(keepAlive);
+        return this;
+    }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/embeddings/OllamaEmbeddingsRequestModel.java

@@ -0,0 +1,33 @@
+package io.github.amithkoujalgi.ollama4j.core.models.embeddings;
+
+import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
+import java.util.Map;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+@Data
+@RequiredArgsConstructor
+@NoArgsConstructor
+public class OllamaEmbeddingsRequestModel {
+  @NonNull
+  private String model;
+  @NonNull
+  private String prompt;
+
+  protected Map<String, Object> options;
+  @JsonProperty(value = "keep_alive")
+  private String keepAlive;
+
+  @Override
+  public String toString() {
+    try {
+      return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
+    } catch (JsonProcessingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/generate/OllamaGenerateRequestBuilder.java

@@ -0,0 +1,55 @@
+package io.github.amithkoujalgi.ollama4j.core.models.generate;
+
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
+
+/**
+ * Helper class for creating {@link io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel} 
+ * objects using the builder-pattern.
+ */
+public class OllamaGenerateRequestBuilder {
+
+    private OllamaGenerateRequestBuilder(String model, String prompt){
+        request = new OllamaGenerateRequestModel(model, prompt);
+    }
+
+    private OllamaGenerateRequestModel request;
+
+    public static OllamaGenerateRequestBuilder getInstance(String model){
+        return new OllamaGenerateRequestBuilder(model,"");
+    }
+
+    public OllamaGenerateRequestModel build(){
+        return request;
+    }
+
+    public OllamaGenerateRequestBuilder withPrompt(String prompt){
+        request.setPrompt(prompt);
+        return this;
+    }
+    
+    public OllamaGenerateRequestBuilder withGetJsonResponse(){
+        this.request.setReturnFormatJson(true);
+        return this;
+    }
+
+    public OllamaGenerateRequestBuilder withOptions(Options options){
+        this.request.setOptions(options.getOptionsMap());
+        return this;
+    }
+
+    public OllamaGenerateRequestBuilder withTemplate(String template){
+        this.request.setTemplate(template);
+        return this;
+    }
+
+    public OllamaGenerateRequestBuilder withStreaming(){
+        this.request.setStream(true);
+        return this;
+    }
+
+    public OllamaGenerateRequestBuilder withKeepAlive(String keepAlive){
+        this.request.setKeepAlive(keepAlive);
+        return this;
+    }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/generate/OllamaGenerateRequestModel.java

@@ -0,0 +1,46 @@
+package io.github.amithkoujalgi.ollama4j.core.models.generate;
+
+
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaCommonRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+
+import java.util.List;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class OllamaGenerateRequestModel extends OllamaCommonRequestModel implements OllamaRequestBody{
+
+  private String prompt;
+  private List<String> images;
+
+  private String system;
+  private String context;
+  private boolean raw;
+
+  public OllamaGenerateRequestModel() {
+  }
+
+  public OllamaGenerateRequestModel(String model, String prompt) {
+    this.model = model;
+    this.prompt = prompt;
+  }
+
+  public OllamaGenerateRequestModel(String model, String prompt, List<String> images) {
+    this.model = model;
+    this.prompt = prompt;
+    this.images = images;
+  }
+
+    @Override
+  public boolean equals(Object o) {
+    if (!(o instanceof OllamaGenerateRequestModel)) {
+      return false;
+    }
+
+    return this.toString().equals(o.toString());
+  }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/generate/OllamaGenerateResponseModel.java

@@ -1,4 +1,4 @@
-package io.github.amithkoujalgi.ollama4j.core.models;
+package io.github.amithkoujalgi.ollama4j.core.models.generate;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -8,7 +8,7 @@ import lombok.Data;
 
 @Data
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class OllamaResponseModel {
+public class OllamaGenerateResponseModel {
     private String model;
     private @JsonProperty("created_at") String createdAt;
     private String response;

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/generate/OllamaGenerateStreamObserver.java

@@ -0,0 +1,31 @@
+package io.github.amithkoujalgi.ollama4j.core.models.generate;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+
+public class OllamaGenerateStreamObserver {
+
+    private OllamaStreamHandler streamHandler;
+
+    private List<OllamaGenerateResponseModel> responseParts = new ArrayList<>();
+
+    private String message = "";
+
+    public OllamaGenerateStreamObserver(OllamaStreamHandler streamHandler) {
+        this.streamHandler = streamHandler;
+    }
+
+    public void notify(OllamaGenerateResponseModel currentResponsePart){
+        responseParts.add(currentResponsePart);
+        handleCurrentResponsePart(currentResponsePart);
+    }
+    
+    protected void handleCurrentResponsePart(OllamaGenerateResponseModel currentResponsePart){
+        message = message + currentResponsePart.getResponse();
+        streamHandler.accept(message);
+    }
+
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/ModelEmbeddingsRequest.java

@@ -1,23 +0,0 @@
-package io.github.amithkoujalgi.ollama4j.core.models.request;
-
-import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
-
-import com.fasterxml.jackson.core.JsonProcessingException;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-
-@Data
-@AllArgsConstructor
-public class ModelEmbeddingsRequest {
-  private String model;
-  private String prompt;
-
-  @Override
-  public String toString() {
-    try {
-      return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
-    } catch (JsonProcessingException e) {
-      throw new RuntimeException(e);
-    }
-  }
-}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/OllamaChatEndpointCaller.java

@@ -0,0 +1,55 @@
+package io.github.amithkoujalgi.ollama4j.core.models.request;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResponseModel;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatStreamObserver;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+/**
+ * Specialization class for requests
+ */
+public class OllamaChatEndpointCaller extends OllamaEndpointCaller {
+
+    private static final Logger LOG = LoggerFactory.getLogger(OllamaChatEndpointCaller.class);
+
+    private OllamaChatStreamObserver streamObserver;
+
+    public OllamaChatEndpointCaller(String host, BasicAuth basicAuth, long requestTimeoutSeconds, boolean verbose) {
+        super(host, basicAuth, requestTimeoutSeconds, verbose);
+    }
+
+    @Override
+    protected String getEndpointSuffix() {
+        return "/api/chat";
+    }
+
+    @Override
+    protected boolean parseResponseAndAddToBuffer(String line, StringBuilder responseBuffer) {
+        try {
+            OllamaChatResponseModel ollamaResponseModel = Utils.getObjectMapper().readValue(line, OllamaChatResponseModel.class);
+            responseBuffer.append(ollamaResponseModel.getMessage().getContent());
+            if (streamObserver != null) {
+                streamObserver.notify(ollamaResponseModel);
+            }
+            return ollamaResponseModel.isDone();
+        } catch (JsonProcessingException e) {
+            LOG.error("Error parsing the Ollama chat response!", e);
+            return true;
+        }
+    }
+
+    public OllamaResult call(OllamaRequestBody body, OllamaStreamHandler streamHandler)
+            throws OllamaBaseException, IOException, InterruptedException {
+        streamObserver = new OllamaChatStreamObserver(streamHandler);
+        return super.callSync(body);
+    }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/OllamaEndpointCaller.java

@@ -0,0 +1,152 @@
+package io.github.amithkoujalgi.ollama4j.core.models.request;
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
+import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaErrorResponseModel;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+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;
+import java.nio.charset.StandardCharsets;
+import java.time.Duration;
+import java.util.Base64;
+
+/**
+ * Abstract helperclass to call the ollama api server.
+ */
+public abstract class OllamaEndpointCaller {
+
+    private static final Logger LOG = LoggerFactory.getLogger(OllamaAPI.class);
+
+    private String host;
+    private BasicAuth basicAuth;
+    private long requestTimeoutSeconds;
+    private boolean verbose;
+
+    public OllamaEndpointCaller(String host, BasicAuth basicAuth, long requestTimeoutSeconds, boolean verbose) {
+        this.host = host;
+        this.basicAuth = basicAuth;
+        this.requestTimeoutSeconds = requestTimeoutSeconds;
+        this.verbose = verbose;
+    }
+
+    protected abstract String getEndpointSuffix();
+
+    protected abstract boolean parseResponseAndAddToBuffer(String line, StringBuilder responseBuffer);
+
+
+    /**
+     * Calls the api server on the given host and endpoint suffix asynchronously, aka waiting for the response.
+     *
+     * @param body POST body payload
+     * @return result answer given by the assistant
+     * @throws OllamaBaseException  any response code than 200 has been returned
+     * @throws IOException          in case the responseStream can not be read
+     * @throws InterruptedException in case the server is not reachable or network issues happen
+     */
+    public OllamaResult callSync(OllamaRequestBody body) throws OllamaBaseException, IOException, InterruptedException {
+        // Create Request
+        long startTime = System.currentTimeMillis();
+        HttpClient httpClient = HttpClient.newHttpClient();
+        URI uri = URI.create(this.host + getEndpointSuffix());
+        HttpRequest.Builder requestBuilder =
+                getRequestBuilderDefault(uri)
+                        .POST(
+                                body.getBodyPublisher());
+        HttpRequest request = requestBuilder.build();
+        if (this.verbose) LOG.info("Asking model: " + body.toString());
+        HttpResponse<InputStream> response =
+                httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
+
+        int statusCode = response.statusCode();
+        InputStream responseBodyStream = response.body();
+        StringBuilder responseBuffer = new StringBuilder();
+        try (BufferedReader reader =
+                     new BufferedReader(new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) {
+            String line;
+            while ((line = reader.readLine()) != null) {
+                if (statusCode == 404) {
+                    LOG.warn("Status code: 404 (Not Found)");
+                    OllamaErrorResponseModel ollamaResponseModel =
+                            Utils.getObjectMapper().readValue(line, OllamaErrorResponseModel.class);
+                    responseBuffer.append(ollamaResponseModel.getError());
+                } else if (statusCode == 401) {
+                    LOG.warn("Status code: 401 (Unauthorized)");
+                    OllamaErrorResponseModel ollamaResponseModel =
+                            Utils.getObjectMapper()
+                                    .readValue("{\"error\":\"Unauthorized\"}", OllamaErrorResponseModel.class);
+                    responseBuffer.append(ollamaResponseModel.getError());
+                } else if (statusCode == 400) {
+                    LOG.warn("Status code: 400 (Bad Request)");
+                    OllamaErrorResponseModel ollamaResponseModel = Utils.getObjectMapper().readValue(line,
+                            OllamaErrorResponseModel.class);
+                    responseBuffer.append(ollamaResponseModel.getError());
+                } else {
+                    boolean finished = parseResponseAndAddToBuffer(line, responseBuffer);
+                    if (finished) {
+                        break;
+                    }
+                }
+            }
+        }
+
+        if (statusCode != 200) {
+            LOG.error("Status code " + statusCode);
+            throw new OllamaBaseException(responseBuffer.toString());
+        } else {
+            long endTime = System.currentTimeMillis();
+            OllamaResult ollamaResult =
+                    new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
+            if (verbose) LOG.info("Model response: " + ollamaResult);
+            return ollamaResult;
+        }
+    }
+
+    /**
+     * 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(this.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 = this.basicAuth.getUsername() + ":" + this.basicAuth.getPassword();
+        return "Basic " + Base64.getEncoder().encodeToString(credentialsToEncode.getBytes());
+    }
+
+    /**
+     * Check if Basic Auth credentials set.
+     *
+     * @return true when Basic Auth credentials set
+     */
+    private boolean isBasicAuthCredentialsSet() {
+        return this.basicAuth != null;
+    }
+
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/models/request/OllamaGenerateEndpointCaller.java

@@ -0,0 +1,54 @@
+package io.github.amithkoujalgi.ollama4j.core.models.request;
+
+import java.io.IOException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler;
+import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateResponseModel;
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateStreamObserver;
+import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+
+public class OllamaGenerateEndpointCaller extends OllamaEndpointCaller{
+
+    private static final Logger LOG = LoggerFactory.getLogger(OllamaGenerateEndpointCaller.class);
+
+    private OllamaGenerateStreamObserver streamObserver;
+
+    public OllamaGenerateEndpointCaller(String host, BasicAuth basicAuth, long requestTimeoutSeconds, boolean verbose) {
+        super(host, basicAuth, requestTimeoutSeconds, verbose);   
+    }
+
+    @Override
+    protected String getEndpointSuffix() {
+        return "/api/generate";
+    }
+
+    @Override
+    protected boolean parseResponseAndAddToBuffer(String line, StringBuilder responseBuffer) {
+                try {
+                    OllamaGenerateResponseModel ollamaResponseModel = Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class);
+                    responseBuffer.append(ollamaResponseModel.getResponse());
+                    if(streamObserver != null) {
+                        streamObserver.notify(ollamaResponseModel);
+                    }
+                    return ollamaResponseModel.isDone();
+                } catch (JsonProcessingException e) {
+                    LOG.error("Error parsing the Ollama chat response!",e);
+                    return true;
+                }         
+    }
+
+    public OllamaResult call(OllamaRequestBody body, OllamaStreamHandler streamHandler)
+        throws OllamaBaseException, IOException, InterruptedException {
+    streamObserver = new OllamaGenerateStreamObserver(streamHandler);
+    return super.callSync(body);
+    }
+    
+    
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/types/OllamaModelType.java

@@ -8,56 +8,75 @@ package io.github.amithkoujalgi.ollama4j.core.types;
  */
 @SuppressWarnings("ALL")
 public class OllamaModelType {
-  public static final String LLAMA2 = "llama2";
-  public static final String MISTRAL = "mistral";
-  public static final String LLAVA = "llava";
-  public static final String MIXTRAL = "mixtral";
-  public static final String STARLING_LM = "starling-lm";
-  public static final String NEURAL_CHAT = "neural-chat";
-  public static final String CODELLAMA = "codellama";
-  public static final String LLAMA2_UNCENSORED = "llama2-uncensored";
-  public static final String DOLPHIN_MIXTRAL = "dolphin-mixtral";
-  public static final String ORCA_MINI = "orca-mini";
-  public static final String VICUNA = "vicuna";
-  public static final String WIZARD_VICUNA_UNCENSORED = "wizard-vicuna-uncensored";
-  public static final String PHIND_CODELLAMA = "phind-codellama";
-  public static final String ZEPHYR = "zephyr";
-  public static final String WIZARDCODER = "wizardcoder";
-  public static final String MISTRAL_OPENORCA = "mistral-openorca";
-  public static final String NOUS_HERMES = "nous-hermes";
-  public static final String DEEPSEEK_CODER = "deepseek-coder";
-  public static final String WIZARD_MATH = "wizard-math";
-  public static final String LLAMA2_CHINESE = "llama2-chinese";
-  public static final String FALCON = "falcon";
-  public static final String ORCA2 = "orca2";
-  public static final String STABLE_BELUGA = "stable-beluga";
-  public static final String CODEUP = "codeup";
-  public static final String EVERYTHINGLM = "everythinglm";
-  public static final String MEDLLAMA2 = "medllama2";
-  public static final String WIZARDLM_UNCENSORED = "wizardlm-uncensored";
-  public static final String STARCODER = "starcoder";
-  public static final String DOLPHIN22_MISTRAL = "dolphin2.2-mistral";
-  public static final String OPENCHAT = "openchat";
-  public static final String WIZARD_VICUNA = "wizard-vicuna";
-  public static final String OPENHERMES25_MISTRAL = "openhermes2.5-mistral";
-  public static final String OPEN_ORCA_PLATYPUS2 = "open-orca-platypus2";
-  public static final String YI = "yi";
-  public static final String YARN_MISTRAL = "yarn-mistral";
-  public static final String SAMANTHA_MISTRAL = "samantha-mistral";
-  public static final String SQLCODER = "sqlcoder";
-  public static final String YARN_LLAMA2 = "yarn-llama2";
-  public static final String MEDITRON = "meditron";
-  public static final String STABLELM_ZEPHYR = "stablelm-zephyr";
-  public static final String OPENHERMES2_MISTRAL = "openhermes2-mistral";
-  public static final String DEEPSEEK_LLM = "deepseek-llm";
-  public static final String MISTRALLITE = "mistrallite";
-  public static final String DOLPHIN21_MISTRAL = "dolphin2.1-mistral";
-  public static final String WIZARDLM = "wizardlm";
-  public static final String CODEBOOGA = "codebooga";
-  public static final String MAGICODER = "magicoder";
-  public static final String GOLIATH = "goliath";
-  public static final String NEXUSRAVEN = "nexusraven";
-  public static final String ALFRED = "alfred";
-  public static final String XWINLM = "xwinlm";
-  public static final String BAKLLAVA = "bakllava";
+    public static final String GEMMA = "gemma";
+    public static final String LLAMA2 = "llama2";
+    public static final String LLAMA3 = "llama3";
+    public static final String MISTRAL = "mistral";
+    public static final String MIXTRAL = "mixtral";
+    public static final String LLAVA = "llava";
+    public static final String LLAVA_PHI3 = "llava-phi3";
+    public static final String NEURAL_CHAT = "neural-chat";
+    public static final String CODELLAMA = "codellama";
+    public static final String DOLPHIN_MIXTRAL = "dolphin-mixtral";
+    public static final String MISTRAL_OPENORCA = "mistral-openorca";
+    public static final String LLAMA2_UNCENSORED = "llama2-uncensored";
+    public static final String PHI = "phi";
+    public static final String PHI3 = "phi3";
+    public static final String ORCA_MINI = "orca-mini";
+    public static final String DEEPSEEK_CODER = "deepseek-coder";
+    public static final String DOLPHIN_MISTRAL = "dolphin-mistral";
+    public static final String VICUNA = "vicuna";
+    public static final String WIZARD_VICUNA_UNCENSORED = "wizard-vicuna-uncensored";
+    public static final String ZEPHYR = "zephyr";
+    public static final String OPENHERMES = "openhermes";
+    public static final String QWEN = "qwen";
+    public static final String WIZARDCODER = "wizardcoder";
+    public static final String LLAMA2_CHINESE = "llama2-chinese";
+    public static final String TINYLLAMA = "tinyllama";
+    public static final String PHIND_CODELLAMA = "phind-codellama";
+    public static final String OPENCHAT = "openchat";
+    public static final String ORCA2 = "orca2";
+    public static final String FALCON = "falcon";
+    public static final String WIZARD_MATH = "wizard-math";
+    public static final String TINYDOLPHIN = "tinydolphin";
+    public static final String NOUS_HERMES = "nous-hermes";
+    public static final String YI = "yi";
+    public static final String DOLPHIN_PHI = "dolphin-phi";
+    public static final String STARLING_LM = "starling-lm";
+    public static final String STARCODER = "starcoder";
+    public static final String CODEUP = "codeup";
+    public static final String MEDLLAMA2 = "medllama2";
+    public static final String STABLE_CODE = "stable-code";
+    public static final String WIZARDLM_UNCENSORED = "wizardlm-uncensored";
+    public static final String BAKLLAVA = "bakllava";
+    public static final String EVERYTHINGLM = "everythinglm";
+    public static final String SOLAR = "solar";
+    public static final String STABLE_BELUGA = "stable-beluga";
+    public static final String SQLCODER = "sqlcoder";
+    public static final String YARN_MISTRAL = "yarn-mistral";
+    public static final String NOUS_HERMES2_MIXTRAL = "nous-hermes2-mixtral";
+    public static final String SAMANTHA_MISTRAL = "samantha-mistral";
+    public static final String STABLELM_ZEPHYR = "stablelm-zephyr";
+    public static final String MEDITRON = "meditron";
+    public static final String WIZARD_VICUNA = "wizard-vicuna";
+    public static final String STABLELM2 = "stablelm2";
+    public static final String MAGICODER = "magicoder";
+    public static final String YARN_LLAMA2 = "yarn-llama2";
+    public static final String NOUS_HERMES2 = "nous-hermes2";
+    public static final String DEEPSEEK_LLM = "deepseek-llm";
+    public static final String LLAMA_PRO = "llama-pro";
+    public static final String OPEN_ORCA_PLATYPUS2 = "open-orca-platypus2";
+    public static final String CODEBOOGA = "codebooga";
+    public static final String MISTRALLITE = "mistrallite";
+    public static final String NEXUSRAVEN = "nexusraven";
+    public static final String GOLIATH = "goliath";
+    public static final String NOMIC_EMBED_TEXT = "nomic-embed-text";
+    public static final String NOTUX = "notux";
+    public static final String ALFRED = "alfred";
+    public static final String MEGADOLPHIN = "megadolphin";
+    public static final String WIZARDLM = "wizardlm";
+    public static final String XWINLM = "xwinlm";
+    public static final String NOTUS = "notus";
+    public static final String DUCKDB_NSQL = "duckdb-nsql";
+    public static final String ALL_MINILM = "all-minilm";
 }

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

@@ -0,0 +1,21 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+
+public class BooleanToJsonFormatFlagSerializer extends JsonSerializer<Boolean>{
+
+    @Override
+    public void serialize(Boolean value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
+            gen.writeString("json");
+    }
+
+    @Override
+    public boolean isEmpty(SerializerProvider provider,Boolean value){
+        return !value;
+    }
+
+}

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

@@ -0,0 +1,21 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+import java.io.IOException;
+import java.util.Base64;
+import java.util.Collection;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+
+public class FileToBase64Serializer extends JsonSerializer<Collection<byte[]>> {
+
+    @Override
+    public void serialize(Collection<byte[]> value, JsonGenerator jsonGenerator, SerializerProvider serializers) throws IOException {
+        jsonGenerator.writeStartArray();
+        for (byte[] file : value) {
+            jsonGenerator.writeString(Base64.getEncoder().encodeToString(file));
+        }
+        jsonGenerator.writeEndArray();
+    }
+}

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

@@ -0,0 +1,28 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+import java.net.http.HttpRequest.BodyPublisher;
+import java.net.http.HttpRequest.BodyPublishers;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+/**
+ * Interface to represent a OllamaRequest as HTTP-Request Body via {@link BodyPublishers}.
+ */
+public interface OllamaRequestBody {
+    
+    /**
+     * Transforms the OllamaRequest Object to a JSON Object via Jackson.
+     * 
+     * @return JSON representation of a OllamaRequest
+     */
+    @JsonIgnore
+    default BodyPublisher getBodyPublisher(){
+                try {
+          return BodyPublishers.ofString(
+                      Utils.getObjectMapper().writeValueAsString(this));
+        } catch (JsonProcessingException e) {
+          throw new IllegalArgumentException("Request not Body convertible.",e);
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+import java.util.Map;
+import lombok.Data;
+
+/** Class for options for Ollama model. */
+@Data
+public class Options {
+
+  private final Map<String, Object> optionsMap;
+}

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

@@ -0,0 +1,218 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+import java.util.HashMap;
+
+/** Builder class for creating options for Ollama model. */
+public class OptionsBuilder {
+
+  private final Options options;
+
+  /** Constructs a new OptionsBuilder with an empty options map. */
+  public OptionsBuilder() {
+    this.options = new Options(new HashMap<>());
+  }
+
+  /**
+   * Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, 1 = Mirostat, 2
+   * = Mirostat 2.0)
+   *
+   * @param value The value for the "mirostat" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setMirostat(int value) {
+    options.getOptionsMap().put("mirostat", value);
+    return this;
+  }
+
+  /**
+   * Influences how quickly the algorithm responds to feedback from the generated text. A lower
+   * learning rate will result in slower adjustments, while a higher learning rate will make the
+   * algorithm more responsive. (Default: 0.1)
+   *
+   * @param value The value for the "mirostat_eta" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setMirostatEta(float value) {
+    options.getOptionsMap().put("mirostat_eta", value);
+    return this;
+  }
+
+  /**
+   * Controls the balance between coherence and diversity of the output. A lower value will result
+   * in more focused and coherent text. (Default: 5.0)
+   *
+   * @param value The value for the "mirostat_tau" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setMirostatTau(float value) {
+    options.getOptionsMap().put("mirostat_tau", value);
+    return this;
+  }
+
+  /**
+   * Sets the size of the context window used to generate the next token. (Default: 2048)
+   *
+   * @param value The value for the "num_ctx" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setNumCtx(int value) {
+    options.getOptionsMap().put("num_ctx", value);
+    return this;
+  }
+
+  /**
+   * The number of GQA groups in the transformer layer. Required for some models, for example, it is
+   * 8 for llama2:70b.
+   *
+   * @param value The value for the "num_gqa" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setNumGqa(int value) {
+    options.getOptionsMap().put("num_gqa", value);
+    return this;
+  }
+
+  /**
+   * The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable metal support,
+   * 0 to disable.
+   *
+   * @param value The value for the "num_gpu" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setNumGpu(int value) {
+    options.getOptionsMap().put("num_gpu", value);
+    return this;
+  }
+
+  /**
+   * Sets the number of threads to use during computation. By default, Ollama will detect this for
+   * optimal performance. It is recommended to set this value to the number of physical CPU cores
+   * your system has (as opposed to the logical number of cores).
+   *
+   * @param value The value for the "num_thread" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setNumThread(int value) {
+    options.getOptionsMap().put("num_thread", value);
+    return this;
+  }
+
+  /**
+   * Sets how far back for the model to look back to prevent repetition. (Default: 64, 0 = disabled,
+   * -1 = num_ctx)
+   *
+   * @param value The value for the "repeat_last_n" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setRepeatLastN(int value) {
+    options.getOptionsMap().put("repeat_last_n", value);
+    return this;
+  }
+
+  /**
+   * Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions
+   * more strongly, while a lower value (e.g., 0.9) will be more lenient. (Default: 1.1)
+   *
+   * @param value The value for the "repeat_penalty" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setRepeatPenalty(float value) {
+    options.getOptionsMap().put("repeat_penalty", value);
+    return this;
+  }
+
+  /**
+   * The temperature of the model. Increasing the temperature will make the model answer more
+   * creatively. (Default: 0.8)
+   *
+   * @param value The value for the "temperature" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setTemperature(float value) {
+    options.getOptionsMap().put("temperature", value);
+    return this;
+  }
+
+  /**
+   * Sets the random number seed to use for generation. Setting this to a specific number will make
+   * the model generate the same text for the same prompt. (Default: 0)
+   *
+   * @param value The value for the "seed" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setSeed(int value) {
+    options.getOptionsMap().put("seed", value);
+    return this;
+  }
+
+  /**
+   * Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating
+   * text and return. Multiple stop patterns may be set by specifying multiple separate `stop`
+   * parameters in a modelfile.
+   *
+   * @param value The value for the "stop" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setStop(String value) {
+    options.getOptionsMap().put("stop", value);
+    return this;
+  }
+
+  /**
+   * Tail free sampling is used to reduce the impact of less probable tokens from the output. A
+   * higher value (e.g., 2.0) will reduce the impact more, while a value of 1.0 disables this
+   * setting. (default: 1)
+   *
+   * @param value The value for the "tfs_z" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setTfsZ(float value) {
+    options.getOptionsMap().put("tfs_z", value);
+    return this;
+  }
+
+  /**
+   * Maximum number of tokens to predict when generating text. (Default: 128, -1 = infinite
+   * generation, -2 = fill context)
+   *
+   * @param value The value for the "num_predict" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setNumPredict(int value) {
+    options.getOptionsMap().put("num_predict", value);
+    return this;
+  }
+
+  /**
+   * Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more
+   * diverse answers, while a lower value (e.g. 10) will be more conservative. (Default: 40)
+   *
+   * @param value The value for the "top_k" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setTopK(int value) {
+    options.getOptionsMap().put("top_k", value);
+    return this;
+  }
+
+  /**
+   * Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a
+   * lower value (e.g., 0.5) will generate more focused and conservative text. (Default: 0.9)
+   *
+   * @param value The value for the "top_p" parameter.
+   * @return The updated OptionsBuilder.
+   */
+  public OptionsBuilder setTopP(float value) {
+    options.getOptionsMap().put("top_p", value);
+    return this;
+  }
+
+  /**
+   * Builds the options map.
+   *
+   * @return The populated options map.
+   */
+  public Options build() {
+    return options;
+  }
+}

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

@@ -0,0 +1,69 @@
+package io.github.amithkoujalgi.ollama4j.core.utils;
+
+/**
+ * The {@code PromptBuilder} class is used to construct prompt texts for language models (LLMs). It
+ * provides methods for adding text, adding lines, adding separators, and building the final prompt.
+ *
+ * <p>Example usage:
+ *
+ * <pre>{@code
+ * PromptBuilder promptBuilder = new PromptBuilder();
+ * promptBuilder.add("This is a sample prompt for language models.")
+ *              .addLine("You can add lines to provide context.")
+ *              .addSeparator()
+ *              .add("Feel free to customize as needed.");
+ * String finalPrompt = promptBuilder.build();
+ * System.out.println(finalPrompt);
+ * }</pre>
+ */
+public class PromptBuilder {
+
+  private final StringBuilder prompt;
+
+  /** Constructs a new {@code PromptBuilder} with an empty prompt. */
+  public PromptBuilder() {
+    this.prompt = new StringBuilder();
+  }
+
+  /**
+   * Appends the specified text to the prompt.
+   *
+   * @param text the text to be added to the prompt
+   * @return a reference to this {@code PromptBuilder} instance for method chaining
+   */
+  public PromptBuilder add(String text) {
+    prompt.append(text);
+    return this;
+  }
+
+  /**
+   * Appends the specified text followed by a newline character to the prompt.
+   *
+   * @param text the text to be added as a line to the prompt
+   * @return a reference to this {@code PromptBuilder} instance for method chaining
+   */
+  public PromptBuilder addLine(String text) {
+    prompt.append(text).append("\n");
+    return this;
+  }
+
+  /**
+   * Appends a separator line to the prompt. The separator is a newline followed by a line of
+   * dashes.
+   *
+   * @return a reference to this {@code PromptBuilder} instance for method chaining
+   */
+  public PromptBuilder addSeparator() {
+    prompt.append("\n--------------------------------------------------\n");
+    return this;
+  }
+
+  /**
+   * Builds and returns the final prompt as a string.
+   *
+   * @return the final prompt as a string
+   */
+  public String build() {
+    return prompt.toString();
+  }
+}

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

@@ -1,9 +1,38 @@
 package io.github.amithkoujalgi.ollama4j.core.utils;
 
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
 public class Utils {
-    public static ObjectMapper getObjectMapper() {
-        return new ObjectMapper();
+
+  private static ObjectMapper objectMapper;
+
+  public static ObjectMapper getObjectMapper() {
+    if(objectMapper == null) {
+      objectMapper = new ObjectMapper();
+      objectMapper.registerModule(new JavaTimeModule());
     }
+    return objectMapper;
+  }
+
+  public static byte[] loadImageBytesFromUrl(String imageUrl)
+      throws IOException, URISyntaxException {
+    URL url = new URI(imageUrl).toURL();
+    try (InputStream in = url.openStream();
+        ByteArrayOutputStream out = new ByteArrayOutputStream()) {
+      byte[] buffer = new byte[1024];
+      int bytesRead;
+      while ((bytesRead = in.read(buffer)) != -1) {
+        out.write(buffer, 0, bytesRead);
+      }
+      return out.toByteArray();
+    }
+  }
 }

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

@@ -4,38 +4,48 @@ 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.types.OllamaModelType;
+import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail;
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatMessageRole;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResult;
+import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestBuilder;
+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 lombok.Data;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 class TestRealAPIs {
-  OllamaAPI ollamaAPI;
 
-  private Properties loadProperties() {
-    Properties properties = new Properties();
-    try (InputStream input =
-        getClass().getClassLoader().getResourceAsStream("test-config.properties")) {
-      if (input == null) {
-        throw new RuntimeException("Sorry, unable to find test-config.properties");
-      }
-      properties.load(input);
-      return properties;
-    } catch (IOException e) {
-      throw new RuntimeException("Error loading properties", e);
-    }
+  private static final Logger LOG = LoggerFactory.getLogger(TestRealAPIs.class);
+
+  OllamaAPI ollamaAPI;
+  Config config;
+
+  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"));
+    config = new Config();
+    ollamaAPI = new OllamaAPI(config.getOllamaURL());
+    ollamaAPI.setRequestTimeoutSeconds(config.getRequestTimeoutSeconds());
   }
 
   @Test
@@ -53,7 +63,7 @@ class TestRealAPIs {
     } catch (HttpConnectTimeoutException e) {
       fail(e.getMessage());
     } catch (Exception e) {
-      throw new RuntimeException(e);
+      fail(e);
     }
   }
 
@@ -65,7 +75,7 @@ class TestRealAPIs {
       assertNotNull(ollamaAPI.listModels());
       ollamaAPI.listModels().forEach(System.out::println);
     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+      fail(e);
     }
   }
 
@@ -74,13 +84,310 @@ class TestRealAPIs {
   void testPullModel() {
     testEndpointReachability();
     try {
-      ollamaAPI.pullModel(OllamaModelType.LLAMA2);
+      ollamaAPI.pullModel(config.getModel());
       boolean found =
           ollamaAPI.listModels().stream()
-              .anyMatch(model -> model.getModelName().equals(OllamaModelType.LLAMA2));
+              .anyMatch(model -> model.getModel().equalsIgnoreCase(config.getModel()));
       assertTrue(found);
     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testListDtails() {
+    testEndpointReachability();
+    try {
+      ModelDetail modelDetails = ollamaAPI.getModelDetails(config.getModel());
+      assertNotNull(modelDetails);
+      System.out.println(modelDetails);
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithDefaultOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.generate(
+              config.getModel(),
+              "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) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithDefaultOptionsStreamed() {
+    testEndpointReachability();
+    try {
+
+      StringBuffer sb = new StringBuffer("");
+
+      OllamaResult result = ollamaAPI.generate(config.getModel(),
+          "What is the capital of France? And what's France's connection with Mona Lisa?",
+          new OptionsBuilder().build(), (s) -> {
+            LOG.info(s);
+            String substring = s.substring(sb.toString().length(), s.length());
+            LOG.info(substring);
+            sb.append(substring);
+          });
+
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+      assertEquals(sb.toString().trim(), result.getResponse().trim());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.generate(
+              config.getModel(),
+              "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) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testChat() {
+    testEndpointReachability();
+    try {
+      OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel());
+      OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What is the capital of France?")
+             .withMessage(OllamaChatMessageRole.ASSISTANT, "Should be Paris!")
+             .withMessage(OllamaChatMessageRole.USER,"And what is the second larges city?")
+             .build();
+
+      OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+      assertNotNull(chatResult);
+      assertFalse(chatResult.getResponse().isBlank());
+      assertEquals(4,chatResult.getChatHistory().size());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testChatWithSystemPrompt() {
+    testEndpointReachability();
+    try {
+      OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel());
+      OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.SYSTEM,
+          "You are a silent bot that only says 'NI'. Do not say anything else under any circumstances!")
+          .withMessage(OllamaChatMessageRole.USER,
+              "What is the capital of France? And what's France's connection with Mona Lisa?")
+          .build();
+
+      OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+      assertNotNull(chatResult);
+      assertFalse(chatResult.getResponse().isBlank());
+      assertTrue(chatResult.getResponse().startsWith("NI"));
+      assertEquals(3, chatResult.getChatHistory().size());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testChatWithStream() {
+    testEndpointReachability();
+    try {
+      OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel());
+      OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER,
+              "What is the capital of France? And what's France's connection with Mona Lisa?")
+          .build();
+
+      StringBuffer sb = new StringBuffer("");
+
+      OllamaChatResult chatResult = ollamaAPI.chat(requestModel,(s) -> {
+        LOG.info(s);
+        String substring = s.substring(sb.toString().length(), s.length());
+        LOG.info(substring);
+        sb.append(substring);
+      });
+      assertNotNull(chatResult);
+      assertEquals(sb.toString().trim(), chatResult.getResponse().trim());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testChatWithImageFromFileWithHistoryRecognition() {
+    testEndpointReachability();
+    try {
+      OllamaChatRequestBuilder builder =
+          OllamaChatRequestBuilder.getInstance(config.getImageModel());
+      OllamaChatRequestModel requestModel =
+          builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?",
+              List.of(getImageFileFromClasspath("dog-on-a-boat.jpg"))).build();
+
+      OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+      assertNotNull(chatResult);
+      assertNotNull(chatResult.getResponse());
+
+      builder.reset();
+
+      requestModel =
+          builder.withMessages(chatResult.getChatHistory())
+            .withMessage(OllamaChatMessageRole.USER, "What's the dogs breed?").build();
+
+      chatResult = ollamaAPI.chat(requestModel);
+      assertNotNull(chatResult);
+      assertNotNull(chatResult.getResponse());
+
+
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testChatWithImageFromURL() {
+    testEndpointReachability();
+    try {
+      OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getImageModel());
+      OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?",
+      "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg")
+             .build();
+
+      OllamaChatResult chatResult = ollamaAPI.chat(requestModel);
+      assertNotNull(chatResult);
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptionsAndImageFiles() {
+    testEndpointReachability();
+    File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg");
+    try {
+      OllamaResult result =
+          ollamaAPI.generateWithImageFiles(
+              config.getImageModel(),
+              "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) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptionsAndImageFilesStreamed() {
+    testEndpointReachability();
+    File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg");
+    try {
+      StringBuffer sb = new StringBuffer("");
+
+      OllamaResult result = ollamaAPI.generateWithImageFiles(config.getImageModel(),
+          "What is in this image?", List.of(imageFile), new OptionsBuilder().build(), (s) -> {
+            LOG.info(s);
+            String substring = s.substring(sb.toString().length(), s.length());
+            LOG.info(substring);
+            sb.append(substring);
+          });
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+      assertEquals(sb.toString().trim(), result.getResponse().trim());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptionsAndImageURLs() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.generateWithImageURLs(
+              config.getImageModel(),
+              "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) {
+      fail(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  public void testEmbedding() {
+    testEndpointReachability();
+    try {
+      OllamaEmbeddingsRequestModel request = OllamaEmbeddingsRequestBuilder
+          .getInstance(config.getModel(), "What is the capital of France?").build();
+
+      List<Double> embeddings = ollamaAPI.generateEmbeddings(request);
+
+      assertNotNull(embeddings);
+      assertFalse(embeddings.isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      fail(e);
+    }
+  }
+}
+
+@Data
+class Config {
+  private String ollamaURL;
+  private String model;
+  private String imageModel;
+  private int requestTimeoutSeconds;
+
+  public Config() {
+    Properties properties = new Properties();
+    try (InputStream input =
+        getClass().getClassLoader().getResourceAsStream("test-config.properties")) {
+      if (input == null) {
+        throw new RuntimeException("Sorry, unable to find test-config.properties");
+      }
+      properties.load(input);
+      this.ollamaURL = properties.getProperty("ollama.url");
+      this.model = properties.getProperty("ollama.model");
+      this.imageModel = properties.getProperty("ollama.model.image");
+      this.requestTimeoutSeconds =
+          Integer.parseInt(properties.getProperty("ollama.request-timeout-seconds"));
+    } catch (IOException e) {
+      throw new RuntimeException("Error loading properties", e);
     }
   }
 }

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

@@ -8,15 +8,17 @@ import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail;
 import io.github.amithkoujalgi.ollama4j.core.models.OllamaAsyncResultCallback;
 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.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 +51,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 +64,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 +77,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);
     }
   }
@@ -99,23 +101,63 @@ class TestMockedAPIs {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
+    OptionsBuilder optionsBuilder = new OptionsBuilder();
     try {
-      when(ollamaAPI.ask(model, prompt)).thenReturn(new OllamaResult("", 0, 200));
-      ollamaAPI.ask(model, prompt);
-      verify(ollamaAPI, times(1)).ask(model, prompt);
+      when(ollamaAPI.generate(model, prompt, optionsBuilder.build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generate(model, prompt, optionsBuilder.build());
+      verify(ollamaAPI, times(1)).generate(model, prompt, optionsBuilder.build());
     } catch (IOException | OllamaBaseException | InterruptedException e) {
       throw new RuntimeException(e);
     }
   }
 
+  @Test
+  void testAskWithImageFiles() {
+    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+    String model = OllamaModelType.LLAMA2;
+    String prompt = "some prompt text";
+    try {
+      when(ollamaAPI.generateWithImageFiles(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generateWithImageFiles(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .generateWithImageFiles(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+    } 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.generateWithImageURLs(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generateWithImageURLs(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .generateWithImageURLs(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+    } 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));
-    ollamaAPI.askAsync(model, prompt);
-    verify(ollamaAPI, times(1)).askAsync(model, prompt);
+    when(ollamaAPI.generateAsync(model, prompt))
+        .thenReturn(new OllamaAsyncResultCallback(null, null, 3));
+    ollamaAPI.generateAsync(model, prompt);
+    verify(ollamaAPI, times(1)).generateAsync(model, prompt);
   }
 }

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/AbstractSerializationTest.java

@@ -0,0 +1,35 @@
+package io.github.amithkoujalgi.ollama4j.unittests.jackson;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+
+public abstract class AbstractSerializationTest<T> {
+
+    protected ObjectMapper mapper = Utils.getObjectMapper();
+
+    protected String serialize(T obj) {
+        try {
+            return mapper.writeValueAsString(obj);
+        } catch (JsonProcessingException e) {
+            fail("Could not serialize request!", e);
+            return null;
+        }
+    }
+
+    protected T deserialize(String jsonObject, Class<T> deserializationClass) {
+        try {
+            return mapper.readValue(jsonObject, deserializationClass);
+        } catch (JsonProcessingException e) {
+            fail("Could not deserialize jsonObject!", e);
+            return null;
+        }
+    }
+
+    protected void assertEqualsAfterUnmarshalling(T unmarshalledObject,
+        T req) {
+        assertEquals(req, unmarshalledObject);
+    }
+}

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/TestChatRequestSerialization.java

@@ -0,0 +1,113 @@
+package io.github.amithkoujalgi.ollama4j.unittests.jackson;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.io.File;
+import java.util.List;
+
+import org.json.JSONObject;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatMessageRole;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder;
+import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+public class TestChatRequestSerialization extends AbstractSerializationTest<OllamaChatRequestModel> {
+
+    private OllamaChatRequestBuilder builder;
+
+    @BeforeEach
+    public void init() {
+        builder = OllamaChatRequestBuilder.getInstance("DummyModel");
+    }
+
+    @Test
+    public void testRequestOnlyMandatoryFields() {
+        OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt").build();
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req);
+    }
+
+    @Test
+    public void testRequestMultipleMessages() {
+        OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.SYSTEM, "System prompt")
+        .withMessage(OllamaChatMessageRole.USER, "Some prompt")
+        .build();
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req);
+    }
+
+    @Test
+    public void testRequestWithMessageAndImage() {
+        OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt",
+                List.of(new File("src/test/resources/dog-on-a-boat.jpg"))).build();
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req);
+    }
+
+    @Test
+    public void testRequestWithOptions() {
+        OptionsBuilder b = new OptionsBuilder();
+        OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt")
+            .withOptions(b.setMirostat(1).build())
+            .withOptions(b.setTemperature(1L).build())
+            .withOptions(b.setMirostatEta(1L).build())
+            .withOptions(b.setMirostatTau(1L).build())
+            .withOptions(b.setNumGpu(1).build())
+            .withOptions(b.setSeed(1).build())
+            .withOptions(b.setTopK(1).build())
+            .withOptions(b.setTopP(1).build())
+            .build();
+
+        String jsonRequest = serialize(req);
+        OllamaChatRequestModel deserializeRequest = deserialize(jsonRequest, OllamaChatRequestModel.class);
+        assertEqualsAfterUnmarshalling(deserializeRequest, req);
+        assertEquals(1, deserializeRequest.getOptions().get("mirostat"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("temperature"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("mirostat_eta"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("mirostat_tau"));
+        assertEquals(1, deserializeRequest.getOptions().get("num_gpu"));
+        assertEquals(1, deserializeRequest.getOptions().get("seed"));
+        assertEquals(1, deserializeRequest.getOptions().get("top_k"));
+        assertEquals(1.0, deserializeRequest.getOptions().get("top_p"));
+    }
+
+    @Test
+    public void testWithJsonFormat() {
+        OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt")
+                .withGetJsonResponse().build();
+
+        String jsonRequest = serialize(req);
+        // no jackson deserialization as format property is not boolean ==> omit as deserialization
+        // of request is never used in real code anyways
+        JSONObject jsonObject = new JSONObject(jsonRequest);
+        String requestFormatProperty = jsonObject.getString("format");
+        assertEquals("json", requestFormatProperty);
+    }
+
+    @Test
+    public void testWithTemplate() {
+        OllamaChatRequestModel req = builder.withTemplate("System Template")
+            .build();
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest, OllamaChatRequestModel.class), req);
+    }
+
+    @Test
+    public void testWithStreaming() {
+        OllamaChatRequestModel req = builder.withStreaming().build();
+        String jsonRequest = serialize(req);
+        assertEquals(deserialize(jsonRequest, OllamaChatRequestModel.class).isStream(), true);
+    }
+
+    @Test
+    public void testWithKeepAlive() {
+        String expectedKeepAlive = "5m";
+        OllamaChatRequestModel req = builder.withKeepAlive(expectedKeepAlive)
+            .build();
+        String jsonRequest = serialize(req);
+        assertEquals(deserialize(jsonRequest, OllamaChatRequestModel.class).getKeepAlive(), expectedKeepAlive);
+    }
+}

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/TestEmbeddingsRequestSerialization.java

@@ -0,0 +1,37 @@
+package io.github.amithkoujalgi.ollama4j.unittests.jackson;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestBuilder;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+public class TestEmbeddingsRequestSerialization extends AbstractSerializationTest<OllamaEmbeddingsRequestModel> {
+
+        private OllamaEmbeddingsRequestBuilder builder;
+
+        @BeforeEach
+        public void init() {
+            builder = OllamaEmbeddingsRequestBuilder.getInstance("DummyModel","DummyPrompt");
+        }
+
+            @Test
+    public void testRequestOnlyMandatoryFields() {
+        OllamaEmbeddingsRequestModel req = builder.build();
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaEmbeddingsRequestModel.class), req);
+    }
+
+        @Test
+        public void testRequestWithOptions() {
+            OptionsBuilder b = new OptionsBuilder();
+            OllamaEmbeddingsRequestModel req = builder
+                    .withOptions(b.setMirostat(1).build()).build();
+
+            String jsonRequest = serialize(req);
+            OllamaEmbeddingsRequestModel deserializeRequest = deserialize(jsonRequest,OllamaEmbeddingsRequestModel.class);
+            assertEqualsAfterUnmarshalling(deserializeRequest, req);
+            assertEquals(1, deserializeRequest.getOptions().get("mirostat"));
+        }
+}

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/TestGenerateRequestSerialization.java

@@ -0,0 +1,56 @@
+package io.github.amithkoujalgi.ollama4j.unittests.jackson;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.json.JSONObject;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestBuilder;
+import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+public class TestGenerateRequestSerialization extends AbstractSerializationTest<OllamaGenerateRequestModel> {
+
+    private OllamaGenerateRequestBuilder builder;
+
+    @BeforeEach
+    public void init() {
+        builder = OllamaGenerateRequestBuilder.getInstance("DummyModel");
+    }
+
+    @Test
+    public void testRequestOnlyMandatoryFields() {
+        OllamaGenerateRequestModel req = builder.withPrompt("Some prompt").build();
+
+        String jsonRequest = serialize(req);
+        assertEqualsAfterUnmarshalling(deserialize(jsonRequest, OllamaGenerateRequestModel.class), req);
+    }
+
+    @Test
+    public void testRequestWithOptions() {
+        OptionsBuilder b = new OptionsBuilder();
+        OllamaGenerateRequestModel req =
+                builder.withPrompt("Some prompt").withOptions(b.setMirostat(1).build()).build();
+
+        String jsonRequest = serialize(req);
+        OllamaGenerateRequestModel deserializeRequest = deserialize(jsonRequest, OllamaGenerateRequestModel.class);
+        assertEqualsAfterUnmarshalling(deserializeRequest, req);
+        assertEquals(1, deserializeRequest.getOptions().get("mirostat"));
+    }
+
+    @Test
+    public void testWithJsonFormat() {
+        OllamaGenerateRequestModel req =
+                builder.withPrompt("Some prompt").withGetJsonResponse().build();
+
+        String jsonRequest = serialize(req);
+        // no jackson deserialization as format property is not boolean ==> omit as deserialization
+        // of request is never used in real code anyways
+        JSONObject jsonObject = new JSONObject(jsonRequest);
+        String requestFormatProperty = jsonObject.getString("format");
+        assertEquals("json", requestFormatProperty);
+    }
+
+}

src/test/java/io/github/amithkoujalgi/ollama4j/unittests/jackson/TestModelRequestSerialization.java

@@ -0,0 +1,42 @@
+package io.github.amithkoujalgi.ollama4j.unittests.jackson;
+
+import io.github.amithkoujalgi.ollama4j.core.models.Model;
+import org.junit.jupiter.api.Test;
+
+public class TestModelRequestSerialization extends AbstractSerializationTest<Model> {
+
+    @Test
+    public void testDeserializationOfModelResponseWithOffsetTime(){
+        String serializedTestStringWithOffsetTime = "{\n"
+                + "\"name\": \"codellama:13b\",\n"
+                + "\"modified_at\": \"2023-11-04T14:56:49.277302595-07:00\",\n"
+                + "\"size\": 7365960935,\n"
+                + "\"digest\": \"9f438cb9cd581fc025612d27f7c1a6669ff83a8bb0ed86c94fcf4c5440555697\",\n"
+                + "\"details\": {\n"
+                + "\"format\": \"gguf\",\n"
+                + "\"family\": \"llama\",\n"
+                + "\"families\": null,\n"
+                + "\"parameter_size\": \"13B\",\n"
+                + "\"quantization_level\": \"Q4_0\"\n"
+                + "}}";
+        deserialize(serializedTestStringWithOffsetTime,Model.class);
+    }
+
+    @Test
+    public void testDeserializationOfModelResponseWithZuluTime(){
+        String serializedTestStringWithZuluTimezone = "{\n"
+                + "\"name\": \"codellama:13b\",\n"
+                + "\"modified_at\": \"2023-11-04T14:56:49.277302595Z\",\n"
+                + "\"size\": 7365960935,\n"
+                + "\"digest\": \"9f438cb9cd581fc025612d27f7c1a6669ff83a8bb0ed86c94fcf4c5440555697\",\n"
+                + "\"details\": {\n"
+                + "\"format\": \"gguf\",\n"
+                + "\"family\": \"llama\",\n"
+                + "\"families\": null,\n"
+                + "\"parameter_size\": \"13B\",\n"
+                + "\"quantization_level\": \"Q4_0\"\n"
+                + "}}";
+        deserialize(serializedTestStringWithZuluTimezone,Model.class);
+    }
+
+}

src/test/resources/test-config.properties

@@ -1 +1,4 @@
-ollama.api.url=http://192.168.29.223:11434
+ollama.url=http://localhost:11434
+ollama.model=qwen:0.5b
+ollama.model.image=llava
+ollama.request-timeout-seconds=120