Updated README.md

Signed-off-by: Amith Koujalgi <koujalgi.amith@gmail.com>

.github/workflows/maven-publish.yml

@@ -1,68 +1,41 @@
 # This workflow will build a package using Maven and then publish it to GitHub packages when a release is created
 # For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
 
-name: Test and Publish Package
+name: Release Artifacts
-
-#on:
-#  release:
-#    types: [ "created" ]
 
 on:
-  push:
+  release:
-    branches: [ "main" ]
+    types: [ created ]
-  workflow_dispatch:
 
 jobs:
   build:
+
     runs-on: ubuntu-latest
     permissions:
-      contents: write
+      contents: read
       packages: write
+
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '11'
+          java-version: '17'
-          distribution: 'adopt-hotspot'
+          distribution: 'temurin'
           server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
           settings-path: ${{ github.workspace }} # location for the settings.xml file
+
+      - name: Find and Replace
+        uses: jacobtomlinson/gha-find-replace@v3
+        with:
+          find: "ollama4j-revision"
+          replace: ${{ github.ref_name }}
+          regex: false
+
       - name: Build with Maven
         run: mvn --file pom.xml -U clean package -Punit-tests
-      - name: Set up Apache Maven Central (Overwrite settings.xml)
+
-        uses: actions/setup-java@v3
-        with: # running setup-java again overwrites the settings.xml
-          java-version: '11'
-          distribution: 'adopt-hotspot'
-          cache: 'maven'
-          server-id: ossrh
-          server-username: MAVEN_USERNAME
-          server-password: MAVEN_PASSWORD
-          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
-          gpg-passphrase: MAVEN_GPG_PASSPHRASE
-      - name: Set up Maven cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-          restore-keys: |
-            ${{ 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: >
+        run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml --file pom.xml
-        #          github.event_name != 'pull_request' &&
-        #          github.ref_name == 'main' &&
-        #          contains(github.event.head_commit.message, 'release')
-        run: |
-          git config --global user.email "koujalgi.amith@gmail.com"
-          git config --global user.name "amithkoujalgi"
-          mvn -B -ntp -DskipTests -Pci-cd -Darguments="-DskipTests -Pci-cd" release:clean release:prepare release:perform
         env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          GITHUB_TOKEN: ${{ github.token }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
-          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

.github/workflows/publish-docs.yml

@@ -2,9 +2,8 @@
 name: Deploy Docs to GH Pages
 
 on:
-  # Runs on pushes targeting the default branch
+  release:
-  push:
+    types: [ created ]
-    branches: [ "main" ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -47,9 +46,22 @@ jobs:
       - run: cd docs && npm ci
       - run: cd docs && npm run build
 
+      - name: Find and Replace
+        uses: jacobtomlinson/gha-find-replace@v3
+        with:
+          find: "ollama4j-revision"
+          replace: ${{ github.ref_name }}
+          regex: false
+
       - 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

.github/workflows/publish-javadoc.yml

@@ -1,52 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy Javadoc content to Pages
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: [ "none" ]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-  packages: write
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    runs-on: ubuntu-latest
-
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up JDK 11
-        uses: actions/setup-java@v3
-        with:
-          java-version: '11'
-          distribution: 'adopt-hotspot'
-          server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
-          settings-path: ${{ github.workspace }} # location for the settings.xml file
-      - name: Build with Maven
-        run: mvn --file pom.xml -U clean package
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          # Upload entire repository
-          path: './target/apidocs/.'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

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,6 +7,9 @@ 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 \

README.md

@@ -1,3 +1,5 @@
+<div style="text-align: center">
+
 ### Ollama4j
 
 <img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
@@ -9,23 +11,36 @@ 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)
+![Contributors](https://img.shields.io/github/contributors/amithkoujalgi/ollama4j)
+![GitHub License](https://img.shields.io/github/license/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)
 
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/amithkoujalgi/ollama4j)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed-raw/amithkoujalgi/ollama4j)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-raw/amithkoujalgi/ollama4j)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/amithkoujalgi/ollama4j)
+![GitHub Discussions](https://img.shields.io/github/discussions/amithkoujalgi/ollama4j)
+
 ![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg)
 
+
+</div>
+
+[//]: # (![Hits]&#40;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&#41;)
+
+[//]: # (![GitHub language count]&#40;https://img.shields.io/github/languages/count/amithkoujalgi/ollama4j&#41;)
+
 ## Table of Contents
 
 - [How does it work?](#how-does-it-work)
 - [Requirements](#requirements)
 - [Installation](#installation)
-- [API Spec](#api-spec)
+- [API Spec](https://amithkoujalgi.github.io/ollama4j/docs/category/apis---model-management)
-- [Demo APIs](#try-out-the-apis-with-ollama-server)
+- [Javadoc](https://amithkoujalgi.github.io/ollama4j/apidocs/)
 - [Development](#development)
 - [Contributions](#get-involved)
 - [References](#references)
@@ -48,9 +63,9 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
 
 ![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-link] **Or** [![][ollama-docker-shield]][ollama-docker]
 
-[ollama]: https://ollama.ai/
+[ollama-link]: https://ollama.ai/
 
 [ollama-shield]: https://img.shields.io/badge/Ollama-Local_Installation-blue.svg?style=just-the-message&labelColor=gray
 
@@ -60,22 +75,93 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
 
 #### Installation
 
-In your Maven project, add this dependency:
+Check the releases [here](https://github.com/amithkoujalgi/ollama4j/releases) and update the dependency version
+according to your requirements.
+
+[![][ollama4j-releases-shield]][ollama4j-releases-link]
+
+[ollama4j-releases-link]: https://github.com/amithkoujalgi/ollama4j/releases
+
+[ollama4j-releases-shield]: https://img.shields.io/github/v/release/amithkoujalgi/ollama4j?include_prereleases&display_name=release&style=for-the-badge&label=Latest%20Release
+
+##### For Maven
+
+1. In your Maven project, add this dependency:
 
 ```xml
 
 <dependency>
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.29</version>
+  <version>1.0.74</version>
 </dependency>
 ```
 
-Latest release:
+2. Add repository to your project's pom.xml:
 
-![Maven Central](https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j)
+```xml
 
-[![][lib-shield]][lib]
+<repositories>
+    <repository>
+        <id>github</id>
+        <name>GitHub Apache Maven Packages</name>
+        <url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url>
+        <releases>
+            <enabled>true</enabled>
+        </releases>
+        <snapshots>
+            <enabled>true</enabled>
+        </snapshots>
+    </repository>
+</repositories>
+```
+
+3. Add GitHub server to settings.xml. (Usually available at ~/.m2/settings.xml)
+
+```xml
+
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
+    <servers>
+        <server>
+            <id>github</id>
+            <username>YOUR-USERNAME</username>
+            <password>YOUR-TOKEN</password>
+        </server>
+    </servers>
+</settings>
+```
+
+##### For Gradle
+
+In your Gradle project, add the dependency using the Kotlin DSL or the Groovy DSL:
+
+```kotlin
+dependencies {
+
+    val ollama4jVersion = "1.0.74"
+
+    implementation("io.github.amithkoujalgi:ollama4j:$ollama4jVersion")
+}
+ ```
+
+```groovy
+dependencies {
+    implementation("io.github.amithkoujalgi:ollama4j:1.0.74")
+}
+```
+
+[//]: # (Latest release:)
+
+[//]: # ()
+
+[//]: # (![Maven Central]&#40;https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j&#41;)
+
+[//]: # ()
+
+[//]: # ([![][lib-shield]][lib])
 
 [lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j
 
@@ -110,6 +196,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)
@@ -124,16 +220,19 @@ Actions CI workflow.
 - [x] Use lombok
 - [x] Update request body creation with Java objects
 - [ ] Async APIs for images
+- [ ] Support for function calling with models like Mistral
+    - [x] generate in sync mode
+    - [ ] generate in async mode
 - [ ] Add custom headers to requests
-- [ ] Add additional params for `ask` APIs such as:
+- [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).
-    - [ ] `system`: system prompt to (overrides what is defined in the Modelfile)
+    - [x] `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)
+    - [x] `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
+    - [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)
 
@@ -143,11 +242,28 @@ Contributions are most welcome! Whether it's reporting a bug, proposing an enhan
 with code - any sort
 of contribution is much appreciated.
 
+### References
+
+- [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md)
+
 ### Credits
 
 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)
+<div style="text-align: center">
+
+**Thanks to the amazing contributors**
+
+<a href="https://github.com/amithkoujalgi/ollama4j/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=amithkoujalgi/ollama4j" />
+</a>
+
+### Appreciate my work?
+
+<a href="https://www.buymeacoffee.com/amithkoujalgi" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
+
+
+</div>
+

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-generate/_category_.json

@@ -1,6 +1,6 @@
 {
-  "label": "APIs - Ask",
+  "label": "APIs - Generate",
-  "position": 10,
+  "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

@@ -1,8 +1,8 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 ---
 
-# 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) {
+            if (result != null) {
-                System.out.print(result.getResponse());
+                System.out.print(result);
             }
             Thread.sleep(100);
         }

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

@@ -1,8 +1,8 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
-# 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
@@ -15,7 +15,7 @@ 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

@@ -1,8 +1,8 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 ---
 
-# 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
@@ -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-with-tools.md

@@ -0,0 +1,271 @@
+---
+sidebar_position: 2
+---
+
+# Generate - With Tools
+
+This API lets you perform [function calling](https://docs.mistral.ai/capabilities/function_calling/) using LLMs in a
+synchronous way.
+This API correlates to
+the [generate](https://github.com/ollama/ollama/blob/main/docs/api.md#request-raw-mode) API with `raw` mode.
+
+:::note
+
+This is an only an experimental implementation and has a very basic design.
+
+Currently, built and tested for [Mistral's latest model](https://ollama.com/library/mistral) only. We could redesign
+this
+in the future if tooling is supported for more models with a generic interaction standard from Ollama.
+
+:::
+
+### Function Calling/Tools
+
+Assume you want to call a method in your code based on the response generated from the model.
+For instance, let's say that based on a user's question, you'd want to identify a transaction and get the details of the
+transaction from your database and respond to the user with the transaction details.
+
+You could do that with ease with the `function calling` capabilities of the models by registering your `tools`.
+
+### Create Functions
+
+This function takes the arguments `location` and `fuelType` and performs an operation with these arguments and returns a
+value.
+
+```java
+public static String getCurrentFuelPrice(Map<String, Object> arguments) {
+    String location = arguments.get("location").toString();
+    String fuelType = arguments.get("fuelType").toString();
+    return "Current price of " + fuelType + " in " + location + " is Rs.103/L";
+}
+```
+
+This function takes the argument `city` and performs an operation with the argument and returns a
+value.
+
+```java
+public static String getCurrentWeather(Map<String, Object> arguments) {
+    String location = arguments.get("city").toString();
+    return "Currently " + location + "'s weather is nice.";
+}
+```
+
+### Define Tool Specifications
+
+Lets define a sample tool specification called **Fuel Price Tool** for getting the current fuel price.
+
+- Specify the function `name`, `description`, and `required` properties (`location` and `fuelType`).
+- Associate the `getCurrentFuelPrice` function you defined earlier with `SampleTools::getCurrentFuelPrice`.
+
+```java
+MistralTools.ToolSpecification fuelPriceToolSpecification = MistralTools.ToolSpecification.builder()
+        .functionName("current-fuel-price")
+        .functionDesc("Get current fuel price")
+        .props(
+                new MistralTools.PropsBuilder()
+                        .withProperty("location", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build())
+                        .withProperty("fuelType", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The fuel type.").enumValues(Arrays.asList("petrol", "diesel")).required(true).build())
+                        .build()
+        )
+        .toolDefinition(SampleTools::getCurrentFuelPrice)
+        .build();
+```
+
+Lets also define a sample tool specification called **Weather Tool** for getting the current weather.
+
+- Specify the function `name`, `description`, and `required` property (`city`).
+- Associate the `getCurrentWeather` function you defined earlier with `SampleTools::getCurrentWeather`.
+
+```java
+MistralTools.ToolSpecification weatherToolSpecification = MistralTools.ToolSpecification.builder()
+        .functionName("current-weather")
+        .functionDesc("Get current weather")
+        .props(
+                new MistralTools.PropsBuilder()
+                        .withProperty("city", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build())
+                        .build()
+        )
+        .toolDefinition(SampleTools::getCurrentWeather)
+        .build();
+```
+
+### Register the Tools
+
+Register the defined tools (`fuel price` and `weather`) with the OllamaAPI.
+
+```shell
+ollamaAPI.registerTool(fuelPriceToolSpecification);
+ollamaAPI.registerTool(weatherToolSpecification);
+```
+
+### Create prompt with Tools
+
+`Prompt 1`: Create a prompt asking for the petrol price in Bengaluru using the defined fuel price and weather tools.
+
+```shell
+String prompt1 = new MistralTools.PromptBuilder()
+        .withToolSpecification(fuelPriceToolSpecification)
+        .withToolSpecification(weatherToolSpecification)
+        .withPrompt("What is the petrol price in Bengaluru?")
+        .build();
+OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt1, false, new OptionsBuilder().build());
+for (Map.Entry<ToolDef, Object> r : toolsResult.getToolResults().entrySet()) {
+  System.out.printf("[Response from tool '%s']: %s%n", r.getKey().getName(), r.getValue().toString());
+}
+```
+
+Now, fire away your question to the model.
+
+You will get a response similar to:
+
+::::tip[LLM Response]
+
+[Response from tool 'current-fuel-price']: Current price of petrol in Bengaluru is Rs.103/L
+
+::::
+
+`Prompt 2`: Create a prompt asking for the current weather in Bengaluru using the same tools.
+
+```shell
+String prompt2 = new MistralTools.PromptBuilder()
+        .withToolSpecification(fuelPriceToolSpecification)
+        .withToolSpecification(weatherToolSpecification)
+        .withPrompt("What is the current weather in Bengaluru?")
+        .build();
+OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt2, false, new OptionsBuilder().build());
+for (Map.Entry<ToolDef, Object> r : toolsResult.getToolResults().entrySet()) {
+  System.out.printf("[Response from tool '%s']: %s%n", r.getKey().getName(), r.getValue().toString());
+}
+```
+
+Again, fire away your question to the model.
+
+You will get a response similar to:
+
+::::tip[LLM Response]
+
+[Response from tool 'current-weather']: Currently Bengaluru's weather is nice
+::::
+
+### Full Example
+
+```java
+
+import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
+import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
+import io.github.amithkoujalgi.ollama4j.core.tools.ToolDef;
+import io.github.amithkoujalgi.ollama4j.core.tools.MistralTools;
+import io.github.amithkoujalgi.ollama4j.core.tools.OllamaToolsResult;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Map;
+
+public class FunctionCallingWithMistral {
+    public static void main(String[] args) throws Exception {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(60);
+
+        String model = "mistral";
+
+
+        MistralTools.ToolSpecification fuelPriceToolSpecification = MistralTools.ToolSpecification.builder()
+                .functionName("current-fuel-price")
+                .functionDesc("Get current fuel price")
+                .props(
+                        new MistralTools.PropsBuilder()
+                                .withProperty("location", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build())
+                                .withProperty("fuelType", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The fuel type.").enumValues(Arrays.asList("petrol", "diesel")).required(true).build())
+                                .build()
+                )
+                .toolDefinition(SampleTools::getCurrentFuelPrice)
+                .build();
+
+        MistralTools.ToolSpecification weatherToolSpecification = MistralTools.ToolSpecification.builder()
+                .functionName("current-weather")
+                .functionDesc("Get current weather")
+                .props(
+                        new MistralTools.PropsBuilder()
+                                .withProperty("city", MistralTools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build())
+                                .build()
+                )
+                .toolDefinition(SampleTools::getCurrentWeather)
+                .build();
+
+        ollamaAPI.registerTool(fuelPriceToolSpecification);
+        ollamaAPI.registerTool(weatherToolSpecification);
+
+        String prompt1 = new MistralTools.PromptBuilder()
+                .withToolSpecification(fuelPriceToolSpecification)
+                .withToolSpecification(weatherToolSpecification)
+                .withPrompt("What is the petrol price in Bengaluru?")
+                .build();
+        String prompt2 = new MistralTools.PromptBuilder()
+                .withToolSpecification(fuelPriceToolSpecification)
+                .withToolSpecification(weatherToolSpecification)
+                .withPrompt("What is the current weather in Bengaluru?")
+                .build();
+
+        ask(ollamaAPI, model, prompt1);
+        ask(ollamaAPI, model, prompt2);
+    }
+
+    public static void ask(OllamaAPI ollamaAPI, String model, String prompt) throws OllamaBaseException, IOException, InterruptedException {
+        OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt, false, new OptionsBuilder().build());
+        for (Map.Entry<ToolDef, Object> r : toolsResult.getToolResults().entrySet()) {
+            System.out.printf("[Response from tool '%s']: %s%n", r.getKey().getName(), r.getValue().toString());
+        }
+    }
+}
+
+class SampleTools {
+    public static String getCurrentFuelPrice(Map<String, Object> arguments) {
+        String location = arguments.get("location").toString();
+        String fuelType = arguments.get("fuelType").toString();
+        return "Current price of " + fuelType + " in " + location + " is Rs.103/L";
+    }
+
+    public static String getCurrentWeather(Map<String, Object> arguments) {
+        String location = arguments.get("city").toString();
+        return "Currently " + location + "'s weather is nice.";
+    }
+}
+
+```
+
+Run this full example and you will get a response similar to:
+
+::::tip[LLM Response]
+
+[Response from tool 'current-fuel-price']: Current price of petrol in Bengaluru is Rs.103/L
+
+[Response from tool 'current-weather']: Currently Bengaluru's weather is nice
+::::
+
+### Room for improvement
+
+Instead of explicitly registering `ollamaAPI.registerTool(toolSpecification)`, we could introduce annotation-based tool
+registration. For example:
+
+```java
+
+@ToolSpec(name = "current-fuel-price", desc = "Get current fuel price")
+public String getCurrentFuelPrice(Map<String, Object> arguments) {
+    String location = arguments.get("location").toString();
+    String fuelType = arguments.get("fuelType").toString();
+    return "Current price of " + fuelType + " in " + location + " is Rs.103/L";
+}
+```
+
+Instead of passing a map of args `Map<String, Object> arguments` to the tool functions, we could support passing
+specific args separately with their data types. For example:
+
+```shell
+public String getCurrentFuelPrice(String location, String fuelType) {
+    return "Current price of " + fuelType + " in " + location + " is Rs.103/L";
+}
+```
+
+Updating async/chat APIs with support for tool-based generation. 

docs/docs/apis-generate/generate.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# Ask - Sync
+# Generate - Sync
 
 This API lets you ask questions to the LLMs in a synchronous way.
 These APIs correlate to
@@ -11,7 +11,7 @@ the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#gener
 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).
+to [this](/apis-extras/options-builder).
 
 ## Try asking a question about the model.
 
@@ -25,7 +25,7 @@ public class Main {
         OllamaAPI ollamaAPI = new OllamaAPI(host);
 
         OllamaResult result =
-                ollamaAPI.ask(OllamaModelType.LLAMA2, "Who are you?", new OptionsBuilder().build());
+                ollamaAPI.generate(OllamaModelType.LLAMA2, "Who are you?", new OptionsBuilder().build());
 
         System.out.println(result.getResponse());
     }
@@ -41,6 +41,42 @@ 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
@@ -55,7 +91,7 @@ public class Main {
         String prompt = "List all cricket world cup teams of 2019.";
 
         OllamaResult result =
-                ollamaAPI.ask(OllamaModelType.LLAMA2, prompt, new OptionsBuilder().build());
+                ollamaAPI.generate(OllamaModelType.LLAMA2, prompt, new OptionsBuilder().build());
 
         System.out.println(result.getResponse());
     }
@@ -97,7 +133,7 @@ public class Main {
                 SamplePrompts.getSampleDatabasePromptWithQuestion(
                         "List all customer names who have bought one or more products");
         OllamaResult result =
-                ollamaAPI.ask(OllamaModelType.SQLCODER, prompt, new OptionsBuilder().build());
+                ollamaAPI.generate(OllamaModelType.SQLCODER, prompt, new OptionsBuilder().build());
         System.out.println(result.getResponse());
     }
 }

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

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 ---
 
 # Prompt Builder
@@ -42,7 +42,7 @@ public class AskPhi {
                         .addSeparator()
                         .add("How do I read a file in Go and print its contents to stdout?");
 
-        OllamaResult response = ollamaAPI.ask(model, promptBuilder.build());
+        OllamaResult response = ollamaAPI.generate(model, promptBuilder.build(), new OptionsBuilder().build());
         System.out.println(response.getResponse());
     }
 }

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/docusaurus.config.js

@@ -40,6 +40,8 @@ const config = {
             /** @type {import('@docusaurus/preset-classic').Options} */
             ({
                 docs: {
+                    path: 'docs',
+                    routeBasePath: '', // change this to any URL route you'd want. For example: `home` - if you want /home/intro.
                     sidebarPath: './sidebars.js',
                     // Please change this to your repo.
                     // Remove this to remove the "edit this page" links.
@@ -79,6 +81,7 @@ const config = {
                         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',
@@ -95,7 +98,7 @@ const config = {
                         items: [
                             {
                                 label: 'Tutorial',
-                                to: '/docs/intro',
+                                to: '/intro',
                             },
                         ],
                     },

docs/package.json

@@ -14,9 +14,9 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.0.1",
+    "@docusaurus/core": "^3.4.0",
-    "@docusaurus/preset-classic": "3.0.1",
+    "@docusaurus/preset-classic": "^3.4.0",
-    "@docusaurus/theme-mermaid": "^3.0.1",
+    "@docusaurus/theme-mermaid": "^3.4.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "prism-react-renderer": "^2.3.0",
@@ -24,8 +24,8 @@
     "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.0.1",
+    "@docusaurus/module-type-aliases": "^3.4.0",
-    "@docusaurus/types": "3.0.1"
+    "@docusaurus/types": "^3.4.0"
   },
   "browserslist": {
     "production": [

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: #2e8555;
-  --ifm-color-primary-dark: #29784c;
+    --ifm-color-primary-dark: #29784c;
-  --ifm-color-primary-darker: #277148;
+    --ifm-color-primary-darker: #277148;
-  --ifm-color-primary-darkest: #205d3b;
+    --ifm-color-primary-darkest: #205d3b;
-  --ifm-color-primary-light: #33925d;
+    --ifm-color-primary-light: #33925d;
-  --ifm-color-primary-lighter: #359962;
+    --ifm-color-primary-lighter: #359962;
-  --ifm-color-primary-lightest: #3cad6e;
+    --ifm-color-primary-lightest: #3cad6e;
-  --ifm-code-font-size: 95%;
+    --ifm-code-font-size: 95%;
-  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+    --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: #25c2a0;
-  --ifm-color-primary-dark: #21af90;
+    --ifm-color-primary-dark: #21af90;
-  --ifm-color-primary-darker: #1fa588;
+    --ifm-color-primary-darker: #1fa588;
-  --ifm-color-primary-darkest: #1a8870;
+    --ifm-color-primary-darkest: #1a8870;
-  --ifm-color-primary-light: #29d5b0;
+    --ifm-color-primary-light: #29d5b0;
-  --ifm-color-primary-lighter: #32d8b4;
+    --ifm-color-primary-lighter: #32d8b4;
-  --ifm-color-primary-lightest: #4fddbf;
+    --ifm-color-primary-lightest: #4fddbf;
-  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+    --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;
+}

docs/src/pages/index.js

@@ -19,7 +19,7 @@ function HomepageHeader() {
             <div className={styles.buttons}>
                 <Link
                     className="button button--secondary button--lg"
-                    to="/docs/intro">
+                    to="/intro">
                     Getting Started
                 </Link>
             </div>

maven-publish.yml

@@ -0,0 +1,68 @@
+## This workflow will build a package using Maven and then publish it to GitHub packages when a release is created
+## For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
+#
+#name: Test and Publish Package
+#
+##on:
+##  release:
+##    types: [ "created" ]
+#
+#on:
+#  push:
+#    branches: [ "main" ]
+#  workflow_dispatch:
+#
+#jobs:
+#  build:
+#    runs-on: ubuntu-latest
+#    permissions:
+#      contents: write
+#      packages: write
+#    steps:
+#      - uses: actions/checkout@v3
+#      - name: Set up JDK 11
+#        uses: actions/setup-java@v3
+#        with:
+#          java-version: '11'
+#          distribution: 'adopt-hotspot'
+#          server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
+#          settings-path: ${{ github.workspace }} # location for the settings.xml file
+#      - name: Build with Maven
+#        run: mvn --file pom.xml -U clean package -Punit-tests
+#      - name: Set up Apache Maven Central (Overwrite settings.xml)
+#        uses: actions/setup-java@v3
+#        with: # running setup-java again overwrites the settings.xml
+#          java-version: '11'
+#          distribution: 'adopt-hotspot'
+#          cache: 'maven'
+#          server-id: ossrh
+#          server-username: MAVEN_USERNAME
+#          server-password: MAVEN_PASSWORD
+#          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+#          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+#      - name: Set up Maven cache
+#        uses: actions/cache@v3
+#        with:
+#          path: ~/.m2/repository
+#          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+#          restore-keys: |
+#            ${{ 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.ref_name == 'main' &&
+#        #          contains(github.event.head_commit.message, 'release')
+#        run: |
+#          git config --global user.email "koujalgi.amith@gmail.com"
+#          git config --global user.name "amithkoujalgi"
+#          mvn -B -ntp -DskipTests -Pci-cd -Darguments="-DskipTests -Pci-cd" release:clean release:prepare release:perform
+#        env:
+#          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+#          MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+#          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

pom.xml

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.42</version>
+    <version>ollama4j-revision</version>
 
-  <name>Ollama4j</name>
+    <name>Ollama4j</name>
-  <description>Java library for interacting with Ollama API.</description>
+    <description>Java library for interacting with Ollama API.</description>
-  <url>https://github.com/amithkoujalgi/ollama4j</url>
+    <url>https://github.com/amithkoujalgi/ollama4j</url>
+    <packaging>jar</packaging>
 
-  <properties>
+    <properties>
-    <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.source>11</maven.compiler.source>
-    <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.target>11</maven.compiler.target>
-    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
+        <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
-    <maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
+        <maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
-    <lombok.version>1.18.30</lombok.version>
+        <lombok.version>1.18.30</lombok.version>
-  </properties>
+    </properties>
 
     <developers>
         <developer>
@@ -28,273 +30,293 @@
         </developer>
     </developers>
 
-  <licenses>
+    <licenses>
-    <license>
+        <license>
-      <name>MIT License</name>
+            <name>MIT License</name>
-      <url>https://raw.githubusercontent.com/amithkoujalgi/ollama4j/main/LICENSE</url>
+            <url>https://raw.githubusercontent.com/amithkoujalgi/ollama4j/main/LICENSE</url>
-    </license>
+        </license>
-  </licenses>
+    </licenses>
 
-  <scm>
+    <scm>
-    <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
+        <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
-    <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
+        <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
-    <url>https://github.com/amithkoujalgi/ollama4j</url>
+        <url>https://github.com/amithkoujalgi/ollama4j</url>
-    <tag>v1.0.42</tag>
+        <tag>v1.0.16</tag>
-  </scm>
+    </scm>
 
-  <build>
+    <build>
-    <plugins>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-source-plugin</artifactId>
-        <version>3.3.0</version>
-        <executions>
-          <execution>
-            <id>attach-sources</id>
-            <goals>
-              <goal>jar-no-fork</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.5.0</version>
-        <executions>
-          <execution>
-            <id>attach-javadocs</id>
-            <goals>
-              <goal>jar</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-      <!--            <plugin>-->
-      <!--                <groupId>org.apache.maven.plugins</groupId>-->
-      <!--                <artifactId>maven-gpg-plugin</artifactId>-->
-      <!--                <version>1.5</version>-->
-      <!--                <executions>-->
-      <!--                    <execution>-->
-      <!--                        <id>sign-artifacts</id>-->
-      <!--                        <phase>verify</phase>-->
-      <!--                        <goals>-->
-      <!--                            <goal>sign</goal>-->
-      <!--                        </goals>-->
-      <!--                        <configuration>-->
-      <!--                            &lt;!&ndash; This is necessary for gpg to not try to use the pinentry programs &ndash;&gt;-->
-      <!--                            <gpgArguments>-->
-      <!--                                <arg>&#45;&#45;pinentry-mode</arg>-->
-      <!--                                <arg>loopback</arg>-->
-      <!--                            </gpgArguments>-->
-      <!--                        </configuration>-->
-      <!--                    </execution>-->
-      <!--                </executions>-->
-      <!--            </plugin>-->
-      <!-- Surefire Plugin for Unit Tests -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-surefire-plugin</artifactId>
-        <version>${maven-surefire-plugin.version}</version>
-        <configuration>
-          <skipTests>${skipUnitTests}</skipTests>
-          <includes>
-            <include>**/unittests/*.java</include>
-          </includes>
-        </configuration>
-      </plugin>
-
-      <!-- Failsafe Plugin for Integration Tests -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-failsafe-plugin</artifactId>
-        <version>${maven-failsafe-plugin.version}</version>
-        <configuration>
-          <includes>
-            <include>**/integrationtests/*.java</include>
-          </includes>
-          <excludes>
-            <exclude>**/unittests/*.java</exclude>
-          </excludes>
-          <skipTests>${skipIntegrationTests}</skipTests>
-        </configuration>
-        <executions>
-          <execution>
-            <goals>
-              <goal>integration-test</goal>
-              <goal>verify</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-release-plugin</artifactId>
-        <version>3.0.1</version>
-        <configuration>
-          <!--                    <goals>install</goals>-->
-          <tagNameFormat>v@{project.version}</tagNameFormat>
-        </configuration>
-      </plugin>
-    </plugins>
-  </build>
-
-  <dependencies>
-    <dependency>
-      <groupId>org.projectlombok</groupId>
-      <artifactId>lombok</artifactId>
-      <version>${lombok.version}</version>
-      <scope>provided</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.fasterxml.jackson.core</groupId>
-      <artifactId>jackson-databind</artifactId>
-      <version>2.15.3</version>
-    </dependency>
-    <dependency>
-      <groupId>ch.qos.logback</groupId>
-      <artifactId>logback-classic</artifactId>
-      <version>1.4.12</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-api</artifactId>
-      <version>2.0.9</version>
-    </dependency>
-    <dependency>
-      <groupId>org.junit.jupiter</groupId>
-      <artifactId>junit-jupiter-api</artifactId>
-      <version>5.10.0</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>org.mockito</groupId>
-      <artifactId>mockito-core</artifactId>
-      <version>4.1.0</version>
-      <scope>test</scope>
-    </dependency>
-  </dependencies>
-
-  <distributionManagement>
-    <snapshotRepository>
-      <id>ossrh</id>
-      <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
-    </snapshotRepository>
-    <repository>
-      <id>ossrh</id>
-      <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>
-    </repository>
-  </distributionManagement>
-
-  <profiles>
-    <profile>
-      <id>unit-tests</id>
-      <properties>
-        <test.env>unit</test.env>
-        <skipUnitTests>false</skipUnitTests>
-        <skipIntegrationTests>true</skipIntegrationTests>
-      </properties>
-      <activation>
-        <activeByDefault>true</activeByDefault>
-      </activation>
-      <build>
         <plugins>
-          <plugin>
+            <plugin>
-            <groupId>org.jacoco</groupId>
+                <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>jacoco-maven-plugin</artifactId>
+                <artifactId>maven-source-plugin</artifactId>
-            <version>0.8.7</version>
+                <version>3.3.0</version>
-            <executions>
+                <executions>
-              <execution>
+                    <execution>
-                <goals>
+                        <id>attach-sources</id>
-                  <goal>prepare-agent</goal>
+                        <goals>
-                </goals>
+                            <goal>jar-no-fork</goal>
-              </execution>
+                        </goals>
-              <execution>
+                    </execution>
-                <id>report</id>
+                </executions>
-                <phase>test</phase>
+            </plugin>
-                <goals>
+            <plugin>
-                  <goal>report</goal>
+                <groupId>org.apache.maven.plugins</groupId>
-                </goals>
+                <artifactId>maven-javadoc-plugin</artifactId>
-              </execution>
+                <version>3.5.0</version>
-            </executions>
+                <executions>
-          </plugin>
+                    <execution>
-        </plugins>
+                        <id>attach-javadocs</id>
-      </build>
+                        <goals>
-    </profile>
+                            <goal>jar</goal>
-    <profile>
+                        </goals>
-      <id>integration-tests</id>
+                    </execution>
-      <properties>
+                </executions>
-        <test.env>integration</test.env>
+            </plugin>
-        <skipUnitTests>true</skipUnitTests>
+            <!--            <plugin>-->
-        <skipIntegrationTests>false</skipIntegrationTests>
+            <!--                <groupId>org.apache.maven.plugins</groupId>-->
-      </properties>
+            <!--                <artifactId>maven-gpg-plugin</artifactId>-->
-    </profile>
+            <!--                <version>1.5</version>-->
-    <profile>
+            <!--                <executions>-->
-      <id>ci-cd</id>
+            <!--                    <execution>-->
-      <properties>
+            <!--                        <id>sign-artifacts</id>-->
-        <test.env>unit</test.env>
+            <!--                        <phase>verify</phase>-->
-        <skipUnitTests>true</skipUnitTests>
+            <!--                        <goals>-->
-        <skipIntegrationTests>true</skipIntegrationTests>
+            <!--                            <goal>sign</goal>-->
-      </properties>
+            <!--                        </goals>-->
-      <build>
+            <!--                        <configuration>-->
-        <plugins>
+            <!--                            &lt;!&ndash; This is necessary for gpg to not try to use the pinentry programs &ndash;&gt;-->
-          <plugin>
+            <!--                            <gpgArguments>-->
-            <groupId>org.apache.maven.plugins</groupId>
+            <!--                                <arg>&#45;&#45;pinentry-mode</arg>-->
-            <artifactId>maven-gpg-plugin</artifactId>
+            <!--                                <arg>loopback</arg>-->
-            <version>3.1.0</version>
+            <!--                            </gpgArguments>-->
-            <executions>
+            <!--                        </configuration>-->
-              <execution>
+            <!--                    </execution>-->
-                <id>sign-artifacts</id>
+            <!--                </executions>-->
-                <phase>verify</phase>
+            <!--            </plugin>-->
-                <goals>
+            <!-- Surefire Plugin for Unit Tests -->
-                  <goal>sign</goal>
+            <plugin>
-                </goals>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${maven-surefire-plugin.version}</version>
                 <configuration>
-                  <!-- Prevent gpg from using pinentry programs. Fixes:
+                    <skipTests>${skipUnitTests}</skipTests>
-                       gpg: signing failed: Inappropriate ioctl for device -->
+                    <includes>
-                  <gpgArguments>
+                        <include>**/unittests/**/*.java</include>
-                    <arg>--pinentry-mode</arg>
+                    </includes>
-                    <arg>loopback</arg>
-                  </gpgArguments>
                 </configuration>
-              </execution>
+            </plugin>
-            </executions>
-          </plugin>
-          <plugin>
-            <groupId>org.sonatype.plugins</groupId>
-            <artifactId>nexus-staging-maven-plugin</artifactId>
-            <version>1.6.13</version>
-            <extensions>true</extensions>
-            <configuration>
-              <serverId>ossrh</serverId>
-              <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
-              <autoReleaseAfterClose>true</autoReleaseAfterClose>
-            </configuration>
-          </plugin>
 
-          <plugin>
+            <!-- Failsafe Plugin for Integration Tests -->
-            <groupId>org.jacoco</groupId>
+            <plugin>
-            <artifactId>jacoco-maven-plugin</artifactId>
+                <groupId>org.apache.maven.plugins</groupId>
-            <version>0.8.7</version>
+                <artifactId>maven-failsafe-plugin</artifactId>
-            <executions>
+                <version>${maven-failsafe-plugin.version}</version>
-              <execution>
+                <configuration>
-                <goals>
+                    <includes>
-                  <goal>prepare-agent</goal>
+                        <include>**/integrationtests/*.java</include>
-                </goals>
+                    </includes>
-              </execution>
+                    <excludes>
-              <execution>
+                        <exclude>**/unittests/*.java</exclude>
-                <id>report</id>
+                    </excludes>
-                <phase>test</phase>
+                    <skipTests>${skipIntegrationTests}</skipTests>
-                <goals>
+                </configuration>
-                  <goal>report</goal>
+                <executions>
-                </goals>
+                    <execution>
-              </execution>
+                        <goals>
-            </executions>
+                            <goal>integration-test</goal>
-          </plugin>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <!--            <plugin>-->
+            <!--                <groupId>org.apache.maven.plugins</groupId>-->
+            <!--                <artifactId>maven-release-plugin</artifactId>-->
+            <!--                <version>3.0.1</version>-->
+            <!--                <configuration>-->
+            <!--                    &lt;!&ndash;                    <goals>install</goals>&ndash;&gt;-->
+            <!--                    <tagNameFormat>v@{project.version}</tagNameFormat>-->
+            <!--                </configuration>-->
+            <!--            </plugin>-->
         </plugins>
-      </build>
+    </build>
-    </profile>
+
-  </profiles>
+    <dependencies>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>${lombok.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.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.5.6</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>2.0.9</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>5.10.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>4.1.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20240205</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <!--    <distributionManagement>-->
+    <!--        <snapshotRepository>-->
+    <!--            <id>ossrh</id>-->
+    <!--            <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>-->
+    <!--        </snapshotRepository>-->
+    <!--        <repository>-->
+    <!--            <id>ossrh</id>-->
+    <!--            <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>-->
+    <!--        </repository>-->
+    <!--    </distributionManagement>-->
+
+    <!--    Replaced publishing packages to GitHub Packages instead of Maven central -->
+    <distributionManagement>
+        <repository>
+            <id>github</id>
+            <name>GitHub Packages</name>
+            <url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url>
+        </repository>
+    </distributionManagement>
+
+    <profiles>
+        <profile>
+            <id>unit-tests</id>
+            <properties>
+                <test.env>unit</test.env>
+                <skipUnitTests>false</skipUnitTests>
+                <skipIntegrationTests>true</skipIntegrationTests>
+            </properties>
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.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>
+            <properties>
+                <test.env>integration</test.env>
+                <skipUnitTests>true</skipUnitTests>
+                <skipIntegrationTests>false</skipIntegrationTests>
+            </properties>
+        </profile>
+        <profile>
+            <id>ci-cd</id>
+            <properties>
+                <test.env>unit</test.env>
+                <skipUnitTests>true</skipUnitTests>
+                <skipIntegrationTests>true</skipIntegrationTests>
+            </properties>
+            <build>
+                <plugins>
+                    <!--                    <plugin>-->
+                    <!--                        <groupId>org.apache.maven.plugins</groupId>-->
+                    <!--                        <artifactId>maven-gpg-plugin</artifactId>-->
+                    <!--                        <version>3.1.0</version>-->
+                    <!--                        <executions>-->
+                    <!--                            <execution>-->
+                    <!--                                <id>sign-artifacts</id>-->
+                    <!--                                <phase>verify</phase>-->
+                    <!--                                <goals>-->
+                    <!--                                    <goal>sign</goal>-->
+                    <!--                                </goals>-->
+                    <!--                                <configuration>-->
+                    <!--                                    &lt;!&ndash; Prevent gpg from using pinentry programs. Fixes:-->
+                    <!--                                         gpg: signing failed: Inappropriate ioctl for device &ndash;&gt;-->
+                    <!--                                    <gpgArguments>-->
+                    <!--                                        <arg>&#45;&#45;pinentry-mode</arg>-->
+                    <!--                                        <arg>loopback</arg>-->
+                    <!--                                    </gpgArguments>-->
+                    <!--                                </configuration>-->
+                    <!--                            </execution>-->
+                    <!--                        </executions>-->
+                    <!--                    </plugin>-->
+                    <!--                    <plugin>-->
+                    <!--                        <groupId>org.sonatype.plugins</groupId>-->
+                    <!--                        <artifactId>nexus-staging-maven-plugin</artifactId>-->
+                    <!--                        <version>1.6.13</version>-->
+                    <!--                        <extensions>true</extensions>-->
+                    <!--                        <configuration>-->
+                    <!--                            <serverId>ossrh</serverId>-->
+                    <!--                            <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>-->
+                    <!--                            <autoReleaseAfterClose>true</autoReleaseAfterClose>-->
+                    <!--                        </configuration>-->
+                    <!--                    </plugin>-->
+
+                    <plugin>
+                        <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.7</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>prepare-agent</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>report</id>
+                                <phase>test</phase>
+                                <goals>
+                                    <goal>report</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
 
 </project>

src/main/java/io/github/amithkoujalgi/ollama4j/core/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/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,6 +1,8 @@
 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;
@@ -22,7 +24,7 @@ import lombok.Getter;
 @SuppressWarnings("unused")
 public class OllamaAsyncResultCallback extends Thread {
   private final HttpRequest.Builder requestBuilder;
-  private final OllamaRequestModel ollamaRequestModel;
+  private final OllamaGenerateRequestModel ollamaRequestModel;
   private final Queue<String> queue = new LinkedList<>();
   private String result;
   private boolean isDone;
@@ -47,7 +49,7 @@ public class OllamaAsyncResultCallback extends Thread {
 
   public OllamaAsyncResultCallback(
       HttpRequest.Builder requestBuilder,
-      OllamaRequestModel ollamaRequestModel,
+      OllamaGenerateRequestModel ollamaRequestModel,
       long requestTimeoutSeconds) {
     this.requestBuilder = requestBuilder;
     this.ollamaRequestModel = ollamaRequestModel;
@@ -87,8 +89,8 @@ public class OllamaAsyncResultCallback extends Thread {
             queue.add(ollamaResponseModel.getError());
             responseBuffer.append(ollamaResponseModel.getError());
           } else {
-            OllamaResponseModel ollamaResponseModel =
+            OllamaGenerateResponseModel ollamaResponseModel =
-                Utils.getObjectMapper().readValue(line, OllamaResponseModel.class);
+                Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class);
             queue.add(ollamaResponseModel.getResponse());
             if (!ollamaResponseModel.isDone()) {
               responseBuffer.append(ollamaResponseModel.getResponse());

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/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

@@ -1,31 +1,28 @@
-package io.github.amithkoujalgi.ollama4j.core.models;
+package io.github.amithkoujalgi.ollama4j.core.models.embeddings;
 
 import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
-
-import com.fasterxml.jackson.core.JsonProcessingException;
-import java.util.List;
 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
-public class OllamaRequestModel {
+@RequiredArgsConstructor
-
+@NoArgsConstructor
+public class OllamaEmbeddingsRequestModel {
+  @NonNull
   private String model;
+  @NonNull
   private String prompt;
-  private List<String> images;
-  private Map<String, Object> options;
 
-  public OllamaRequestModel(String model, String prompt) {
+  protected Map<String, Object> options;
-    this.model = model;
+  @JsonProperty(value = "keep_alive")
-    this.prompt = prompt;
+  private String keepAlive;
-  }
-
-  public OllamaRequestModel(String model, String prompt, List<String> images) {
-    this.model = model;
-    this.prompt = prompt;
-    this.images = images;
-  }
 
+  @Override
   public String toString() {
     try {
       return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);

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,52 @@
+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.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;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+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/tools/DynamicFunction.java

@@ -0,0 +1,8 @@
+package io.github.amithkoujalgi.ollama4j.core.tools;
+
+import java.util.Map;
+
+@FunctionalInterface
+public interface DynamicFunction {
+    Object apply(Map<String, Object> arguments);
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/tools/MistralTools.java

@@ -0,0 +1,139 @@
+package io.github.amithkoujalgi.ollama4j.core.tools;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class MistralTools {
+    @Data
+    @Builder
+    public static class ToolSpecification {
+        private String functionName;
+        private String functionDesc;
+        private Map<String, PromptFuncDefinition.Property> props;
+        private DynamicFunction toolDefinition;
+    }
+
+    @Data
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class PromptFuncDefinition {
+        private String type;
+        private PromptFuncSpec function;
+
+        @Data
+        public static class PromptFuncSpec {
+            private String name;
+            private String description;
+            private Parameters parameters;
+        }
+
+        @Data
+        public static class Parameters {
+            private String type;
+            private Map<String, Property> properties;
+            private List<String> required;
+        }
+
+        @Data
+        @Builder
+        public static class Property {
+            private String type;
+            private String description;
+            @JsonProperty("enum")
+            @JsonInclude(JsonInclude.Include.NON_NULL)
+            private List<String> enumValues;
+            @JsonIgnore
+            private boolean required;
+        }
+    }
+
+    public static class PropsBuilder {
+        private final Map<String, PromptFuncDefinition.Property> props = new HashMap<>();
+
+        public PropsBuilder withProperty(String key, PromptFuncDefinition.Property property) {
+            props.put(key, property);
+            return this;
+        }
+
+        public Map<String, PromptFuncDefinition.Property> build() {
+            return props;
+        }
+    }
+
+    public static class PromptBuilder {
+        private final List<PromptFuncDefinition> tools = new ArrayList<>();
+
+        private String promptText;
+
+        public String build() throws JsonProcessingException {
+            return "[AVAILABLE_TOOLS] " + Utils.getObjectMapper().writeValueAsString(tools) + "[/AVAILABLE_TOOLS][INST] " + promptText + " [/INST]";
+        }
+
+        public PromptBuilder withPrompt(String prompt) throws JsonProcessingException {
+            promptText = prompt;
+            return this;
+        }
+
+        public PromptBuilder withToolSpecification(ToolSpecification spec) {
+            PromptFuncDefinition def = new PromptFuncDefinition();
+            def.setType("function");
+
+            PromptFuncDefinition.PromptFuncSpec functionDetail = new PromptFuncDefinition.PromptFuncSpec();
+            functionDetail.setName(spec.getFunctionName());
+            functionDetail.setDescription(spec.getFunctionDesc());
+
+            PromptFuncDefinition.Parameters parameters = new PromptFuncDefinition.Parameters();
+            parameters.setType("object");
+            parameters.setProperties(spec.getProps());
+
+            List<String> requiredValues = new ArrayList<>();
+            for (Map.Entry<String, PromptFuncDefinition.Property> p : spec.getProps().entrySet()) {
+                if (p.getValue().isRequired()) {
+                    requiredValues.add(p.getKey());
+                }
+            }
+            parameters.setRequired(requiredValues);
+            functionDetail.setParameters(parameters);
+            def.setFunction(functionDetail);
+
+            tools.add(def);
+            return this;
+        }
+//
+//        public PromptBuilder withToolSpecification(String functionName, String functionDesc, Map<String, PromptFuncDefinition.Property> props) {
+//            PromptFuncDefinition def = new PromptFuncDefinition();
+//            def.setType("function");
+//
+//            PromptFuncDefinition.PromptFuncSpec functionDetail = new PromptFuncDefinition.PromptFuncSpec();
+//            functionDetail.setName(functionName);
+//            functionDetail.setDescription(functionDesc);
+//
+//            PromptFuncDefinition.Parameters parameters = new PromptFuncDefinition.Parameters();
+//            parameters.setType("object");
+//            parameters.setProperties(props);
+//
+//            List<String> requiredValues = new ArrayList<>();
+//            for (Map.Entry<String, PromptFuncDefinition.Property> p : props.entrySet()) {
+//                if (p.getValue().isRequired()) {
+//                    requiredValues.add(p.getKey());
+//                }
+//            }
+//            parameters.setRequired(requiredValues);
+//            functionDetail.setParameters(parameters);
+//            def.setFunction(functionDetail);
+//
+//            tools.add(def);
+//            return this;
+//        }
+    }
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/tools/OllamaToolsResult.java

@@ -0,0 +1,16 @@
+package io.github.amithkoujalgi.ollama4j.core.tools;
+
+import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.Map;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class OllamaToolsResult {
+    private OllamaResult modelResult;
+    private Map<ToolDef, Object> toolResults;
+}

src/main/java/io/github/amithkoujalgi/ollama4j/core/tools/ToolDef.java

@@ -0,0 +1,18 @@
+package io.github.amithkoujalgi.ollama4j.core.tools;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.Map;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class ToolDef {
+
+    private String name;
+    private Map<String, Object> arguments;
+
+}
+

src/main/java/io/github/amithkoujalgi/ollama4j/core/tools/ToolRegistry.java

@@ -0,0 +1,17 @@
+package io.github.amithkoujalgi.ollama4j.core.tools;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class ToolRegistry {
+    private static final Map<String, DynamicFunction> functionMap = new HashMap<>();
+
+
+    public static DynamicFunction getFunction(String name) {
+        return functionMap.get(name);
+    }
+
+    public static void addFunction(String name, DynamicFunction function) {
+        functionMap.put(name, function);
+    }
+}

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

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

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/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 {
+
+  private static ObjectMapper objectMapper;
+
   public static ObjectMapper getObjectMapper() {
-    return new ObjectMapper();
+    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

@@ -1,86 +1,395 @@
 package io.github.amithkoujalgi.ollama4j.integrationtests;
 
-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.OllamaEmbeddingsRequestBuilder;
+import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+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;
+
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.ConnectException;
 import java.net.URISyntaxException;
 import java.net.http.HttpConnectTimeoutException;
+import java.util.List;
+import java.util.Objects;
 import java.util.Properties;
-import org.junit.jupiter.api.BeforeEach;
+
-import org.junit.jupiter.api.Order;
+import static org.junit.jupiter.api.Assertions.*;
-import org.junit.jupiter.api.Test;
 
 class TestRealAPIs {
-  OllamaAPI ollamaAPI;
 
-  private Properties loadProperties() {
+    private static final Logger LOG = LoggerFactory.getLogger(TestRealAPIs.class);
-    Properties properties = new Properties();
+
-    try (InputStream input =
+    OllamaAPI ollamaAPI;
-        getClass().getClassLoader().getResourceAsStream("test-config.properties")) {
+    Config config;
-      if (input == null) {
+
-        throw new RuntimeException("Sorry, unable to find test-config.properties");
+    private File getImageFileFromClasspath(String fileName) {
-      }
+        ClassLoader classLoader = getClass().getClassLoader();
-      properties.load(input);
+        return new File(Objects.requireNonNull(classLoader.getResource(fileName)).getFile());
-      return properties;
-    } catch (IOException e) {
-      throw new RuntimeException("Error loading properties", e);
     }
-  }
 
-  @BeforeEach
+    @BeforeEach
-  void setUp() {
+    void setUp() {
-    Properties properties = loadProperties();
+        config = new Config();
-    ollamaAPI = new OllamaAPI(properties.getProperty("ollama.api.url"));
+        ollamaAPI = new OllamaAPI(config.getOllamaURL());
-  }
+        ollamaAPI.setRequestTimeoutSeconds(config.getRequestTimeoutSeconds());
-
-  @Test
-  @Order(1)
-  void testWrongEndpoint() {
-    OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434");
-    assertThrows(ConnectException.class, ollamaAPI::listModels);
-  }
-
-  @Test
-  @Order(1)
-  void testEndpointReachability() {
-    try {
-      assertNotNull(ollamaAPI.listModels());
-    } catch (HttpConnectTimeoutException e) {
-      fail(e.getMessage());
-    } catch (Exception e) {
-      throw new RuntimeException(e);
     }
-  }
 
-  @Test
+    @Test
-  @Order(2)
+    @Order(1)
-  void testListModels() {
+    void testWrongEndpoint() {
-    testEndpointReachability();
+        OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434");
-    try {
+        assertThrows(ConnectException.class, ollamaAPI::listModels);
-      assertNotNull(ollamaAPI.listModels());
-      ollamaAPI.listModels().forEach(System.out::println);
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
     }
-  }
 
-  @Test
+    @Test
-  @Order(2)
+    @Order(1)
-  void testPullModel() {
+    void testEndpointReachability() {
-    testEndpointReachability();
+        try {
-    try {
+            assertNotNull(ollamaAPI.listModels());
-      ollamaAPI.pullModel(OllamaModelType.LLAMA2);
+        } catch (HttpConnectTimeoutException e) {
-      boolean found =
+            fail(e.getMessage());
-          ollamaAPI.listModels().stream()
+        } catch (Exception e) {
-              .anyMatch(model -> model.getModelName().equals(OllamaModelType.LLAMA2));
+            fail(e);
-      assertTrue(found);
+        }
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+    }
-      throw new RuntimeException(e);
+
+    @Test
+    @Order(2)
+    void testListModels() {
+        testEndpointReachability();
+        try {
+            assertNotNull(ollamaAPI.listModels());
+            ollamaAPI.listModels().forEach(System.out::println);
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+            fail(e);
+        }
+    }
+
+    @Test
+    @Order(2)
+    void testPullModel() {
+        testEndpointReachability();
+        try {
+            ollamaAPI.pullModel(config.getModel());
+            boolean found =
+                    ollamaAPI.listModels().stream()
+                            .anyMatch(model -> model.getModel().equalsIgnoreCase(config.getModel()));
+            assertTrue(found);
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException 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?",
+                            false,
+                            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?",
+                    false,
+                    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?",
+                            true,
+                            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

@@ -1,7 +1,5 @@
 package io.github.amithkoujalgi.ollama4j.unittests;
 
-import static org.mockito.Mockito.*;
-
 import io.github.amithkoujalgi.ollama4j.core.OllamaAPI;
 import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
 import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail;
@@ -9,147 +7,158 @@ 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 org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
 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;
+import static org.mockito.Mockito.*;
 
 class TestMockedAPIs {
-  @Test
+    @Test
-  void testPullModel() {
+    void testPullModel() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    try {
+        try {
-      doNothing().when(ollamaAPI).pullModel(model);
+            doNothing().when(ollamaAPI).pullModel(model);
-      ollamaAPI.pullModel(model);
+            ollamaAPI.pullModel(model);
-      verify(ollamaAPI, times(1)).pullModel(model);
+            verify(ollamaAPI, times(1)).pullModel(model);
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testListModels() {
+    void testListModels() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    try {
+        try {
-      when(ollamaAPI.listModels()).thenReturn(new ArrayList<>());
+            when(ollamaAPI.listModels()).thenReturn(new ArrayList<>());
-      ollamaAPI.listModels();
+            ollamaAPI.listModels();
-      verify(ollamaAPI, times(1)).listModels();
+            verify(ollamaAPI, times(1)).listModels();
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testCreateModel() {
+    void testCreateModel() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String modelFilePath = "FROM llama2\nSYSTEM You are mario from Super Mario Bros.";
+        String modelFilePath = "FROM llama2\nSYSTEM You are mario from Super Mario Bros.";
-    try {
+        try {
-      doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath);
+            doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath);
-      ollamaAPI.createModelWithModelFileContents(model, modelFilePath);
+            ollamaAPI.createModelWithModelFileContents(model, modelFilePath);
-      verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath);
+            verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath);
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testDeleteModel() {
+    void testDeleteModel() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    try {
+        try {
-      doNothing().when(ollamaAPI).deleteModel(model, true);
+            doNothing().when(ollamaAPI).deleteModel(model, true);
-      ollamaAPI.deleteModel(model, true);
+            ollamaAPI.deleteModel(model, true);
-      verify(ollamaAPI, times(1)).deleteModel(model, true);
+            verify(ollamaAPI, times(1)).deleteModel(model, true);
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testGetModelDetails() {
+    void testGetModelDetails() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    try {
+        try {
-      when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail());
+            when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail());
-      ollamaAPI.getModelDetails(model);
+            ollamaAPI.getModelDetails(model);
-      verify(ollamaAPI, times(1)).getModelDetails(model);
+            verify(ollamaAPI, times(1)).getModelDetails(model);
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testGenerateEmbeddings() {
+    void testGenerateEmbeddings() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String prompt = "some prompt text";
+        String prompt = "some prompt text";
-    try {
+        try {
-      when(ollamaAPI.generateEmbeddings(model, prompt)).thenReturn(new ArrayList<>());
+            when(ollamaAPI.generateEmbeddings(model, prompt)).thenReturn(new ArrayList<>());
-      ollamaAPI.generateEmbeddings(model, prompt);
+            ollamaAPI.generateEmbeddings(model, prompt);
-      verify(ollamaAPI, times(1)).generateEmbeddings(model, prompt);
+            verify(ollamaAPI, times(1)).generateEmbeddings(model, prompt);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testAsk() {
+    void testAsk() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String prompt = "some prompt text";
+        String prompt = "some prompt text";
-    OptionsBuilder optionsBuilder = new OptionsBuilder();
+        OptionsBuilder optionsBuilder = new OptionsBuilder();
-    try {
+        try {
-      when(ollamaAPI.ask(model, prompt, optionsBuilder.build()))
+            when(ollamaAPI.generate(model, prompt, false, optionsBuilder.build()))
-          .thenReturn(new OllamaResult("", 0, 200));
+                    .thenReturn(new OllamaResult("", 0, 200));
-      ollamaAPI.ask(model, prompt, optionsBuilder.build());
+            ollamaAPI.generate(model, prompt, false, optionsBuilder.build());
-      verify(ollamaAPI, times(1)).ask(model, prompt, optionsBuilder.build());
+            verify(ollamaAPI, times(1)).generate(model, prompt, false, optionsBuilder.build());
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+        } catch (IOException | OllamaBaseException | InterruptedException e) {
-      throw new RuntimeException(e);
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testAskWithImageFiles() {
+    void testAskWithImageFiles() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String prompt = "some prompt text";
+        String prompt = "some prompt text";
-    try {
+        try {
-      when(ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList()))
+            when(ollamaAPI.generateWithImageFiles(
-          .thenReturn(new OllamaResult("", 0, 200));
+                    model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
-      ollamaAPI.askWithImageFiles(model, prompt, Collections.emptyList());
+                    .thenReturn(new OllamaResult("", 0, 200));
-      verify(ollamaAPI, times(1)).askWithImageFiles(model, prompt, Collections.emptyList());
+            ollamaAPI.generateWithImageFiles(
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+                    model, prompt, Collections.emptyList(), new OptionsBuilder().build());
-      throw new RuntimeException(e);
+            verify(ollamaAPI, times(1))
+                    .generateWithImageFiles(
+                            model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+        } catch (IOException | OllamaBaseException | InterruptedException e) {
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testAskWithImageURLs() {
+    void testAskWithImageURLs() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String prompt = "some prompt text";
+        String prompt = "some prompt text";
-    try {
+        try {
-      when(ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList()))
+            when(ollamaAPI.generateWithImageURLs(
-          .thenReturn(new OllamaResult("", 0, 200));
+                    model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
-      ollamaAPI.askWithImageURLs(model, prompt, Collections.emptyList());
+                    .thenReturn(new OllamaResult("", 0, 200));
-      verify(ollamaAPI, times(1)).askWithImageURLs(model, prompt, Collections.emptyList());
+            ollamaAPI.generateWithImageURLs(
-    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+                    model, prompt, Collections.emptyList(), new OptionsBuilder().build());
-      throw new RuntimeException(e);
+            verify(ollamaAPI, times(1))
+                    .generateWithImageURLs(
+                            model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+        } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+            throw new RuntimeException(e);
+        }
     }
-  }
 
-  @Test
+    @Test
-  void testAskAsync() {
+    void testAskAsync() {
-    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+        OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
-    String model = OllamaModelType.LLAMA2;
+        String model = OllamaModelType.LLAMA2;
-    String prompt = "some prompt text";
+        String prompt = "some prompt text";
-    when(ollamaAPI.askAsync(model, prompt))
+        when(ollamaAPI.generateAsync(model, prompt, false))
-        .thenReturn(new OllamaAsyncResultCallback(null, null, 3));
+                .thenReturn(new OllamaAsyncResultCallback(null, null, 3));
-    ollamaAPI.askAsync(model, prompt);
+        ollamaAPI.generateAsync(model, prompt, false);
-    verify(ollamaAPI, times(1)).askAsync(model, prompt);
+        verify(ollamaAPI, times(1)).generateAsync(model, prompt, false);
-  }
+    }
 }

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