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

Adds model property to Model Type

.github/workflows/maven-publish.yml

@@ -3,14 +3,14 @@
 
 name: Test and Publish Package
 
-on:
-  release:
-    types: [ "created" ]
-
 #on:
-#  push:
-#    branches: [ "main" ]
-#  workflow_dispatch:
+#  release:
+#    types: [ "created" ]
+
+on:
+  push:
+    branches: [ "main" ]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -49,6 +49,10 @@ jobs:
             ${{ runner.os }}-maven-
       - name: Build
         run: mvn -B -ntp clean install
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       - name: Publish to GitHub Packages Apache Maven
         #        if: >
         #          github.event_name != 'pull_request' &&

.github/workflows/publish-docs.yml

@@ -1,5 +1,5 @@
 # Simple workflow for deploying static content to GitHub Pages
-name: Deploy Javadoc content to Pages
+name: Deploy Docs to GH Pages
 
 on:
   # Runs on pushes targeting the default branch
@@ -30,6 +30,15 @@ jobs:
       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
+
       - uses: actions/checkout@v4
       - name: Use Node.js
         uses: actions/setup-node@v3
@@ -38,8 +47,15 @@ jobs:
       - run: cd docs && npm ci
       - run: cd docs && npm run build
 
-#      - name: Build with npm
-#        run: npm i && npm run build
+      - name: Build with Maven
+        run: mvn --file pom.xml -U clean package && cp -r ./target/apidocs/. ./docs/build/apidocs
+
+      - name: Doxygen Action
+        uses: mattnotmitt/doxygen-action@v1.1.0
+        with:
+          doxyfile-path: "./Doxyfile"
+          working-directory: "."
+
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

Doxyfile

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

Makefile

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

docs/blog/2019-05-28-first-blog-post.md

@@ -1,12 +0,0 @@
----
-slug: first-blog-post
-title: First Blog Post
-authors:
-  name: Gao Wei
-  title: Docusaurus Core Team
-  url: https://github.com/wgao19
-  image_url: https://github.com/wgao19.png
-tags: [hola, docusaurus]
----
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

docs/blog/2019-05-29-long-blog-post.md

@@ -1,44 +0,0 @@
----
-slug: long-blog-post
-title: Long Blog Post
-authors: endi
-tags: [hello, docusaurus]
----
-
-This is the summary of a very long blog post,
-
-Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
-
-<!--truncate-->
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

docs/blog/2021-08-01-mdx-blog-post.mdx

@@ -1,20 +0,0 @@
----
-slug: mdx-blog-post
-title: MDX Blog Post
-authors: [slorber]
-tags: [docusaurus]
----
-
-Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
-
-:::tip
-
-Use the power of React to create interactive blog posts.
-
-```js
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-```
-
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-
-:::

docs/blog/2021-08-26-welcome/index.md

@@ -1,25 +0,0 @@
----
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
----
-
-[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
-
-Simply add Markdown files (or folders) to the `blog` directory.
-
-Regular blog authors can be added to `authors.yml`.
-
-The blog post date can be extracted from filenames, such as:
-
-- `2019-05-30-welcome.md`
-- `2019-05-30-welcome/index.md`
-
-A blog post folder can be convenient to co-locate blog post images:
-
-![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
-
-The blog supports tags as well!
-
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

docs/blog/2023-12-01-welcome/index.md

@@ -0,0 +1,9 @@
+---
+slug: welcome
+title: Welcome
+authors: [ amith ]
+tags: [ Java, AI, LLM, GenAI, GenerativeAI, Ollama, Ollama4J, OpenSource, Developers
+]
+---
+
+Welcome Java Developers!

docs/blog/2023-12-22-release-post.md

@@ -0,0 +1,66 @@
+---
+slug: release-post
+title: Release
+authors: [ amith ]
+tags: [ Java, AI, LLM, GenAI, GenerativeAI, Ollama, Ollama4j, OpenSource, Developers
+]
+---
+
+Hey there, my fellow Java Developers! 🚀
+
+I am glad to announce the release of Ollama4j, a library that unites Ollama (an LLM manager and runner) and your Java
+applications! 🌐🚀
+
+👉 GitHub Repository: Ollama4j on GitHub (https://github.com/amithkoujalgi/ollama4j)
+
+🌟 Key Features:
+
+- Easy integration with Ollama, enabling the execution of large language models locally.
+- Clean and simple APIs, focused on seamless interaction with Ollama.
+- Empowers Java developers to harness the full capabilities of Ollama.
+- Provides APIs to perform operations such as listing, pulling, deleting models, and creating custom models.
+- Provides APIs to ask questions (generate completions) to the LLMs in synchronous and asynchronous modes.
+- Ability to ask questions along with image files or image URLs! 🤩
+- Open-source and primed for collaborative contributions from the community!
+
+🦙 What is Ollama?
+
+Ollama is an advanced AI tool that allows users to easily set up and run large language models locally (in CPU and GPU
+modes). With Ollama, users can leverage powerful language models such as Llama 2 and even customize and create their own
+models.
+
+For more details about Ollama, check these out:
+
+- https://ollama.ai/
+- https://www.linkedin.com/company/ollama/
+
+👨‍💻 Why Ollama4j?
+
+As a Java developer passionate about harnessing the latest advancements in AI, I realized the need for a simple and
+efficient way to integrate Ollama into Java applications. That's why I authored Ollama4j!
+
+🔧 How to Get Started:
+
+Visit the GitHub repository: Ollama4j on GitHub.
+
+Follow the easy setup instructions in the README to integrate Ollama into your Java projects.
+
+Start unlocking the potential of large language models in your applications!
+
+🙏 Contributions Welcome:
+
+I invite the Java developer community to explore, use, and contribute to Ollama4j. Your feedback, suggestions, and
+contributions will help this library get better.
+
+I am excited about the possibilities that Ollama4j opens up for Java developers. Whether you're working on natural
+language processing, chatbots, or any application that can benefit from advanced language models, Ollama4j is here to
+elevate your projects.
+
+I look forward to seeing the incredible applications/projects you'll build with Ollama4j! 🌟
+
+Find the full API spec here: https://amithkoujalgi.github.io/ollama4j/
+
+Find the Javadoc here: https://amithkoujalgi.github.io/ollama4j/apidocs/
+
+Ollama4j Docs is powered by [Docusaurus](https://docusaurus.io).
+

docs/blog/authors.yml

@@ -1,17 +1,5 @@
-endi:
-  name: Endilie Yacop Sucipto
-  title: Maintainer of Docusaurus
-  url: https://github.com/endiliey
-  image_url: https://github.com/endiliey.png
-
-yangshun:
-  name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
-  image_url: https://github.com/yangshun.png
-
-slorber:
-  name: Sébastien Lorber
-  title: Docusaurus maintainer
-  url: https://sebastienlorber.com
-  image_url: https://github.com/slorber.png
+amith:
+  name: Amith Koujalgi
+  title: Maintainer of Ollama4j
+  url: https://github.com/amithkoujalgi
+  image_url: https://github.com/amithkoujalgi.png

docs/docs/apis-ask/_category_.json

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

docs/docs/apis-ask/ask-async.md

@@ -0,0 +1,42 @@
+---
+sidebar_position: 2
+---
+
+# Generate - Async
+
+This API lets you ask questions to the LLMs in a asynchronous way.
+These APIs correlate to
+the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        String prompt = "Who are you?";
+
+        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 (result != null) {
+                System.out.print(result);
+            }
+            Thread.sleep(100);
+        }
+    }
+}
+```
+
+You will get a response similar to:
+
+> I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational
+> manner. I am trained on a massive dataset of text from the internet and can generate human-like responses to a wide
+> range of topics and questions. I can be used to create chatbots, virtual assistants, and other applications that
+> require
+> natural language understanding and generation capabilities.

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

@@ -0,0 +1,44 @@
+---
+sidebar_position: 3
+---
+
+# Generate - With Image Files
+
+This API lets you ask questions along with the image files to the LLMs.
+These APIs correlate to
+the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
+
+:::note
+
+Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
+recommended.
+
+:::
+
+## Synchronous mode
+
+If you have this image downloaded and you pass the path to the downloaded image to the following code:
+
+![Img](https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg)
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(10);
+
+        OllamaResult result = ollamaAPI.generateWithImageFiles(OllamaModelType.LLAVA,
+                "What's in this image?",
+                List.of(
+                        new File("/path/to/image")));
+        System.out.println(result.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> This image features a white boat with brown cushions, where a dog is sitting on the back of the boat. The dog seems to
+> be enjoying its time outdoors, perhaps on a lake.

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

@@ -0,0 +1,44 @@
+---
+sidebar_position: 4
+---
+
+# Generate - With Image URLs
+
+This API lets you ask questions along with the image files to the LLMs.
+These APIs correlate to
+the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
+
+:::note
+
+Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
+recommended.
+
+:::
+
+## Ask (Sync)
+
+Passing the link of this image the following code:
+
+![Img](https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg)
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(10);
+
+        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"));
+        System.out.println(result.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> This image features a white boat with brown cushions, where a dog is sitting on the back of the boat. The dog seems to
+> be enjoying its time outdoors, perhaps on a lake.

docs/docs/apis-ask/ask.md

@@ -0,0 +1,118 @@
+---
+sidebar_position: 1
+---
+
+# Generate - Sync
+
+This API lets you ask questions to the LLMs in a synchronous way.
+These APIs correlate to
+the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
+
+Use the `OptionBuilder` to build the `Options` object
+with [extra parameters](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values).
+Refer
+to [this](/docs/apis-extras/options-builder).
+
+## Try asking a question about the model.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.LLAMA2, "Who are you?", new OptionsBuilder().build());
+
+        System.out.println(result.getResponse());
+    }
+}
+
+```
+
+You will get a response similar to:
+
+> I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational
+> manner. I am trained on a massive dataset of text from the internet and can generate human-like responses to a wide
+> range of topics and questions. I can be used to create chatbots, virtual assistants, and other applications that
+> require
+> natural language understanding and generation capabilities.
+
+## Try asking a question from general topics.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        String prompt = "List all cricket world cup teams of 2019.";
+
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.LLAMA2, prompt, new OptionsBuilder().build());
+
+        System.out.println(result.getResponse());
+    }
+}
+
+```
+
+You'd then get a response from the model:
+
+> The 2019 ICC Cricket World Cup was held in England and Wales from May 30 to July 14, 2019. The
+> following teams
+> participated in the tournament:
+>
+> 1. Afghanistan
+> 2. Australia
+> 3. Bangladesh
+> 4. England
+> 5. India
+> 6. New Zealand
+> 7. Pakistan
+> 8. South Africa
+> 9. Sri Lanka
+> 10. West Indies
+>
+> These teams competed in a round-robin format, with the top four teams advancing to the
+> semi-finals. The tournament was
+> won by the England cricket team, who defeated New Zealand in the final.
+
+## Try asking for a Database query for your data schema.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        String prompt =
+                SamplePrompts.getSampleDatabasePromptWithQuestion(
+                        "List all customer names who have bought one or more products");
+        OllamaResult result =
+                ollamaAPI.generate(OllamaModelType.SQLCODER, prompt, new OptionsBuilder().build());
+        System.out.println(result.getResponse());
+    }
+}
+
+```
+
+_Note: Here I've used
+a [sample prompt](https://github.com/amithkoujalgi/ollama4j/blob/main/src/main/resources/sample-db-prompt-template.txt)
+containing a database schema from within this library for demonstration purposes._
+
+You'd then get a response from the model:
+
+```sql
+SELECT customers.name
+FROM sales
+         JOIN customers ON sales.customer_id = customers.customer_id
+GROUP BY customers.name;
+```

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

@@ -0,0 +1,46 @@
+---
+sidebar_position: 6
+---
+
+# Generate Embeddings
+
+Generate embeddings from a model.
+
+Parameters:
+
+- `model`: name of model to generate embeddings from
+- `prompt`: text to generate embeddings for
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        List<Double> embeddings = ollamaAPI.generateEmbeddings(OllamaModelType.LLAMA2,
+                "Here is an article about llamas...");
+
+        embeddings.forEach(System.out::println);
+    }
+}
+```
+
+You will get a response similar to:
+
+```javascript
+ [
+    0.5670403838157654,
+    0.009260174818336964,
+    0.23178744316101074,
+    -0.2916173040866852,
+    -0.8924556970596313,
+    0.8785552978515625,
+    -0.34576427936553955,
+    0.5742510557174683,
+    -0.04222835972905159,
+    -0.137906014919281
+]
+```

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

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

docs/docs/apis-extras/_category_.json

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

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

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

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

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

docs/docs/apis-extras/ping.md

@@ -0,0 +1,20 @@
+---
+sidebar_position: 3
+---
+
+# Ping
+
+This API lets you check the reachability of Ollama server.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        
+        ollamaAPI.ping();
+    }
+}
+```

docs/docs/apis-extras/request-timeout.md

@@ -0,0 +1,21 @@
+---
+sidebar_position: 2
+---
+
+# Set Request Timeout
+
+This API lets you set the request timeout for the Ollama client.
+
+```java
+public class Main {
+
+  public static void main(String[] args) {
+
+    String host = "http://localhost:11434/";
+
+    OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+    ollamaAPI.setRequestTimeoutSeconds(10);
+  }
+}
+```

docs/docs/apis-extras/verbosity.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 1
+---
+
+# Set Verbosity
+
+This API lets you set the verbosity of the Ollama client.
+
+## Try asking a question about the model.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.setVerbose(true);
+    }
+}
+```

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

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

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

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

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 5
+---
+
+# Delete Model
+
+This API lets you create a delete a model from the Ollama server.
+
+```java title="DeleteModel.java"
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.setVerbose(false);
+
+        ollamaAPI.deleteModel("mycustommodel", true);
+    }
+}
+
+```
+
+Once deleted, you can verify it using [list models](./list-models) API.

docs/docs/apis-model-management/list-models.md

@@ -0,0 +1,30 @@
+---
+sidebar_position: 1
+---
+
+# List Models
+
+This API lets you list available models on the Ollama server.
+
+```java title="ListModels.java"
+public class ListModels {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        List<Model> models = ollamaAPI.listModels();
+
+        models.forEach(model -> System.out.println(model.getName()));
+    }
+}
+```
+
+If you have any models already downloaded on Ollama server, you would have them listed as follows:
+
+```bash
+llama2:latest
+sqlcoder:latest
+```

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

@@ -0,0 +1,23 @@
+---
+sidebar_position: 2
+---
+
+# Pull Model
+
+This API lets you pull a model on the Ollama server.
+
+```java title="PullModel.java"
+public class Main {
+
+    public static void main(String[] args) {
+        
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.pullModel(OllamaModelType.LLAMA2);
+    }
+}
+```
+
+Once downloaded, you can see them when you use [list models](./list-models) API.

docs/docs/intro.md

@@ -2,46 +2,132 @@
 sidebar_position: 1
 ---
 
-# Tutorial Intro
+# Introduction
 
-Let's discover **Docusaurus in less than 5 minutes**.
+Let's get started with **Ollama4j**.
+
+## 🦙 What is Ollama?
+
+[Ollama](https://ollama.ai/) is an advanced AI tool that allows users to easily set up and run large language models
+locally (in CPU and GPU
+modes). With Ollama, users can leverage powerful language models such as Llama 2 and even customize and create their own
+models.
+
+## 👨‍💻 Why Ollama4j?
+
+Ollama4j was built for the simple purpose of integrating Ollama with Java applications.
+
+```mermaid
+  flowchart LR
+    o4j[Ollama4j]
+    o[Ollama Server]
+    o4j -->|Communicates with| o;
+    m[Models]
+    p[Your Java Project]
+    subgraph Your Java Environment
+        direction TB
+        p -->|Uses| o4j
+    end
+    subgraph Ollama Setup
+        direction TB
+        o -->|Manages| m
+    end
+```
 
 ## Getting Started
 
-Get started by **creating a new site**.
-
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
-
 ### What you'll need
 
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+- **[Ollama](https://ollama.ai/download)**
+- **[Oracle JDK](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)** or
+  **[Open JDK](https://jdk.java.net/archive/)** 11.0 or above.
+- **[Maven](https://maven.apache.org/download.cgi)**
 
-## Generate a new site
+### Start Ollama server
 
-Generate a new Docusaurus site using the **classic template**.
+The easiest way of getting started with Ollama server is with [Docker](https://docs.docker.com/get-started/overview/).
+But if you choose to run the
+Ollama server directly, **[download](https://ollama.ai/download)** the distribution of your choice
+and follow the installation process.
 
-The classic template will automatically be added to your project after you run the command:
+#### With Docker
+
+##### Run in CPU mode:
 
 ```bash
-npm init docusaurus@latest my-website classic
+docker run -it -v ~/ollama:/root/.ollama -p 11434:11434 ollama/ollama
 ```
 
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
-
-The command also installs all necessary dependencies you need to run Docusaurus.
-
-## Start your site
-
-Run the development server:
+##### Run in GPU mode:
 
 ```bash
-cd my-website
-npm run start
+docker run -it --gpus=all -v ~/ollama:/root/.ollama -p 11434:11434 ollama/ollama
 ```
 
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+You can type this command into Command Prompt, Powershell, Terminal, or any other integrated
+terminal of your code editor.
 
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+The command runs the Ollama server locally at **http://localhost:11434/**.
 
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
+### Setup your project
+
+Get started by **creating a new Maven project** on your favorite IDE.
+
+Add the dependency to your project's `pom.xml`.
+
+```xml
+
+<dependency>
+    <groupId>io.github.amithkoujalgi</groupId>
+    <artifactId>ollama4j</artifactId>
+    <version>1.0.27</version>
+</dependency>
+```
+
+Find the latest version of the library [here](https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j).
+
+You might want to include an implementation of [SL4J](https://www.slf4j.org/) logger in your `pom.xml` file. For
+example,
+
+Use `slf4j-jdk14` implementation:
+
+```xml
+
+<dependency>
+    <groupId>org.slf4j</groupId>
+    <artifactId>slf4j-jdk14</artifactId>
+    <version>2.0.9</version> <!--Replace with appropriate version-->
+</dependency>
+```
+
+or use `logback-classic` implementation:
+
+```xml
+
+<dependency>
+    <groupId>ch.qos.logback</groupId>
+    <artifactId>logback-classic</artifactId>
+    <version>1.3.11</version> <!--Replace with appropriate version-->
+</dependency>
+```
+
+or use other suitable implementations.
+
+Create a new Java class in your project and add this code.
+
+```java
+public class OllamaAPITest {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        ollamaAPI.setVerbose(true);
+
+        boolean isOllamaServerReachable = ollamaAPI.ping();
+
+        System.out.println("Is Ollama server alive: " + isOllamaServerReachable);
+    }
+}
+```

docs/docs/tutorial-basics/_category_.json

@@ -1,8 +0,0 @@
-{
-  "label": "Tutorial - Basics",
-  "position": 2,
-  "link": {
-    "type": "generated-index",
-    "description": "5 minutes to learn the most important Docusaurus concepts."
-  }
-}

docs/docs/tutorial-basics/congratulations.md

@@ -1,23 +0,0 @@
----
-sidebar_position: 6
----
-
-# Congratulations!
-
-You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
-
-Docusaurus has **much more to offer**!
-
-Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
-
-Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
-
-## What's next?
-
-- Read the [official documentation](https://docusaurus.io/)
-- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
-- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
-- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
-- Add a [search bar](https://docusaurus.io/docs/search)
-- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
-- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)

docs/docs/tutorial-basics/create-a-blog-post.md

@@ -1,34 +0,0 @@
----
-sidebar_position: 3
----
-
-# Create a Blog Post
-
-Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
-
-## Create your first Post
-
-Create a file at `blog/2021-02-28-greetings.md`:
-
-```md title="blog/2021-02-28-greetings.md"
----
-slug: greetings
-title: Greetings!
-authors:
-  - name: Joel Marcey
-    title: Co-creator of Docusaurus 1
-    url: https://github.com/JoelMarcey
-    image_url: https://github.com/JoelMarcey.png
-  - name: Sébastien Lorber
-    title: Docusaurus maintainer
-    url: https://sebastienlorber.com
-    image_url: https://github.com/slorber.png
-tags: [greetings]
----
-
-Congratulations, you have made your first post!
-
-Feel free to play around and edit this post as much you like.
-```
-
-A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).

docs/docs/tutorial-basics/create-a-document.md

@@ -1,57 +0,0 @@
----
-sidebar_position: 2
----
-
-# Create a Document
-
-Documents are **groups of pages** connected through:
-
-- a **sidebar**
-- **previous/next navigation**
-- **versioning**
-
-## Create your first Doc
-
-Create a Markdown file at `docs/hello.md`:
-
-```md title="docs/hello.md"
-# Hello
-
-This is my **first Docusaurus document**!
-```
-
-A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
-
-## Configure the Sidebar
-
-Docusaurus automatically **creates a sidebar** from the `docs` folder.
-
-Add metadata to customize the sidebar label and position:
-
-```md title="docs/hello.md" {1-4}
----
-sidebar_label: 'Hi!'
-sidebar_position: 3
----
-
-# Hello
-
-This is my **first Docusaurus document**!
-```
-
-It is also possible to create your sidebar explicitly in `sidebars.js`:
-
-```js title="sidebars.js"
-export default {
-  tutorialSidebar: [
-    'intro',
-    // highlight-next-line
-    'hello',
-    {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
-    },
-  ],
-};
-```

docs/docs/tutorial-basics/create-a-page.md

@@ -1,43 +0,0 @@
----
-sidebar_position: 1
----
-
-# Create a Page
-
-Add **Markdown or React** files to `src/pages` to create a **standalone page**:
-
-- `src/pages/index.js` → `localhost:3000/`
-- `src/pages/foo.md` → `localhost:3000/foo`
-- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
-
-## Create your first React Page
-
-Create a file at `src/pages/my-react-page.js`:
-
-```jsx title="src/pages/my-react-page.js"
-import React from 'react';
-import Layout from '@theme/Layout';
-
-export default function MyReactPage() {
-  return (
-    <Layout>
-      <h1>My React page</h1>
-      <p>This is a React page</p>
-    </Layout>
-  );
-}
-```
-
-A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
-
-## Create your first Markdown Page
-
-Create a file at `src/pages/my-markdown-page.md`:
-
-```mdx title="src/pages/my-markdown-page.md"
-# My Markdown page
-
-This is a Markdown page
-```
-
-A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).

docs/docs/tutorial-basics/deploy-your-site.md

@@ -1,31 +0,0 @@
----
-sidebar_position: 5
----
-
-# Deploy your site
-
-Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
-
-It builds your site as simple **static HTML, JavaScript and CSS files**.
-
-## Build your site
-
-Build your site **for production**:
-
-```bash
-npm run build
-```
-
-The static files are generated in the `build` folder.
-
-## Deploy your site
-
-Test your production build locally:
-
-```bash
-npm run serve
-```
-
-The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
-
-You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).

docs/docs/tutorial-basics/markdown-features.mdx

@@ -1,150 +0,0 @@
----
-sidebar_position: 4
----
-
-# Markdown Features
-
-Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
-
-## Front Matter
-
-Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
-
-```text title="my-doc.md"
-// highlight-start
----
-id: my-doc-id
-title: My document title
-description: My document description
-slug: /my-custom-url
----
-// highlight-end
-
-## Markdown heading
-
-Markdown text with [links](./hello.md)
-```
-
-## Links
-
-Regular Markdown links are supported, using url paths or relative file paths.
-
-```md
-Let's see how to [Create a page](/create-a-page).
-```
-
-```md
-Let's see how to [Create a page](./create-a-page.md).
-```
-
-**Result:** Let's see how to [Create a page](./create-a-page.md).
-
-## Images
-
-Regular Markdown images are supported.
-
-You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
-
-```md
-![Docusaurus logo](/img/docusaurus.png)
-```
-
-![Docusaurus logo](/img/docusaurus.png)
-
-You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
-
-```md
-![Docusaurus logo](./img/docusaurus.png)
-```
-
-## Code Blocks
-
-Markdown code blocks are supported with Syntax highlighting.
-
-    ```jsx title="src/components/HelloDocusaurus.js"
-    function HelloDocusaurus() {
-        return (
-            <h1>Hello, Docusaurus!</h1>
-        )
-    }
-    ```
-
-```jsx title="src/components/HelloDocusaurus.js"
-function HelloDocusaurus() {
-  return <h1>Hello, Docusaurus!</h1>;
-}
-```
-
-## Admonitions
-
-Docusaurus has a special syntax to create admonitions and callouts:
-
-    :::tip My tip
-
-    Use this awesome feature option
-
-    :::
-
-    :::danger Take care
-
-    This action is dangerous
-
-    :::
-
-:::tip My tip
-
-Use this awesome feature option
-
-:::
-
-:::danger Take care
-
-This action is dangerous
-
-:::
-
-## MDX and React Components
-
-[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
-
-```jsx
-export const Highlight = ({children, color}) => (
-  <span
-    style={{
-      backgroundColor: color,
-      borderRadius: '20px',
-      color: '#fff',
-      padding: '10px',
-      cursor: 'pointer',
-    }}
-    onClick={() => {
-      alert(`You clicked the color ${color} with label ${children}`)
-    }}>
-    {children}
-  </span>
-);
-
-This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
-
-This is <Highlight color="#1877F2">Facebook blue</Highlight> !
-```
-
-export const Highlight = ({children, color}) => (
-  <span
-    style={{
-      backgroundColor: color,
-      borderRadius: '20px',
-      color: '#fff',
-      padding: '10px',
-      cursor: 'pointer',
-    }}
-    onClick={() => {
-      alert(`You clicked the color ${color} with label ${children}`);
-    }}>
-    {children}
-  </span>
-);
-
-This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
-
-This is <Highlight color="#1877F2">Facebook blue</Highlight> !

docs/docs/tutorial-extras/_category_.json

@@ -1,7 +0,0 @@
-{
-  "label": "Tutorial - Extras",
-  "position": 3,
-  "link": {
-    "type": "generated-index"
-  }
-}

docs/docs/tutorial-extras/manage-docs-versions.md

@@ -1,55 +0,0 @@
----
-sidebar_position: 1
----
-
-# Manage Docs Versions
-
-Docusaurus can manage multiple versions of your docs.
-
-## Create a docs version
-
-Release a version 1.0 of your project:
-
-```bash
-npm run docusaurus docs:version 1.0
-```
-
-The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
-
-Your docs now have 2 versions:
-
-- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
-- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
-
-## Add a Version Dropdown
-
-To navigate seamlessly across versions, add a version dropdown.
-
-Modify the `docusaurus.config.js` file:
-
-```js title="docusaurus.config.js"
-export default {
-  themeConfig: {
-    navbar: {
-      items: [
-        // highlight-start
-        {
-          type: 'docsVersionDropdown',
-        },
-        // highlight-end
-      ],
-    },
-  },
-};
-```
-
-The docs version dropdown appears in your navbar:
-
-![Docs Version Dropdown](./img/docsVersionDropdown.png)
-
-## Update an existing version
-
-It is possible to edit versioned docs in their respective folder:
-
-- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
-- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`

docs/docs/tutorial-extras/translate-your-site.md

@@ -1,88 +0,0 @@
----
-sidebar_position: 2
----
-
-# Translate your site
-
-Let's translate `docs/intro.md` to French.
-
-## Configure i18n
-
-Modify `docusaurus.config.js` to add support for the `fr` locale:
-
-```js title="docusaurus.config.js"
-export default {
-  i18n: {
-    defaultLocale: 'en',
-    locales: ['en', 'fr'],
-  },
-};
-```
-
-## Translate a doc
-
-Copy the `docs/intro.md` file to the `i18n/fr` folder:
-
-```bash
-mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
-
-cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
-```
-
-Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
-
-## Start your localized site
-
-Start your site on the French locale:
-
-```bash
-npm run start -- --locale fr
-```
-
-Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
-
-:::caution
-
-In development, you can only use one locale at a time.
-
-:::
-
-## Add a Locale Dropdown
-
-To navigate seamlessly across languages, add a locale dropdown.
-
-Modify the `docusaurus.config.js` file:
-
-```js title="docusaurus.config.js"
-export default {
-  themeConfig: {
-    navbar: {
-      items: [
-        // highlight-start
-        {
-          type: 'localeDropdown',
-        },
-        // highlight-end
-      ],
-    },
-  },
-};
-```
-
-The locale dropdown now appears in your navbar:
-
-![Locale Dropdown](./img/localeDropdown.png)
-
-## Build your localized site
-
-Build your site for a specific locale:
-
-```bash
-npm run build -- --locale fr
-```
-
-Or build your site to include all the locales at once:
-
-```bash
-npm run build
-```

docs/docusaurus.config.js

@@ -8,131 +8,137 @@ import {themes as prismThemes} from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'Ollama4J',
-  tagline: 'Java library for interacting with Ollama API.',
-  favicon: 'img/favicon.ico',
+    title: 'Ollama4j',
+    tagline: 'Java library for interacting with Ollama.',
+    favicon: 'img/favicon.ico',
 
-  // Set the production url of your site here
-  url: 'https://your-docusaurus-site.example.com',
-  // Set the /<baseUrl>/ pathname under which your site is served
-  // For GitHub pages deployment, it is often '/<projectName>/'
-  baseUrl: '/ollama4j/',
+    // Set the production url of your site here
+    url: 'https://your-docusaurus-site.example.com',
+    // Set the /<baseUrl>/ pathname under which your site is served
+    // For GitHub pages deployment, it is often '/<projectName>/'
+    baseUrl: '/ollama4j/',
 
-  // GitHub pages deployment config.
-  // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'amithkoujalgi', // Usually your GitHub org/user name.
-  projectName: 'ollama4j', // Usually your repo name.
+    // GitHub pages deployment config.
+    // If you aren't using GitHub pages, you don't need these.
+    organizationName: 'amithkoujalgi', // Usually your GitHub org/user name.
+    projectName: 'ollama4j', // Usually your repo name.
 
-  onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
+    onBrokenLinks: 'throw',
+    onBrokenMarkdownLinks: 'warn',
 
-  // Even if you don't use internationalization, you can use this field to set
-  // useful metadata like html lang. For example, if your site is Chinese, you
-  // may want to replace "en" with "zh-Hans".
-  i18n: {
-    defaultLocale: 'en',
-    locales: ['en'],
-  },
+    // Even if you don't use internationalization, you can use this field to set
+    // useful metadata like html lang. For example, if your site is Chinese, you
+    // may want to replace "en" with "zh-Hans".
+    i18n: {
+        defaultLocale: 'en',
+        locales: ['en'],
+    },
 
-  presets: [
-    [
-      'classic',
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
-        docs: {
-          sidebarPath: './sidebars.js',
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
-        },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
-        },
-        theme: {
-          customCss: './src/css/custom.css',
-        },
-      }),
+    presets: [
+        [
+            'classic',
+            /** @type {import('@docusaurus/preset-classic').Options} */
+            ({
+                docs: {
+                    sidebarPath: './sidebars.js',
+                    // Please change this to your repo.
+                    // Remove this to remove the "edit this page" links.
+                    editUrl:
+                        'https://github.com/amithkoujalgi/ollama4j/blob/main/docs',
+                },
+                blog: {
+                    showReadingTime: true,
+                    // Please change this to your repo.
+                    // Remove this to remove the "edit this page" links.
+                    editUrl:
+                        'https://github.com/amithkoujalgi/ollama4j/blob/main/docs',
+                },
+                theme: {
+                    customCss: './src/css/custom.css',
+                },
+            }),
+        ],
     ],
-  ],
 
-  themeConfig:
+    themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      // Replace with your project's social card
-      image: 'img/docusaurus-social-card.jpg',
-      navbar: {
-        title: 'Ollama4J',
-        logo: {
-          alt: 'Ollama4J Logo',
-          src: 'img/logo.svg',
-        },
-        items: [
-          {
-            type: 'docSidebar',
-            sidebarId: 'tutorialSidebar',
-            position: 'left',
-            label: 'Tutorial',
-          },
-          {to: '/blog', label: 'Blog', position: 'left'},
-          {to: 'https://github.com/amithkoujalgi/ollama4j', label: 'Javadoc', position: 'left'},
-          {
-            href: 'https://github.com/amithkoujalgi/ollama4j',
-            label: 'GitHub',
-            position: 'right',
-          },
-        ],
-      },
-      footer: {
-        style: 'dark',
-        links: [
-          {
-            title: 'Docs',
-            items: [
-              {
-                label: 'Tutorial',
-                to: '/docs/intro',
-              },
-            ],
-          },
-          {
-            title: 'Community',
-            items: [
-              {
-                label: 'Stack Overflow',
-                  href: 'https://stackoverflow.com/questions/tagged/ollama4j',
-              },
-              {
-                label: 'Twitter',
-                href: 'https://twitter.com/ollama4j',
-              },
-            ],
-          },
-          {
-            title: 'More',
-            items: [
-              {
-                label: 'Blog',
-                to: '/blog',
-              },
-              {
-                label: 'GitHub',
-                href: 'https://github.com/amithkoujalgi/ollama4j',
-              },
-            ],
-          },
-        ],
-        copyright: `Ollama4J Documentation ${new Date().getFullYear()}. Built with Docusaurus.`,
-      },
-      prism: {
-        theme: prismThemes.github,
-        darkTheme: prismThemes.dracula,
-      },
-    }),
+        ({
+            // Replace with your project's social card
+            image: 'img/docusaurus-social-card.jpg',
+            navbar: {
+                title: 'Ollama4j',
+                logo: {
+                    alt: 'Ollama4j Logo',
+                    src: 'img/logo.svg',
+                },
+                items: [
+                    {
+                        type: 'docSidebar',
+                        sidebarId: 'tutorialSidebar',
+                        position: 'left',
+                        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',
+                        label: 'GitHub',
+                        position: 'right',
+                    },
+                ],
+            },
+            footer: {
+                style: 'dark',
+                links: [
+                    {
+                        title: 'Docs',
+                        items: [
+                            {
+                                label: 'Tutorial',
+                                to: '/docs/intro',
+                            },
+                        ],
+                    },
+                    {
+                        title: 'Community',
+                        items: [
+                            {
+                                label: 'Stack Overflow',
+                                href: 'https://stackoverflow.com/questions/tagged/ollama4j',
+                            },
+                            {
+                                label: 'Twitter',
+                                href: 'https://twitter.com/ollama4j',
+                            },
+                        ],
+                    },
+                    {
+                        title: 'More',
+                        items: [
+                            {
+                                label: 'Blog',
+                                to: '/blog',
+                            },
+                            {
+                                label: 'GitHub',
+                                href: 'https://github.com/amithkoujalgi/ollama4j',
+                            },
+                        ],
+                    },
+                ],
+                copyright: `Ollama4j Documentation ${new Date().getFullYear()}. Built with Docusaurus.`,
+            },
+            prism: {
+                theme: prismThemes.github,
+                darkTheme: prismThemes.dracula,
+                additionalLanguages: ['java'],
+            },
+        }),
+    markdown: {
+        mermaid: true,
+    },
+    themes: ['@docusaurus/theme-mermaid']
 };
 
 export default config;

docs/package.json

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

docs/src/css/custom.css

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

docs/src/pages/index.js

@@ -8,36 +8,33 @@ import Heading from '@theme/Heading';
 import styles from './index.module.css';
 
 function HomepageHeader() {
-  const {siteConfig} = useDocusaurusContext();
-  return (
-    <header className={clsx('hero hero--primary', styles.heroBanner)}>
-      <div className="container">
-        <Heading as="h1" className="hero__title">
-          {siteConfig.title}
-        </Heading>
-        <p className="hero__subtitle">{siteConfig.tagline}</p>
-        <div className={styles.buttons}>
-          <Link
-            className="button button--secondary button--lg"
-            to="/docs/intro">
-            Getting Started
-          </Link>
+    const {siteConfig} = useDocusaurusContext();
+    return (<header className={clsx('hero hero--primary', styles.heroBanner)}>
+        <div className="container">
+            <Heading as="h1" className="hero__title">
+                {siteConfig.title}
+            </Heading>
+            <img src="img/logo.svg" alt="Ollama4j Logo" className={styles.logo} style={{maxWidth: '20vh'}}/>
+            <p className="hero__subtitle">{siteConfig.tagline}</p>
+            <div className={styles.buttons}>
+                <Link
+                    className="button button--secondary button--lg"
+                    to="/docs/intro">
+                    Getting Started
+                </Link>
+            </div>
         </div>
-      </div>
-    </header>
-  );
+    </header>);
 }
 
 export default function Home() {
-  const {siteConfig} = useDocusaurusContext();
-  return (
-    <Layout
-      title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
-      <HomepageHeader />
-      <main>
-        <HomepageFeatures />
-      </main>
-    </Layout>
-  );
+    const {siteConfig} = useDocusaurusContext();
+    return (<Layout
+        title={`Hello from ${siteConfig.title}`}
+        description="Description will go into a meta tag in <head />">
+        <HomepageHeader/>
+        <main>
+            <HomepageFeatures/>
+        </main>
+    </Layout>);
 }

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.github.amithkoujalgi</groupId>
     <artifactId>ollama4j</artifactId>
-    <version>1.0.28-SNAPSHOT</version>
+    <version>1.0.50</version>
 
     <name>Ollama4j</name>
     <description>Java library for interacting with Ollama API.</description>
@@ -39,7 +39,7 @@
         <connection>scm:git:git@github.com:amithkoujalgi/ollama4j.git</connection>
         <developerConnection>scm:git:https://github.com/amithkoujalgi/ollama4j.git</developerConnection>
         <url>https://github.com/amithkoujalgi/ollama4j</url>
-        <tag>v1.0.16</tag>
+        <tag>v1.0.50</tag>
     </scm>
 
     <build>
@@ -154,7 +154,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.3.11</version>
+            <version>1.4.12</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -198,6 +198,29 @@
             <activation>
                 <activeByDefault>true</activeByDefault>
             </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.11</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>prepare-agent</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>report</id>
+                                <phase>test</phase>
+                                <goals>
+                                    <goal>report</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
         </profile>
         <profile>
             <id>integration-tests</id>
@@ -249,6 +272,26 @@
                             <autoReleaseAfterClose>true</autoReleaseAfterClose>
                         </configuration>
                     </plugin>
+
+                    <plugin>
+                        <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.7</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>prepare-agent</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>report</id>
+                                <phase>test</phase>
+                                <goals>
+                                    <goal>report</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
                 </plugins>
             </build>
         </profile>

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

@@ -6,6 +6,7 @@ import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFileConte
 import io.github.amithkoujalgi.ollama4j.core.models.request.CustomModelFilePathRequest;
 import io.github.amithkoujalgi.ollama4j.core.models.request.ModelEmbeddingsRequest;
 import io.github.amithkoujalgi.ollama4j.core.models.request.ModelRequest;
+import io.github.amithkoujalgi.ollama4j.core.utils.Options;
 import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
 import java.io.BufferedReader;
 import java.io.ByteArrayOutputStream;
@@ -17,6 +18,7 @@ import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.http.HttpClient;
+import java.net.http.HttpConnectTimeoutException;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
 import java.nio.charset.StandardCharsets;
@@ -36,6 +38,7 @@ public class OllamaAPI {
   private final String host;
   private long requestTimeoutSeconds = 3;
   private boolean verbose = true;
+  private BasicAuth basicAuth;
 
   /**
    * Instantiates the Ollama API.
@@ -50,6 +53,11 @@ public class OllamaAPI {
     }
   }
 
+  /**
+   * Set request timeout in seconds. Default is 3 seconds.
+   *
+   * @param requestTimeoutSeconds the request timeout in seconds
+   */
   public void setRequestTimeoutSeconds(long requestTimeoutSeconds) {
     this.requestTimeoutSeconds = requestTimeoutSeconds;
   }
@@ -63,6 +71,47 @@ public class OllamaAPI {
     this.verbose = verbose;
   }
 
+  /**
+   * Set basic authentication for accessing Ollama server that's behind a reverse-proxy/gateway.
+   *
+   * @param username the username
+   * @param password the password
+   */
+  public void setBasicAuth(String username, String password) {
+    this.basicAuth = new BasicAuth(username, password);
+  }
+
+  /**
+   * API to check the reachability of Ollama server.
+   *
+   * @return true if the server is reachable, false otherwise.
+   */
+  public boolean ping() {
+    String url = this.host + "/api/tags";
+    HttpClient httpClient = HttpClient.newHttpClient();
+    HttpRequest httpRequest = null;
+    try {
+      httpRequest =
+          getRequestBuilderDefault(new URI(url))
+              .header("Accept", "application/json")
+              .header("Content-type", "application/json")
+              .GET()
+              .build();
+    } catch (URISyntaxException e) {
+      throw new RuntimeException(e);
+    }
+    HttpResponse<String> response = null;
+    try {
+      response = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
+    } catch (HttpConnectTimeoutException e) {
+      return false;
+    } catch (IOException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+    int statusCode = response.statusCode();
+    return statusCode == 200;
+  }
+
   /**
    * List available models from Ollama server.
    *
@@ -73,11 +122,9 @@ public class OllamaAPI {
     String url = this.host + "/api/tags";
     HttpClient httpClient = HttpClient.newHttpClient();
     HttpRequest httpRequest =
-        HttpRequest.newBuilder()
-            .uri(new URI(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .GET()
             .build();
     HttpResponse<String> response =
@@ -104,12 +151,10 @@ public class OllamaAPI {
     String url = this.host + "/api/pull";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(new URI(url))
+        getRequestBuilderDefault(new URI(url))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .build();
     HttpClient client = HttpClient.newHttpClient();
     HttpResponse<InputStream> response =
@@ -140,15 +185,13 @@ public class OllamaAPI {
    * @return the model details
    */
   public ModelDetail getModelDetails(String modelName)
-      throws IOException, OllamaBaseException, InterruptedException {
+      throws IOException, OllamaBaseException, InterruptedException, URISyntaxException {
     String url = this.host + "/api/show";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -170,15 +213,13 @@ public class OllamaAPI {
    * @param modelFilePath the path to model file that exists on the Ollama server.
    */
   public void createModelWithFilePath(String modelName, String modelFilePath)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/create";
     String jsonData = new CustomModelFilePathRequest(modelName, modelFilePath).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-Type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -206,15 +247,13 @@ public class OllamaAPI {
    * @param modelFileContents the path to model file that exists on the Ollama server.
    */
   public void createModelWithModelFileContents(String modelName, String modelFileContents)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/create";
     String jsonData = new CustomModelFileContentsRequest(modelName, modelFileContents).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .header("Accept", "application/json")
             .header("Content-Type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .build();
     HttpClient client = HttpClient.newHttpClient();
@@ -236,20 +275,17 @@ public class OllamaAPI {
    * Delete a model from Ollama server.
    *
    * @param modelName the name of the model to be deleted.
-   * @param ignoreIfNotPresent - ignore errors if the specified model is not present on Ollama
-   *     server.
+   * @param ignoreIfNotPresent ignore errors if the specified model is not present on Ollama server.
    */
   public void deleteModel(String modelName, boolean ignoreIfNotPresent)
-      throws IOException, InterruptedException, OllamaBaseException {
+      throws IOException, InterruptedException, OllamaBaseException, URISyntaxException {
     String url = this.host + "/api/delete";
     String jsonData = new ModelRequest(modelName).toString();
     HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+        getRequestBuilderDefault(new URI(url))
             .method("DELETE", HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
             .header("Accept", "application/json")
             .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
             .build();
     HttpClient client = HttpClient.newHttpClient();
     HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
@@ -272,17 +308,14 @@ public class OllamaAPI {
    */
   public List<Double> generateEmbeddings(String model, String prompt)
       throws IOException, InterruptedException, OllamaBaseException {
-    String url = this.host + "/api/embeddings";
+    URI uri = URI.create(this.host + "/api/embeddings");
     String jsonData = new ModelEmbeddingsRequest(model, prompt).toString();
     HttpClient httpClient = HttpClient.newHttpClient();
-    HttpRequest request =
-        HttpRequest.newBuilder()
-            .uri(URI.create(url))
+    HttpRequest.Builder requestBuilder =
+        getRequestBuilderDefault(uri)
             .header("Accept", "application/json")
-            .header("Content-type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
-            .POST(HttpRequest.BodyPublishers.ofString(jsonData))
-            .build();
+            .POST(HttpRequest.BodyPublishers.ofString(jsonData));
+    HttpRequest request = requestBuilder.build();
     HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
     int statusCode = response.statusCode();
     String responseBody = response.body();
@@ -296,33 +329,39 @@ public class OllamaAPI {
   }
 
   /**
-   * Ask a question to a model running on Ollama server. This is a sync/blocking call.
+   * Generate response for a question to a model running on Ollama server. This is a sync/blocking
+   * call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
-   * @return OllamaResult - that includes response text and time taken for response
+   * @param prompt the prompt/question text
+   * @param options the Options object - <a
+   *     href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values">More
+   *     details on the options</a>
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult ask(String model, String promptText)
+  public OllamaResult generate(String model, String prompt, Options options)
       throws OllamaBaseException, IOException, InterruptedException {
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
-    return askSync(ollamaRequestModel);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt);
+    ollamaRequestModel.setOptions(options.getOptionsMap());
+    return generateSync(ollamaRequestModel);
   }
 
   /**
-   * Ask a question to a model running on Ollama server and get a callback handle that can be used
-   * to check for status and get the response from the model later. This would be an
-   * async/non-blocking call.
+   * Generate response for a question to a model running on Ollama server and get a callback handle
+   * that can be used to check for status and get the response from the model later. This would be
+   * an async/non-blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @return the ollama async result callback handle
    */
-  public OllamaAsyncResultCallback askAsync(String model, String promptText) {
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
-    HttpClient httpClient = HttpClient.newHttpClient();
+  public OllamaAsyncResultCallback generateAsync(String model, String prompt) {
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt);
+
     URI uri = URI.create(this.host + "/api/generate");
     OllamaAsyncResultCallback ollamaAsyncResultCallback =
-        new OllamaAsyncResultCallback(httpClient, uri, ollamaRequestModel, requestTimeoutSeconds);
+        new OllamaAsyncResultCallback(
+            getRequestBuilderDefault(uri), ollamaRequestModel, requestTimeoutSeconds);
     ollamaAsyncResultCallback.start();
     return ollamaAsyncResultCallback;
   }
@@ -332,18 +371,23 @@ public class OllamaAPI {
    * sync/blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @param imageFiles the list of image files to use for the question
-   * @return OllamaResult - that includes response text and time taken for response
+   * @param options the Options object - <a
+   *     href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values">More
+   *     details on the options</a>
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageFiles(String model, String promptText, List<File> imageFiles)
+  public OllamaResult generateWithImageFiles(
+      String model, String prompt, List<File> imageFiles, Options options)
       throws OllamaBaseException, IOException, InterruptedException {
     List<String> images = new ArrayList<>();
     for (File imageFile : imageFiles) {
       images.add(encodeFileToBase64(imageFile));
     }
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
-    return askSync(ollamaRequestModel);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
+    ollamaRequestModel.setOptions(options.getOptionsMap());
+    return generateSync(ollamaRequestModel);
   }
 
   /**
@@ -351,18 +395,23 @@ public class OllamaAPI {
    * sync/blocking call.
    *
    * @param model the ollama model to ask the question to
-   * @param promptText the prompt/question text
+   * @param prompt the prompt/question text
    * @param imageURLs the list of image URLs to use for the question
-   * @return OllamaResult - that includes response text and time taken for response
+   * @param options the Options object - <a
+   *     href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values">More
+   *     details on the options</a>
+   * @return OllamaResult that includes response text and time taken for response
    */
-  public OllamaResult askWithImageURLs(String model, String promptText, List<String> imageURLs)
+  public OllamaResult generateWithImageURLs(
+      String model, String prompt, List<String> imageURLs, Options options)
       throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
     List<String> images = new ArrayList<>();
     for (String imageURL : imageURLs) {
       images.add(encodeByteArrayToBase64(loadImageBytesFromUrl(imageURL)));
     }
-    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
-    return askSync(ollamaRequestModel);
+    OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, prompt, images);
+    ollamaRequestModel.setOptions(options.getOptionsMap());
+    return generateSync(ollamaRequestModel);
   }
 
   private static String encodeFileToBase64(File file) throws IOException {
@@ -387,19 +436,18 @@ public class OllamaAPI {
     }
   }
 
-  private OllamaResult askSync(OllamaRequestModel ollamaRequestModel)
+  private OllamaResult generateSync(OllamaRequestModel ollamaRequestModel)
       throws OllamaBaseException, IOException, InterruptedException {
     long startTime = System.currentTimeMillis();
     HttpClient httpClient = HttpClient.newHttpClient();
     URI uri = URI.create(this.host + "/api/generate");
-    HttpRequest request =
-        HttpRequest.newBuilder(uri)
+    HttpRequest.Builder requestBuilder =
+        getRequestBuilderDefault(uri)
             .POST(
                 HttpRequest.BodyPublishers.ofString(
-                    Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)))
-            .header("Content-Type", "application/json")
-            .timeout(Duration.ofSeconds(requestTimeoutSeconds))
-            .build();
+                    Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)));
+    HttpRequest request = requestBuilder.build();
+    if (verbose) logger.info("Asking model: " + ollamaRequestModel);
     HttpResponse<InputStream> response =
         httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
     int statusCode = response.statusCode();
@@ -410,9 +458,16 @@ public class OllamaAPI {
       String line;
       while ((line = reader.readLine()) != null) {
         if (statusCode == 404) {
+          logger.warn("Status code: 404 (Not Found)");
           OllamaErrorResponseModel ollamaResponseModel =
               Utils.getObjectMapper().readValue(line, OllamaErrorResponseModel.class);
           responseBuffer.append(ollamaResponseModel.getError());
+        } else if (statusCode == 401) {
+          logger.warn("Status code: 401 (Unauthorized)");
+          OllamaErrorResponseModel ollamaResponseModel =
+              Utils.getObjectMapper()
+                  .readValue("{\"error\":\"Unauthorized\"}", OllamaErrorResponseModel.class);
+          responseBuffer.append(ollamaResponseModel.getError());
         } else {
           OllamaResponseModel ollamaResponseModel =
               Utils.getObjectMapper().readValue(line, OllamaResponseModel.class);
@@ -422,11 +477,52 @@ public class OllamaAPI {
         }
       }
     }
+
     if (statusCode != 200) {
+      logger.error("Status code " + statusCode);
       throw new OllamaBaseException(responseBuffer.toString());
     } else {
       long endTime = System.currentTimeMillis();
-      return new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
+      OllamaResult ollamaResult =
+          new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
+      if (verbose) logger.info("Model response: " + ollamaResult);
+      return ollamaResult;
     }
   }
+
+  /**
+   * Get default request builder.
+   *
+   * @param uri URI to get a HttpRequest.Builder
+   * @return HttpRequest.Builder
+   */
+  private HttpRequest.Builder getRequestBuilderDefault(URI uri) {
+    HttpRequest.Builder requestBuilder =
+        HttpRequest.newBuilder(uri)
+            .header("Content-Type", "application/json")
+            .timeout(Duration.ofSeconds(requestTimeoutSeconds));
+    if (isBasicAuthCredentialsSet()) {
+      requestBuilder.header("Authorization", getBasicAuthHeaderValue());
+    }
+    return requestBuilder;
+  }
+
+  /**
+   * Get basic authentication header value.
+   *
+   * @return basic authentication header value (encoded credentials)
+   */
+  private String getBasicAuthHeaderValue() {
+    String credentialsToEncode = basicAuth.getUsername() + ":" + basicAuth.getPassword();
+    return "Basic " + Base64.getEncoder().encodeToString(credentialsToEncode.getBytes());
+  }
+
+  /**
+   * Check if Basic Auth credentials set.
+   *
+   * @return true when Basic Auth credentials set
+   */
+  private boolean isBasicAuthCredentialsSet() {
+    return basicAuth != null;
+  }
 }

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

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

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

@@ -7,6 +7,7 @@ import lombok.Data;
 public class Model {
 
   private String name;
+  private String model;
   @JsonProperty("modified_at")
   private String modifiedAt;
   private String digest;

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

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

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

@@ -1,10 +1,10 @@
 package io.github.amithkoujalgi.ollama4j.core.models;
 
-
 import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import java.util.List;
+import java.util.Map;
 import lombok.Data;
 
 @Data
@@ -13,6 +13,7 @@ public class OllamaRequestModel {
   private String model;
   private String prompt;
   private List<String> images;
+  private Map<String, Object> options;
 
   public OllamaRequestModel(String model, String prompt) {
     this.model = model;

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

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

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

@@ -21,6 +21,7 @@ public class OllamaModelType {
   public static final String VICUNA = "vicuna";
   public static final String WIZARD_VICUNA_UNCENSORED = "wizard-vicuna-uncensored";
   public static final String PHIND_CODELLAMA = "phind-codellama";
+  public static final String PHI = "phi";
   public static final String ZEPHYR = "zephyr";
   public static final String WIZARDCODER = "wizardcoder";
   public static final String MISTRAL_OPENORCA = "mistral-openorca";

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

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

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

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

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

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

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

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

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

@@ -4,38 +4,36 @@ 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.OllamaResult;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.ConnectException;
 import java.net.URISyntaxException;
 import java.net.http.HttpConnectTimeoutException;
+import java.util.List;
+import java.util.Objects;
 import java.util.Properties;
+import lombok.Data;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 
 class TestRealAPIs {
   OllamaAPI ollamaAPI;
+  Config config;
 
-  private Properties loadProperties() {
-    Properties properties = new Properties();
-    try (InputStream input =
-        getClass().getClassLoader().getResourceAsStream("test-config.properties")) {
-      if (input == null) {
-        throw new RuntimeException("Sorry, unable to find test-config.properties");
-      }
-      properties.load(input);
-      return properties;
-    } catch (IOException e) {
-      throw new RuntimeException("Error loading properties", e);
-    }
+  private File getImageFileFromClasspath(String fileName) {
+    ClassLoader classLoader = getClass().getClassLoader();
+    return new File(Objects.requireNonNull(classLoader.getResource(fileName)).getFile());
   }
 
   @BeforeEach
   void setUp() {
-    Properties properties = loadProperties();
-    ollamaAPI = new OllamaAPI(properties.getProperty("ollama.api.url"));
+    config = new Config();
+    ollamaAPI = new OllamaAPI(config.getOllamaURL());
+    ollamaAPI.setRequestTimeoutSeconds(config.getRequestTimeoutSeconds());
   }
 
   @Test
@@ -74,13 +72,115 @@ class TestRealAPIs {
   void testPullModel() {
     testEndpointReachability();
     try {
-      ollamaAPI.pullModel(OllamaModelType.LLAMA2);
+      ollamaAPI.pullModel(config.getModel());
       boolean found =
           ollamaAPI.listModels().stream()
-              .anyMatch(model -> model.getModelName().equals(OllamaModelType.LLAMA2));
+              .anyMatch(model -> model.getModel().equalsIgnoreCase(config.getModel()));
       assertTrue(found);
     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
+
+  @Test
+  @Order(3)
+  void testAskModelWithDefaultOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.generate(
+              config.getModel(),
+              "What is the capital of France? And what's France's connection with Mona Lisa?",
+              new OptionsBuilder().build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  @Order(3)
+  void testAskModelWithOptions() {
+    testEndpointReachability();
+    try {
+      OllamaResult result =
+          ollamaAPI.generate(
+              config.getModel(),
+              "What is the capital of France? And what's France's connection with Mona Lisa?",
+              new OptionsBuilder().setTemperature(0.9f).build());
+      assertNotNull(result);
+      assertNotNull(result.getResponse());
+      assertFalse(result.getResponse().isEmpty());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(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) {
+      throw new RuntimeException(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) {
+      throw new RuntimeException(e);
+    }
+  }
+}
+
+@Data
+class Config {
+  private String ollamaURL;
+  private String model;
+  private String imageModel;
+  private int requestTimeoutSeconds;
+
+  public Config() {
+    Properties properties = new Properties();
+    try (InputStream input =
+        getClass().getClassLoader().getResourceAsStream("test-config.properties")) {
+      if (input == null) {
+        throw new RuntimeException("Sorry, unable to find test-config.properties");
+      }
+      properties.load(input);
+      this.ollamaURL = properties.getProperty("ollama.url");
+      this.model = properties.getProperty("ollama.model");
+      this.imageModel = properties.getProperty("ollama.model.image");
+      this.requestTimeoutSeconds =
+          Integer.parseInt(properties.getProperty("ollama.request-timeout-seconds"));
+    } catch (IOException e) {
+      throw new RuntimeException("Error loading properties", e);
+    }
+  }
 }

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

@@ -8,15 +8,17 @@ import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail;
 import io.github.amithkoujalgi.ollama4j.core.models.OllamaAsyncResultCallback;
 import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult;
 import io.github.amithkoujalgi.ollama4j.core.types.OllamaModelType;
+import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder;
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.util.ArrayList;
+import java.util.Collections;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 class TestMockedAPIs {
   @Test
-  void testMockPullModel() {
+  void testPullModel() {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     try {
@@ -49,7 +51,7 @@ class TestMockedAPIs {
       doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath);
       ollamaAPI.createModelWithModelFileContents(model, modelFilePath);
       verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -62,7 +64,7 @@ class TestMockedAPIs {
       doNothing().when(ollamaAPI).deleteModel(model, true);
       ollamaAPI.deleteModel(model, true);
       verify(ollamaAPI, times(1)).deleteModel(model, true);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -75,7 +77,7 @@ class TestMockedAPIs {
       when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail());
       ollamaAPI.getModelDetails(model);
       verify(ollamaAPI, times(1)).getModelDetails(model);
-    } catch (IOException | OllamaBaseException | InterruptedException e) {
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
       throw new RuntimeException(e);
     }
   }
@@ -99,23 +101,63 @@ class TestMockedAPIs {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
+    OptionsBuilder optionsBuilder = new OptionsBuilder();
     try {
-      when(ollamaAPI.ask(model, prompt)).thenReturn(new OllamaResult("", 0, 200));
-      ollamaAPI.ask(model, prompt);
-      verify(ollamaAPI, times(1)).ask(model, prompt);
+      when(ollamaAPI.generate(model, prompt, optionsBuilder.build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generate(model, prompt, optionsBuilder.build());
+      verify(ollamaAPI, times(1)).generate(model, prompt, optionsBuilder.build());
     } catch (IOException | OllamaBaseException | InterruptedException e) {
       throw new RuntimeException(e);
     }
   }
 
+  @Test
+  void testAskWithImageFiles() {
+    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+    String model = OllamaModelType.LLAMA2;
+    String prompt = "some prompt text";
+    try {
+      when(ollamaAPI.generateWithImageFiles(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generateWithImageFiles(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .generateWithImageFiles(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+    } catch (IOException | OllamaBaseException | InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @Test
+  void testAskWithImageURLs() {
+    OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
+    String model = OllamaModelType.LLAMA2;
+    String prompt = "some prompt text";
+    try {
+      when(ollamaAPI.generateWithImageURLs(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build()))
+          .thenReturn(new OllamaResult("", 0, 200));
+      ollamaAPI.generateWithImageURLs(
+          model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+      verify(ollamaAPI, times(1))
+          .generateWithImageURLs(
+              model, prompt, Collections.emptyList(), new OptionsBuilder().build());
+    } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
   @Test
   void testAskAsync() {
     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class);
     String model = OllamaModelType.LLAMA2;
     String prompt = "some prompt text";
-    when(ollamaAPI.askAsync(model, prompt))
-        .thenReturn(new OllamaAsyncResultCallback(null, null, null, 3));
-    ollamaAPI.askAsync(model, prompt);
-    verify(ollamaAPI, times(1)).askAsync(model, prompt);
+    when(ollamaAPI.generateAsync(model, prompt))
+        .thenReturn(new OllamaAsyncResultCallback(null, null, 3));
+    ollamaAPI.generateAsync(model, prompt);
+    verify(ollamaAPI, times(1)).generateAsync(model, prompt);
   }
 }

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