mirror of
				https://github.com/amithkoujalgi/ollama4j.git
				synced 2025-10-31 08:30:41 +01:00 
			
		
		
		
	Compare commits
	
		
			71 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | 81689be194 | ||
|   | fd93036d08 | ||
|   | c9b05a725b | ||
|   | a4e1b4afe9 | ||
|   | 3d21813abb | ||
|   | 383d0f56ca | ||
|   | af1b213a76 | ||
|   | fed89a9643 | ||
|   | fd32aa33ff | ||
|   | b8a13e89b1 | ||
|   | c8f27edd6e | ||
|   | 5a936d8174 | ||
|   | 9b5ddbf4c4 | ||
|   | 7c233d5734 | ||
|   | e85aeae6e0 | ||
|   | a05052e095 | ||
|   | 10eb803e26 | ||
|   | bd2da8fdda | ||
|   | b0bb082bec | ||
|   | 81f564ef7f | ||
|   | 006b52f3db | ||
|   | 16634e60e4 | ||
|   | db8b73075b | ||
|   | dc9f79959a | ||
|   | 88f6d00763 | ||
|   | fd3a989a49 | ||
|   | 7580c6a549 | ||
|   | 9e6503d84b | ||
|   | ee21f7fdd8 | ||
|   | ecc295f484 | ||
|   | c528fef5fc | ||
|   | 38f1bda105 | ||
|   | d8a703503a | ||
|   | dd9ba7c937 | ||
|   | cf52c9610c | ||
|   | e8d709e99a | ||
|   | 51fbedad69 | ||
|   | 953605fa73 | ||
|   | 30bfdd9c6d | ||
|   | 91ee6cb4c1 | ||
|   | 8ef6fac28e | ||
|   | d9e3860123 | ||
|   | 515d1f0399 | ||
|   | be549430c5 | ||
|   | 4744315d45 | ||
|   | 8eea19a539 | ||
|   | b5801d84e0 | ||
|   | 165d04b1bb | ||
|   | 16d2160b52 | ||
|   | e39c47b8e1 | ||
|   | bb0785140b | ||
|   | e33ad1a1e3 | ||
|   | cd60c506cb | ||
|   | b55925df28 | ||
|   | 3a9b8c309d | ||
|   | bf07159522 | ||
|   | f8ca4d041d | ||
|   | 9c6a55f7b0 | ||
|   | 2866d83a2f | ||
|   | 45e5d07581 | ||
|   | 3a264cb6bb | ||
|   | e1b9d42771 | ||
|   | 1a086c37c0 | ||
|   | 54edba144c | ||
|   | 3ed3187ba9 | ||
|   | b7cd81a7f5 | ||
|   | e750c2d7f9 | ||
|   | 62f16131f3 | ||
|   | 2cbaf12d7c | ||
|   | e2d555d404 | ||
|   | 9224d2da06 | 
							
								
								
									
										67
									
								
								.github/workflows/maven-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										67
									
								
								.github/workflows/maven-publish.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,68 +1,41 @@ | ||||
| # This workflow will build a package using Maven and then publish it to GitHub packages when a release is created | ||||
| # For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path | ||||
|  | ||||
| name: Test and Publish Package | ||||
|  | ||||
| #on: | ||||
| #  release: | ||||
| #    types: [ "created" ] | ||||
| name: Release Artifacts | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [ "main" ] | ||||
|   workflow_dispatch: | ||||
|   release: | ||||
|     types: [ created ] | ||||
|  | ||||
| jobs: | ||||
|   build: | ||||
|  | ||||
|     runs-on: ubuntu-latest | ||||
|     permissions: | ||||
|       contents: write | ||||
|       contents: read | ||||
|       packages: write | ||||
|  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Set up JDK 11 | ||||
|       - name: Set up JDK 17 | ||||
|         uses: actions/setup-java@v3 | ||||
|         with: | ||||
|           java-version: '11' | ||||
|           distribution: 'adopt-hotspot' | ||||
|           java-version: '17' | ||||
|           distribution: 'temurin' | ||||
|           server-id: github # Value of the distributionManagement/repository/id field of the pom.xml | ||||
|           settings-path: ${{ github.workspace }} # location for the settings.xml file | ||||
|  | ||||
|       - name: Find and Replace | ||||
|         uses: jacobtomlinson/gha-find-replace@v3 | ||||
|         with: | ||||
|           find: "ollama4j-revision" | ||||
|           replace: ${{ github.ref_name }} | ||||
|           regex: false | ||||
|  | ||||
|       - name: Build with Maven | ||||
|         run: mvn --file pom.xml -U clean package -Punit-tests | ||||
|       - name: Set up Apache Maven Central (Overwrite settings.xml) | ||||
|         uses: actions/setup-java@v3 | ||||
|         with: # running setup-java again overwrites the settings.xml | ||||
|           java-version: '11' | ||||
|           distribution: 'adopt-hotspot' | ||||
|           cache: 'maven' | ||||
|           server-id: ossrh | ||||
|           server-username: MAVEN_USERNAME | ||||
|           server-password: MAVEN_PASSWORD | ||||
|           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} | ||||
|           gpg-passphrase: MAVEN_GPG_PASSPHRASE | ||||
|       - name: Set up Maven cache | ||||
|         uses: actions/cache@v3 | ||||
|         with: | ||||
|           path: ~/.m2/repository | ||||
|           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} | ||||
|           restore-keys: | | ||||
|             ${{ runner.os }}-maven- | ||||
|       - name: Build | ||||
|         run: mvn -B -ntp clean install | ||||
|       - name: Upload coverage reports to Codecov | ||||
|         uses: codecov/codecov-action@v3 | ||||
|         env: | ||||
|           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | ||||
|  | ||||
|       - name: Publish to GitHub Packages Apache Maven | ||||
|         #        if: > | ||||
|         #          github.event_name != 'pull_request' && | ||||
|         #          github.ref_name == 'main' && | ||||
|         #          contains(github.event.head_commit.message, 'release') | ||||
|         run: | | ||||
|           git config --global user.email "koujalgi.amith@gmail.com" | ||||
|           git config --global user.name "amithkoujalgi" | ||||
|           mvn -B -ntp -DskipTests -Pci-cd -Darguments="-DskipTests -Pci-cd" release:clean release:prepare release:perform | ||||
|         run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml --file pom.xml | ||||
|         env: | ||||
|           MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} | ||||
|           MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }} | ||||
|           MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} | ||||
|           GITHUB_TOKEN: ${{ github.token }} | ||||
							
								
								
									
										12
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										12
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							| @@ -2,9 +2,8 @@ | ||||
| name: Deploy Docs to GH Pages | ||||
|  | ||||
| on: | ||||
|   # Runs on pushes targeting the default branch | ||||
|   push: | ||||
|     branches: [ "main" ] | ||||
|   release: | ||||
|     types: [ created ] | ||||
|  | ||||
|   # Allows you to run this workflow manually from the Actions tab | ||||
|   workflow_dispatch: | ||||
| @@ -47,6 +46,13 @@ jobs: | ||||
|       - run: cd docs && npm ci | ||||
|       - run: cd docs && npm run build | ||||
|  | ||||
|       - name: Find and Replace | ||||
|         uses: jacobtomlinson/gha-find-replace@v3 | ||||
|         with: | ||||
|           find: "ollama4j-revision" | ||||
|           replace: ${{ github.ref_name }} | ||||
|           regex: false | ||||
|  | ||||
|       - name: Build with Maven | ||||
|         run: mvn --file pom.xml -U clean package && cp -r ./target/apidocs/. ./docs/build/apidocs | ||||
|  | ||||
|   | ||||
							
								
								
									
										52
									
								
								.github/workflows/publish-javadoc.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										52
									
								
								.github/workflows/publish-javadoc.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,52 +0,0 @@ | ||||
| # Simple workflow for deploying static content to GitHub Pages | ||||
| name: Deploy Javadoc content to Pages | ||||
|  | ||||
| on: | ||||
|   # Runs on pushes targeting the default branch | ||||
|   push: | ||||
|     branches: [ "none" ] | ||||
|  | ||||
|   # Allows you to run this workflow manually from the Actions tab | ||||
|   workflow_dispatch: | ||||
|  | ||||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||||
| permissions: | ||||
|   contents: read | ||||
|   pages: write | ||||
|   id-token: write | ||||
|   packages: write | ||||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||||
| concurrency: | ||||
|   group: "pages" | ||||
|   cancel-in-progress: false | ||||
|  | ||||
| jobs: | ||||
|   # Single deploy job since we're just deploying | ||||
|   deploy: | ||||
|     runs-on: ubuntu-latest | ||||
|  | ||||
|     environment: | ||||
|       name: github-pages | ||||
|       url: ${{ steps.deployment.outputs.page_url }} | ||||
|     steps: | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Set up JDK 11 | ||||
|         uses: actions/setup-java@v3 | ||||
|         with: | ||||
|           java-version: '11' | ||||
|           distribution: 'adopt-hotspot' | ||||
|           server-id: github # Value of the distributionManagement/repository/id field of the pom.xml | ||||
|           settings-path: ${{ github.workspace }} # location for the settings.xml file | ||||
|       - name: Build with Maven | ||||
|         run: mvn --file pom.xml -U clean package | ||||
|       - name: Setup Pages | ||||
|         uses: actions/configure-pages@v3 | ||||
|       - name: Upload artifact | ||||
|         uses: actions/upload-pages-artifact@v2 | ||||
|         with: | ||||
|           # Upload entire repository | ||||
|           path: './target/apidocs/.' | ||||
|       - name: Deploy to GitHub Pages | ||||
|         id: deployment | ||||
|         uses: actions/deploy-pages@v2 | ||||
							
								
								
									
										142
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										142
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,6 +1,11 @@ | ||||
| <div style="text-align: center"> | ||||
|  | ||||
| ### Ollama4j | ||||
|  | ||||
| <img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon"> | ||||
| <p align="center"> | ||||
|   <img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon"> | ||||
| </p> | ||||
|  | ||||
|  | ||||
| A Java library (wrapper/binding) for [Ollama](https://ollama.ai/) server. | ||||
|  | ||||
| @@ -9,23 +14,36 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| [](https://codecov.io/gh/amithkoujalgi/ollama4j) | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| </div> | ||||
|  | ||||
| [//]: # () | ||||
|  | ||||
| [//]: # () | ||||
|  | ||||
| ## Table of Contents | ||||
|  | ||||
| - [How does it work?](#how-does-it-work) | ||||
| - [Requirements](#requirements) | ||||
| - [Installation](#installation) | ||||
| - [API Spec](#api-spec) | ||||
| - [Demo APIs](#try-out-the-apis-with-ollama-server) | ||||
| - [API Spec](https://amithkoujalgi.github.io/ollama4j/docs/category/apis---model-management) | ||||
| - [Javadoc](https://amithkoujalgi.github.io/ollama4j/apidocs/) | ||||
| - [Development](#development) | ||||
| - [Contributions](#get-involved) | ||||
| - [References](#references) | ||||
| @@ -48,9 +66,9 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). | ||||
|  | ||||
|  | ||||
|  | ||||
| [![][ollama-shield]][ollama] **Or** [![][ollama-docker-shield]][ollama-docker] | ||||
| [![][ollama-shield]][ollama-link] **Or** [![][ollama-docker-shield]][ollama-docker] | ||||
|  | ||||
| [ollama]: https://ollama.ai/ | ||||
| [ollama-link]: https://ollama.ai/ | ||||
|  | ||||
| [ollama-shield]: https://img.shields.io/badge/Ollama-Local_Installation-blue.svg?style=just-the-message&labelColor=gray | ||||
|  | ||||
| @@ -60,22 +78,93 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). | ||||
|  | ||||
| #### Installation | ||||
|  | ||||
| In your Maven project, add this dependency: | ||||
| Check the releases [here](https://github.com/amithkoujalgi/ollama4j/releases) and update the dependency version | ||||
| according to your requirements. | ||||
|  | ||||
| [![][ollama4j-releases-shield]][ollama4j-releases-link] | ||||
|  | ||||
| [ollama4j-releases-link]: https://github.com/amithkoujalgi/ollama4j/releases | ||||
|  | ||||
| [ollama4j-releases-shield]: https://img.shields.io/github/v/release/amithkoujalgi/ollama4j?include_prereleases&display_name=release&style=for-the-badge&label=Latest%20Release | ||||
|  | ||||
| ##### For Maven | ||||
|  | ||||
| 1. In your Maven project, add this dependency: | ||||
|  | ||||
| ```xml | ||||
|  | ||||
| <dependency> | ||||
|     <groupId>io.github.amithkoujalgi</groupId> | ||||
|     <artifactId>ollama4j</artifactId> | ||||
|     <version>1.0.57</version> | ||||
|     <version>1.0.74</version> | ||||
| </dependency> | ||||
| ``` | ||||
|  | ||||
| Latest release: | ||||
| 2. Add repository to your project's pom.xml: | ||||
|  | ||||
|  | ||||
| ```xml | ||||
|  | ||||
| [![][lib-shield]][lib] | ||||
| <repositories> | ||||
|     <repository> | ||||
|         <id>github</id> | ||||
|         <name>GitHub Apache Maven Packages</name> | ||||
|         <url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url> | ||||
|         <releases> | ||||
|             <enabled>true</enabled> | ||||
|         </releases> | ||||
|         <snapshots> | ||||
|             <enabled>true</enabled> | ||||
|         </snapshots> | ||||
|     </repository> | ||||
| </repositories> | ||||
| ``` | ||||
|  | ||||
| 3. Add GitHub server to settings.xml. (Usually available at ~/.m2/settings.xml) | ||||
|  | ||||
| ```xml | ||||
|  | ||||
| <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" | ||||
|           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||||
|           xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 | ||||
|                       http://maven.apache.org/xsd/settings-1.0.0.xsd"> | ||||
|     <servers> | ||||
|         <server> | ||||
|             <id>github</id> | ||||
|             <username>YOUR-USERNAME</username> | ||||
|             <password>YOUR-TOKEN</password> | ||||
|         </server> | ||||
|     </servers> | ||||
| </settings> | ||||
| ``` | ||||
|  | ||||
| ##### For Gradle | ||||
|  | ||||
| In your Gradle project, add the dependency using the Kotlin DSL or the Groovy DSL: | ||||
|  | ||||
| ```kotlin | ||||
| dependencies { | ||||
|  | ||||
|     val ollama4jVersion = "1.0.74" | ||||
|  | ||||
|     implementation("io.github.amithkoujalgi:ollama4j:$ollama4jVersion") | ||||
| } | ||||
|  ``` | ||||
|  | ||||
| ```groovy | ||||
| dependencies { | ||||
|     implementation("io.github.amithkoujalgi:ollama4j:1.0.74") | ||||
| } | ||||
| ``` | ||||
|  | ||||
| [//]: # (Latest release:) | ||||
|  | ||||
| [//]: # () | ||||
|  | ||||
| [//]: # () | ||||
|  | ||||
| [//]: # () | ||||
|  | ||||
| [//]: # ([![][lib-shield]][lib]) | ||||
|  | ||||
| [lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j | ||||
|  | ||||
| @@ -107,8 +196,7 @@ make it | ||||
|  | ||||
| #### Releases | ||||
|  | ||||
| Releases (newer artifact versions) are done automatically on pushing the code to the `main` branch through GitHub | ||||
| Actions CI workflow. | ||||
| Newer artifacts are published via GitHub Actions CI workflow when a new release is created from `main` branch. | ||||
|  | ||||
| #### Who's using Ollama4j? | ||||
|  | ||||
| @@ -116,6 +204,9 @@ Actions CI workflow. | ||||
|     - https://github.com/datafaker-net/datafaker-experimental/tree/main/ollama-api | ||||
| - `Vaadin Web UI`: UI-Tester for Interactions with Ollama via ollama4j | ||||
|     - https://github.com/TEAMPB/ollama4j-vaadin-ui | ||||
| - `ollama-translator`: Minecraft 1.20.6 spigot plugin allows to easily break language barriers by using ollama on the | ||||
|   server to translate all messages into a specfic target language. | ||||
|     - https://github.com/liebki/ollama-translator | ||||
|  | ||||
| #### Traction | ||||
|  | ||||
| @@ -131,6 +222,9 @@ Actions CI workflow. | ||||
| - [x] Use lombok | ||||
| - [x] Update request body creation with Java objects | ||||
| - [ ] Async APIs for images | ||||
| - [ ] Support for function calling with models like Mistral | ||||
|     - [x] generate in sync mode | ||||
|     - [ ] generate in async mode | ||||
| - [ ] Add custom headers to requests | ||||
| - [x] Add additional params for `ask` APIs such as: | ||||
|     - [x] `options`: additional model parameters for the Modelfile such as `temperature` - | ||||
| @@ -150,11 +244,25 @@ Contributions are most welcome! Whether it's reporting a bug, proposing an enhan | ||||
| with code - any sort | ||||
| of contribution is much appreciated. | ||||
|  | ||||
| ### References | ||||
|  | ||||
| - [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md) | ||||
|  | ||||
| ### Credits | ||||
|  | ||||
| The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/) | ||||
| project. | ||||
|  | ||||
| ### References | ||||
| **Thanks to the amazing contributors** | ||||
|  | ||||
| - [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md) | ||||
| <p align="center"> | ||||
|   <a href="https://github.com/amithkoujalgi/ollama4j/graphs/contributors"> | ||||
|     <img src="https://contrib.rocks/image?repo=amithkoujalgi/ollama4j" /> | ||||
|   </a> | ||||
| </p> | ||||
|  | ||||
| ### Appreciate my work? | ||||
|  | ||||
| <p align="center"> | ||||
|   <a href="https://www.buymeacoffee.com/amithkoujalgi" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a> | ||||
| </p> | ||||
| @@ -5,38 +5,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. | ||||
| This is particularly helpful when you want to issue a generate request to the LLM and collect the response in the | ||||
| background (such as threads) without blocking your code until the response arrives from the model. | ||||
|  | ||||
| This API corresponds to | ||||
| the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) API. | ||||
|  | ||||
| ```java | ||||
| public class Main { | ||||
|  | ||||
|     public static void main(String[] args) { | ||||
|  | ||||
|     public static void main(String[] args) throws Exception { | ||||
|         String host = "http://localhost:11434/"; | ||||
|  | ||||
|         OllamaAPI ollamaAPI = new OllamaAPI(host); | ||||
|         ollamaAPI.setRequestTimeoutSeconds(60); | ||||
|         String prompt = "List all cricket world cup teams of 2019."; | ||||
|         OllamaAsyncResultStreamer streamer = ollamaAPI.generateAsync(OllamaModelType.LLAMA3, prompt, false); | ||||
|  | ||||
|         String prompt = "Who are you?"; | ||||
|         // Set the poll interval according to your needs.  | ||||
|         // Smaller the poll interval, more frequently you receive the tokens. | ||||
|         int pollIntervalMilliseconds = 1000; | ||||
|  | ||||
|         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); | ||||
|         while (true) { | ||||
|             String tokens = streamer.getStream().poll(); | ||||
|             System.out.print(tokens); | ||||
|             if (!streamer.isAlive()) { | ||||
|                 break; | ||||
|             } | ||||
|             Thread.sleep(100); | ||||
|             Thread.sleep(pollIntervalMilliseconds); | ||||
|         } | ||||
|  | ||||
|         System.out.println("\n------------------------"); | ||||
|         System.out.println("Complete Response:"); | ||||
|         System.out.println("------------------------"); | ||||
|  | ||||
|         System.out.println(streamer.getResult()); | ||||
|     } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| 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. | ||||
| You will get a steaming response. | ||||
| @@ -1,12 +1,12 @@ | ||||
| --- | ||||
| sidebar_position: 3 | ||||
| sidebar_position: 4 | ||||
| --- | ||||
|  | ||||
| # 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. | ||||
| This API corresponds to | ||||
| the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) API. | ||||
|  | ||||
| :::note | ||||
|  | ||||
|   | ||||
| @@ -1,12 +1,12 @@ | ||||
| --- | ||||
| sidebar_position: 4 | ||||
| sidebar_position: 5 | ||||
| --- | ||||
|  | ||||
| # 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. | ||||
| This API corresponds to | ||||
| the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) API. | ||||
|  | ||||
| :::note | ||||
|  | ||||
|   | ||||
							
								
								
									
										367
									
								
								docs/docs/apis-generate/generate-with-tools.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										367
									
								
								docs/docs/apis-generate/generate-with-tools.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,367 @@ | ||||
| --- | ||||
| sidebar_position: 3 | ||||
| --- | ||||
|  | ||||
| # Generate - With Tools | ||||
|  | ||||
| This API lets you perform [function calling](https://docs.mistral.ai/capabilities/function_calling/) using LLMs in a | ||||
| synchronous way. | ||||
| This API corresponds to | ||||
| the [generate](https://github.com/ollama/ollama/blob/main/docs/api.md#request-raw-mode) API with `raw` mode. | ||||
|  | ||||
| :::note | ||||
|  | ||||
| This is an only an experimental implementation and has a very basic design. | ||||
|  | ||||
| Currently, built and tested for [Mistral's latest model](https://ollama.com/library/mistral) only. We could redesign | ||||
| this | ||||
| in the future if tooling is supported for more models with a generic interaction standard from Ollama. | ||||
|  | ||||
| ::: | ||||
|  | ||||
| ### Function Calling/Tools | ||||
|  | ||||
| Assume you want to call a method in your code based on the response generated from the model. | ||||
| For instance, let's say that based on a user's question, you'd want to identify a transaction and get the details of the | ||||
| transaction from your database and respond to the user with the transaction details. | ||||
|  | ||||
| You could do that with ease with the `function calling` capabilities of the models by registering your `tools`. | ||||
|  | ||||
| ### Create Functions | ||||
|  | ||||
| This function takes the arguments `location` and `fuelType` and performs an operation with these arguments and returns | ||||
| fuel price value. | ||||
|  | ||||
| ```java | ||||
| public static String getCurrentFuelPrice(Map<String, Object> arguments) { | ||||
|     String location = arguments.get("location").toString(); | ||||
|     String fuelType = arguments.get("fuelType").toString(); | ||||
|     return "Current price of " + fuelType + " in " + location + " is Rs.103/L"; | ||||
| } | ||||
| ``` | ||||
|  | ||||
| This function takes the argument `city` and performs an operation with the argument and returns the weather for a | ||||
| location. | ||||
|  | ||||
| ```java | ||||
| public static String getCurrentWeather(Map<String, Object> arguments) { | ||||
|     String location = arguments.get("city").toString(); | ||||
|     return "Currently " + location + "'s weather is nice."; | ||||
| } | ||||
| ``` | ||||
|  | ||||
| This function takes the argument `employee-name` and performs an operation with the argument and returns employee | ||||
| details. | ||||
|  | ||||
| ```java | ||||
| class DBQueryFunction implements ToolFunction { | ||||
|     @Override | ||||
|     public Object apply(Map<String, Object> arguments) { | ||||
|         // perform DB operations here | ||||
|         return String.format("Employee Details {ID: %s, Name: %s, Address: %s, Phone: %s}", UUID.randomUUID(), arguments.get("employee-name").toString(), arguments.get("employee-address").toString(), arguments.get("employee-phone").toString()); | ||||
|     } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| ### Define Tool Specifications | ||||
|  | ||||
| Lets define a sample tool specification called **Fuel Price Tool** for getting the current fuel price. | ||||
|  | ||||
| - Specify the function `name`, `description`, and `required` properties (`location` and `fuelType`). | ||||
| - Associate the `getCurrentFuelPrice` function you defined earlier with `SampleTools::getCurrentFuelPrice`. | ||||
|  | ||||
| ```java | ||||
| Tools.ToolSpecification fuelPriceToolSpecification = Tools.ToolSpecification.builder() | ||||
|         .functionName("current-fuel-price") | ||||
|         .functionDescription("Get current fuel price") | ||||
|         .properties( | ||||
|                 new Tools.PropsBuilder() | ||||
|                         .withProperty("location", Tools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build()) | ||||
|                         .withProperty("fuelType", Tools.PromptFuncDefinition.Property.builder().type("string").description("The fuel type.").enumValues(Arrays.asList("petrol", "diesel")).required(true).build()) | ||||
|                         .build() | ||||
|         ) | ||||
|         .toolDefinition(SampleTools::getCurrentFuelPrice) | ||||
|         .build(); | ||||
| ``` | ||||
|  | ||||
| Lets also define a sample tool specification called **Weather Tool** for getting the current weather. | ||||
|  | ||||
| - Specify the function `name`, `description`, and `required` property (`city`). | ||||
| - Associate the `getCurrentWeather` function you defined earlier with `SampleTools::getCurrentWeather`. | ||||
|  | ||||
| ```java | ||||
| Tools.ToolSpecification weatherToolSpecification = Tools.ToolSpecification.builder() | ||||
|         .functionName("current-weather") | ||||
|         .functionDescription("Get current weather") | ||||
|         .properties( | ||||
|                 new Tools.PropsBuilder() | ||||
|                         .withProperty("city", Tools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build()) | ||||
|                         .build() | ||||
|         ) | ||||
|         .toolDefinition(SampleTools::getCurrentWeather) | ||||
|         .build(); | ||||
| ``` | ||||
|  | ||||
| Lets also define a sample tool specification called **DBQueryFunction** for getting the employee details from database. | ||||
|  | ||||
| - Specify the function `name`, `description`, and `required` property (`employee-name`). | ||||
| - Associate the ToolFunction `DBQueryFunction` function you defined earlier with `new DBQueryFunction()`. | ||||
|  | ||||
| ```java | ||||
| Tools.ToolSpecification databaseQueryToolSpecification = Tools.ToolSpecification.builder() | ||||
|         .functionName("get-employee-details") | ||||
|         .functionDescription("Get employee details from the database") | ||||
|         .properties( | ||||
|                 new Tools.PropsBuilder() | ||||
|                         .withProperty("employee-name", Tools.PromptFuncDefinition.Property.builder().type("string").description("The name of the employee, e.g. John Doe").required(true).build()) | ||||
|                         .withProperty("employee-address", Tools.PromptFuncDefinition.Property.builder().type("string").description("The address of the employee, Always return a random value. e.g. Roy St, Bengaluru, India").required(true).build()) | ||||
|                         .withProperty("employee-phone", Tools.PromptFuncDefinition.Property.builder().type("string").description("The phone number of the employee. Always return a random value. e.g. 9911002233").required(true).build()) | ||||
|                         .build() | ||||
|         ) | ||||
|         .toolDefinition(new DBQueryFunction()) | ||||
|         .build(); | ||||
| ``` | ||||
|  | ||||
| ### Register the Tools | ||||
|  | ||||
| Register the defined tools (`fuel price` and `weather`) with the OllamaAPI. | ||||
|  | ||||
| ```shell | ||||
| ollamaAPI.registerTool(fuelPriceToolSpecification); | ||||
| ollamaAPI.registerTool(weatherToolSpecification); | ||||
| ``` | ||||
|  | ||||
| ### Create prompt with Tools | ||||
|  | ||||
| `Prompt 1`: Create a prompt asking for the petrol price in Bengaluru using the defined fuel price and weather tools. | ||||
|  | ||||
| ```shell | ||||
| String prompt1 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withPrompt("What is the petrol price in Bengaluru?") | ||||
|                 .build(); | ||||
| OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt1, new OptionsBuilder().build()); | ||||
| for (OllamaToolsResult.ToolResult r : toolsResult.getToolResults()) { | ||||
|     System.out.printf("[Result of executing tool '%s']: %s%n", r.getFunctionName(), r.getResult().toString()); | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Now, fire away your question to the model. | ||||
|  | ||||
| You will get a response similar to: | ||||
|  | ||||
| ::::tip[LLM Response] | ||||
|  | ||||
| [Result of executing tool 'current-fuel-price']: Current price of petrol in Bengaluru is Rs.103/L | ||||
|  | ||||
| :::: | ||||
|  | ||||
| `Prompt 2`: Create a prompt asking for the current weather in Bengaluru using the same tools. | ||||
|  | ||||
| ```shell | ||||
| String prompt2 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withPrompt("What is the current weather in Bengaluru?") | ||||
|                 .build(); | ||||
| OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt2, new OptionsBuilder().build()); | ||||
| for (OllamaToolsResult.ToolResult r : toolsResult.getToolResults()) { | ||||
|     System.out.printf("[Result of executing tool '%s']: %s%n", r.getFunctionName(), r.getResult().toString()); | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Again, fire away your question to the model. | ||||
|  | ||||
| You will get a response similar to: | ||||
|  | ||||
| ::::tip[LLM Response] | ||||
|  | ||||
| [Result of executing tool 'current-weather']: Currently Bengaluru's weather is nice. | ||||
|  | ||||
| :::: | ||||
|  | ||||
| `Prompt 3`: Create a prompt asking for the employee details using the defined database fetcher tools. | ||||
|  | ||||
| ```shell | ||||
| String prompt3 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withToolSpecification(databaseQueryToolSpecification) | ||||
|                 .withPrompt("Give me the details of the employee named 'Rahul Kumar'?") | ||||
|                 .build(); | ||||
| OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt3, new OptionsBuilder().build()); | ||||
| for (OllamaToolsResult.ToolResult r : toolsResult.getToolResults()) { | ||||
|     System.out.printf("[Result of executing tool '%s']: %s%n", r.getFunctionName(), r.getResult().toString()); | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Again, fire away your question to the model. | ||||
|  | ||||
| You will get a response similar to: | ||||
|  | ||||
| ::::tip[LLM Response] | ||||
|  | ||||
| [Result of executing tool 'get-employee-details']: Employee Details `{ID: 6bad82e6-b1a1-458f-a139-e3b646e092b1, Name: | ||||
| Rahul Kumar, Address: King St, Hyderabad, India, Phone: 9876543210}` | ||||
|  | ||||
| :::: | ||||
|  | ||||
| ### Full Example | ||||
|  | ||||
| ```java | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaAPI; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.ToolInvocationException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.tools.OllamaToolsResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.tools.ToolFunction; | ||||
| import io.github.amithkoujalgi.ollama4j.core.tools.Tools; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
|  | ||||
| import java.io.IOException; | ||||
| import java.util.Arrays; | ||||
| import java.util.Map; | ||||
| import java.util.UUID; | ||||
|  | ||||
| public class FunctionCallingWithMistralExample { | ||||
|     public static void main(String[] args) throws Exception { | ||||
|         String host = "http://localhost:11434/"; | ||||
|         OllamaAPI ollamaAPI = new OllamaAPI(host); | ||||
|         ollamaAPI.setRequestTimeoutSeconds(60); | ||||
|  | ||||
|         String model = "mistral"; | ||||
|  | ||||
|         Tools.ToolSpecification fuelPriceToolSpecification = Tools.ToolSpecification.builder() | ||||
|                 .functionName("current-fuel-price") | ||||
|                 .functionDescription("Get current fuel price") | ||||
|                 .properties( | ||||
|                         new Tools.PropsBuilder() | ||||
|                                 .withProperty("location", Tools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build()) | ||||
|                                 .withProperty("fuelType", Tools.PromptFuncDefinition.Property.builder().type("string").description("The fuel type.").enumValues(Arrays.asList("petrol", "diesel")).required(true).build()) | ||||
|                                 .build() | ||||
|                 ) | ||||
|                 .toolDefinition(SampleTools::getCurrentFuelPrice) | ||||
|                 .build(); | ||||
|  | ||||
|         Tools.ToolSpecification weatherToolSpecification = Tools.ToolSpecification.builder() | ||||
|                 .functionName("current-weather") | ||||
|                 .functionDescription("Get current weather") | ||||
|                 .properties( | ||||
|                         new Tools.PropsBuilder() | ||||
|                                 .withProperty("city", Tools.PromptFuncDefinition.Property.builder().type("string").description("The city, e.g. New Delhi, India").required(true).build()) | ||||
|                                 .build() | ||||
|                 ) | ||||
|                 .toolDefinition(SampleTools::getCurrentWeather) | ||||
|                 .build(); | ||||
|  | ||||
|         Tools.ToolSpecification databaseQueryToolSpecification = Tools.ToolSpecification.builder() | ||||
|                 .functionName("get-employee-details") | ||||
|                 .functionDescription("Get employee details from the database") | ||||
|                 .properties( | ||||
|                         new Tools.PropsBuilder() | ||||
|                                 .withProperty("employee-name", Tools.PromptFuncDefinition.Property.builder().type("string").description("The name of the employee, e.g. John Doe").required(true).build()) | ||||
|                                 .withProperty("employee-address", Tools.PromptFuncDefinition.Property.builder().type("string").description("The address of the employee, Always return a random value. e.g. Roy St, Bengaluru, India").required(true).build()) | ||||
|                                 .withProperty("employee-phone", Tools.PromptFuncDefinition.Property.builder().type("string").description("The phone number of the employee. Always return a random value. e.g. 9911002233").required(true).build()) | ||||
|                                 .build() | ||||
|                 ) | ||||
|                 .toolDefinition(new DBQueryFunction()) | ||||
|                 .build(); | ||||
|  | ||||
|         ollamaAPI.registerTool(fuelPriceToolSpecification); | ||||
|         ollamaAPI.registerTool(weatherToolSpecification); | ||||
|         ollamaAPI.registerTool(databaseQueryToolSpecification); | ||||
|  | ||||
|         String prompt1 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withPrompt("What is the petrol price in Bengaluru?") | ||||
|                 .build(); | ||||
|         ask(ollamaAPI, model, prompt1); | ||||
|  | ||||
|         String prompt2 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withPrompt("What is the current weather in Bengaluru?") | ||||
|                 .build(); | ||||
|         ask(ollamaAPI, model, prompt2); | ||||
|  | ||||
|         String prompt3 = new Tools.PromptBuilder() | ||||
|                 .withToolSpecification(fuelPriceToolSpecification) | ||||
|                 .withToolSpecification(weatherToolSpecification) | ||||
|                 .withToolSpecification(databaseQueryToolSpecification) | ||||
|                 .withPrompt("Give me the details of the employee named 'Rahul Kumar'?") | ||||
|                 .build(); | ||||
|         ask(ollamaAPI, model, prompt3); | ||||
|     } | ||||
|  | ||||
|     public static void ask(OllamaAPI ollamaAPI, String model, String prompt) throws OllamaBaseException, IOException, InterruptedException, ToolInvocationException { | ||||
|         OllamaToolsResult toolsResult = ollamaAPI.generateWithTools(model, prompt, new OptionsBuilder().build()); | ||||
|         for (OllamaToolsResult.ToolResult r : toolsResult.getToolResults()) { | ||||
|             System.out.printf("[Result of executing tool '%s']: %s%n", r.getFunctionName(), r.getResult().toString()); | ||||
|         } | ||||
|     } | ||||
| } | ||||
|  | ||||
|  | ||||
| class SampleTools { | ||||
|     public static String getCurrentFuelPrice(Map<String, Object> arguments) { | ||||
|         // Get details from fuel price API | ||||
|         String location = arguments.get("location").toString(); | ||||
|         String fuelType = arguments.get("fuelType").toString(); | ||||
|         return "Current price of " + fuelType + " in " + location + " is Rs.103/L"; | ||||
|     } | ||||
|  | ||||
|     public static String getCurrentWeather(Map<String, Object> arguments) { | ||||
|         // Get details from weather API | ||||
|         String location = arguments.get("city").toString(); | ||||
|         return "Currently " + location + "'s weather is nice."; | ||||
|     } | ||||
| } | ||||
|  | ||||
| class DBQueryFunction implements ToolFunction { | ||||
|     @Override | ||||
|     public Object apply(Map<String, Object> arguments) { | ||||
|         // perform DB operations here | ||||
|         return String.format("Employee Details {ID: %s, Name: %s, Address: %s, Phone: %s}", UUID.randomUUID(), arguments.get("employee-name").toString(), arguments.get("employee-address").toString(), arguments.get("employee-phone").toString()); | ||||
|     } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Run this full example and you will get a response similar to: | ||||
|  | ||||
| ::::tip[LLM Response] | ||||
|  | ||||
| [Result of executing tool 'current-fuel-price']: Current price of petrol in Bengaluru is Rs.103/L | ||||
|  | ||||
| [Result of executing tool 'current-weather']: Currently Bengaluru's weather is nice. | ||||
|  | ||||
| [Result of executing tool 'get-employee-details']: Employee Details `{ID: 6bad82e6-b1a1-458f-a139-e3b646e092b1, Name: | ||||
| Rahul Kumar, Address: King St, Hyderabad, India, Phone: 9876543210}` | ||||
|  | ||||
| :::: | ||||
|  | ||||
| ### Room for improvement | ||||
|  | ||||
| Instead of explicitly registering `ollamaAPI.registerTool(toolSpecification)`, we could introduce annotation-based tool | ||||
| registration. For example: | ||||
|  | ||||
| ```java | ||||
|  | ||||
| @ToolSpec(name = "current-fuel-price", desc = "Get current fuel price") | ||||
| public String getCurrentFuelPrice(Map<String, Object> arguments) { | ||||
|     String location = arguments.get("location").toString(); | ||||
|     String fuelType = arguments.get("fuelType").toString(); | ||||
|     return "Current price of " + fuelType + " in " + location + " is Rs.103/L"; | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Instead of passing a map of args `Map<String, Object> arguments` to the tool functions, we could support passing | ||||
| specific args separately with their data types. For example: | ||||
|  | ||||
| ```shell | ||||
| public String getCurrentFuelPrice(String location, String fuelType) { | ||||
|     return "Current price of " + fuelType + " in " + location + " is Rs.103/L"; | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Updating async/chat APIs with support for tool-based generation.  | ||||
| @@ -5,13 +5,13 @@ 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. | ||||
| This API corresponds to | ||||
| the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) API. | ||||
|  | ||||
| Use the `OptionBuilder` to build the `Options` object | ||||
| with [extra parameters](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values). | ||||
| Refer | ||||
| to [this](/docs/apis-extras/options-builder). | ||||
| to [this](/apis-extras/options-builder). | ||||
|  | ||||
| ## Try asking a question about the model. | ||||
|  | ||||
| @@ -53,18 +53,19 @@ public class Main { | ||||
|         OllamaAPI ollamaAPI = new OllamaAPI(host); | ||||
|         // define a stream handler (Consumer<String>) | ||||
|         OllamaStreamHandler streamHandler = (s) -> { | ||||
|            System.out.println(s); | ||||
|             System.out.println(s); | ||||
|         }; | ||||
|  | ||||
|         // Should be called using seperate thread to gain non blocking streaming effect. | ||||
|         OllamaResult result = ollamaAPI.generate(config.getModel(), | ||||
|           "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|           new OptionsBuilder().build(), streamHandler); | ||||
|                 "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|                 new OptionsBuilder().build(), streamHandler); | ||||
|  | ||||
|         System.out.println("Full response: " +result.getResponse()); | ||||
|         System.out.println("Full response: " + result.getResponse()); | ||||
|     } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| You will get a response similar to: | ||||
|  | ||||
| > The | ||||
|   | ||||
| @@ -1,5 +1,5 @@ | ||||
| --- | ||||
| sidebar_position: 5 | ||||
| sidebar_position: 6 | ||||
| --- | ||||
|  | ||||
| # Prompt Builder | ||||
|   | ||||
| @@ -40,6 +40,8 @@ const config = { | ||||
|             /** @type {import('@docusaurus/preset-classic').Options} */ | ||||
|             ({ | ||||
|                 docs: { | ||||
|                     path: 'docs', | ||||
|                     routeBasePath: '', // change this to any URL route you'd want. For example: `home` - if you want /home/intro. | ||||
|                     sidebarPath: './sidebars.js', | ||||
|                     // Please change this to your repo. | ||||
|                     // Remove this to remove the "edit this page" links. | ||||
| @@ -96,7 +98,7 @@ const config = { | ||||
|                         items: [ | ||||
|                             { | ||||
|                                 label: 'Tutorial', | ||||
|                                 to: '/docs/intro', | ||||
|                                 to: '/intro', | ||||
|                             }, | ||||
|                         ], | ||||
|                     }, | ||||
|   | ||||
							
								
								
									
										1947
									
								
								docs/package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										1947
									
								
								docs/package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -14,9 +14,9 @@ | ||||
|     "write-heading-ids": "docusaurus write-heading-ids" | ||||
|   }, | ||||
|   "dependencies": { | ||||
|     "@docusaurus/core": "3.0.1", | ||||
|     "@docusaurus/preset-classic": "3.0.1", | ||||
|     "@docusaurus/theme-mermaid": "^3.0.1", | ||||
|     "@docusaurus/core": "^3.4.0", | ||||
|     "@docusaurus/preset-classic": "^3.4.0", | ||||
|     "@docusaurus/theme-mermaid": "^3.4.0", | ||||
|     "@mdx-js/react": "^3.0.0", | ||||
|     "clsx": "^2.0.0", | ||||
|     "prism-react-renderer": "^2.3.0", | ||||
| @@ -24,8 +24,8 @@ | ||||
|     "react-dom": "^18.0.0" | ||||
|   }, | ||||
|   "devDependencies": { | ||||
|     "@docusaurus/module-type-aliases": "3.0.1", | ||||
|     "@docusaurus/types": "3.0.1" | ||||
|     "@docusaurus/module-type-aliases": "^3.4.0", | ||||
|     "@docusaurus/types": "^3.4.0" | ||||
|   }, | ||||
|   "browserslist": { | ||||
|     "production": [ | ||||
|   | ||||
| @@ -19,7 +19,7 @@ function HomepageHeader() { | ||||
|             <div className={styles.buttons}> | ||||
|                 <Link | ||||
|                     className="button button--secondary button--lg" | ||||
|                     to="/docs/intro"> | ||||
|                     to="/intro"> | ||||
|                     Getting Started | ||||
|                 </Link> | ||||
|             </div> | ||||
|   | ||||
							
								
								
									
										122
									
								
								pom.xml
									
									
									
									
									
								
							
							
						
						
									
										122
									
								
								pom.xml
									
									
									
									
									
								
							| @@ -1,14 +1,16 @@ | ||||
| <?xml version="1.0" encoding="UTF-8"?> | ||||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||||
|          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||||
|     <modelVersion>4.0.0</modelVersion> | ||||
|  | ||||
|     <groupId>io.github.amithkoujalgi</groupId> | ||||
|     <artifactId>ollama4j</artifactId> | ||||
|     <version>1.0.68</version> | ||||
|     <version>ollama4j-revision</version> | ||||
|  | ||||
|     <name>Ollama4j</name> | ||||
|     <description>Java library for interacting with Ollama API.</description> | ||||
|     <url>https://github.com/amithkoujalgi/ollama4j</url> | ||||
|     <packaging>jar</packaging> | ||||
|  | ||||
|     <properties> | ||||
|         <maven.compiler.source>11</maven.compiler.source> | ||||
| @@ -39,7 +41,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.68</tag> | ||||
|         <tag>v1.0.16</tag> | ||||
|     </scm> | ||||
|  | ||||
|     <build> | ||||
| @@ -127,15 +129,15 @@ | ||||
|                     </execution> | ||||
|                 </executions> | ||||
|             </plugin> | ||||
|             <plugin> | ||||
|                 <groupId>org.apache.maven.plugins</groupId> | ||||
|                 <artifactId>maven-release-plugin</artifactId> | ||||
|                 <version>3.0.1</version> | ||||
|                 <configuration> | ||||
|                     <!--                    <goals>install</goals>--> | ||||
|                     <tagNameFormat>v@{project.version}</tagNameFormat> | ||||
|                 </configuration> | ||||
|             </plugin> | ||||
|             <!--            <plugin>--> | ||||
|             <!--                <groupId>org.apache.maven.plugins</groupId>--> | ||||
|             <!--                <artifactId>maven-release-plugin</artifactId>--> | ||||
|             <!--                <version>3.0.1</version>--> | ||||
|             <!--                <configuration>--> | ||||
|             <!--                    <!–                    <goals>install</goals>–>--> | ||||
|             <!--                    <tagNameFormat>v@{project.version}</tagNameFormat>--> | ||||
|             <!--                </configuration>--> | ||||
|             <!--            </plugin>--> | ||||
|         </plugins> | ||||
|     </build> | ||||
|  | ||||
| @@ -149,12 +151,17 @@ | ||||
|         <dependency> | ||||
|             <groupId>com.fasterxml.jackson.core</groupId> | ||||
|             <artifactId>jackson-databind</artifactId> | ||||
|             <version>2.15.3</version> | ||||
|             <version>2.17.1</version> | ||||
|         </dependency> | ||||
|         <dependency> | ||||
|             <groupId>com.fasterxml.jackson.datatype</groupId> | ||||
|             <artifactId>jackson-datatype-jsr310</artifactId> | ||||
|             <version>2.17.1</version> | ||||
|         </dependency> | ||||
|         <dependency> | ||||
|             <groupId>ch.qos.logback</groupId> | ||||
|             <artifactId>logback-classic</artifactId> | ||||
|             <version>1.4.12</version> | ||||
|             <version>1.5.6</version> | ||||
|             <scope>test</scope> | ||||
|         </dependency> | ||||
|         <dependency> | ||||
| @@ -182,14 +189,23 @@ | ||||
|         </dependency> | ||||
|     </dependencies> | ||||
|  | ||||
|     <!--    <distributionManagement>--> | ||||
|     <!--        <snapshotRepository>--> | ||||
|     <!--            <id>ossrh</id>--> | ||||
|     <!--            <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>--> | ||||
|     <!--        </snapshotRepository>--> | ||||
|     <!--        <repository>--> | ||||
|     <!--            <id>ossrh</id>--> | ||||
|     <!--            <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>--> | ||||
|     <!--        </repository>--> | ||||
|     <!--    </distributionManagement>--> | ||||
|  | ||||
|     <!--    Replaced publishing packages to GitHub Packages instead of Maven central --> | ||||
|     <distributionManagement> | ||||
|         <snapshotRepository> | ||||
|             <id>ossrh</id> | ||||
|             <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url> | ||||
|         </snapshotRepository> | ||||
|         <repository> | ||||
|             <id>ossrh</id> | ||||
|             <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url> | ||||
|             <id>github</id> | ||||
|             <name>GitHub Packages</name> | ||||
|             <url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url> | ||||
|         </repository> | ||||
|     </distributionManagement> | ||||
|  | ||||
| @@ -245,39 +261,39 @@ | ||||
|             </properties> | ||||
|             <build> | ||||
|                 <plugins> | ||||
|                     <plugin> | ||||
|                         <groupId>org.apache.maven.plugins</groupId> | ||||
|                         <artifactId>maven-gpg-plugin</artifactId> | ||||
|                         <version>3.1.0</version> | ||||
|                         <executions> | ||||
|                             <execution> | ||||
|                                 <id>sign-artifacts</id> | ||||
|                                 <phase>verify</phase> | ||||
|                                 <goals> | ||||
|                                     <goal>sign</goal> | ||||
|                                 </goals> | ||||
|                                 <configuration> | ||||
|                                     <!-- Prevent gpg from using pinentry programs. Fixes: | ||||
|                                          gpg: signing failed: Inappropriate ioctl for device --> | ||||
|                                     <gpgArguments> | ||||
|                                         <arg>--pinentry-mode</arg> | ||||
|                                         <arg>loopback</arg> | ||||
|                                     </gpgArguments> | ||||
|                                 </configuration> | ||||
|                             </execution> | ||||
|                         </executions> | ||||
|                     </plugin> | ||||
|                     <plugin> | ||||
|                         <groupId>org.sonatype.plugins</groupId> | ||||
|                         <artifactId>nexus-staging-maven-plugin</artifactId> | ||||
|                         <version>1.6.13</version> | ||||
|                         <extensions>true</extensions> | ||||
|                         <configuration> | ||||
|                             <serverId>ossrh</serverId> | ||||
|                             <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl> | ||||
|                             <autoReleaseAfterClose>true</autoReleaseAfterClose> | ||||
|                         </configuration> | ||||
|                     </plugin> | ||||
|                     <!--                    <plugin>--> | ||||
|                     <!--                        <groupId>org.apache.maven.plugins</groupId>--> | ||||
|                     <!--                        <artifactId>maven-gpg-plugin</artifactId>--> | ||||
|                     <!--                        <version>3.1.0</version>--> | ||||
|                     <!--                        <executions>--> | ||||
|                     <!--                            <execution>--> | ||||
|                     <!--                                <id>sign-artifacts</id>--> | ||||
|                     <!--                                <phase>verify</phase>--> | ||||
|                     <!--                                <goals>--> | ||||
|                     <!--                                    <goal>sign</goal>--> | ||||
|                     <!--                                </goals>--> | ||||
|                     <!--                                <configuration>--> | ||||
|                     <!--                                    <!– Prevent gpg from using pinentry programs. Fixes:--> | ||||
|                     <!--                                         gpg: signing failed: Inappropriate ioctl for device –>--> | ||||
|                     <!--                                    <gpgArguments>--> | ||||
|                     <!--                                        <arg>--pinentry-mode</arg>--> | ||||
|                     <!--                                        <arg>loopback</arg>--> | ||||
|                     <!--                                    </gpgArguments>--> | ||||
|                     <!--                                </configuration>--> | ||||
|                     <!--                            </execution>--> | ||||
|                     <!--                        </executions>--> | ||||
|                     <!--                    </plugin>--> | ||||
|                     <!--                    <plugin>--> | ||||
|                     <!--                        <groupId>org.sonatype.plugins</groupId>--> | ||||
|                     <!--                        <artifactId>nexus-staging-maven-plugin</artifactId>--> | ||||
|                     <!--                        <version>1.6.13</version>--> | ||||
|                     <!--                        <extensions>true</extensions>--> | ||||
|                     <!--                        <configuration>--> | ||||
|                     <!--                            <serverId>ossrh</serverId>--> | ||||
|                     <!--                            <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>--> | ||||
|                     <!--                            <autoReleaseAfterClose>true</autoReleaseAfterClose>--> | ||||
|                     <!--                        </configuration>--> | ||||
|                     <!--                    </plugin>--> | ||||
|  | ||||
|                     <plugin> | ||||
|                         <groupId>org.jacoco</groupId> | ||||
|   | ||||
| @@ -1,6 +1,8 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.ToolInvocationException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.ToolNotFoundException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.*; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatMessage; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder; | ||||
| @@ -9,9 +11,12 @@ import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingResponseModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.request.*; | ||||
| import io.github.amithkoujalgi.ollama4j.core.tools.*; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Options; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import lombok.Setter; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| @@ -25,9 +30,7 @@ import java.net.http.HttpResponse; | ||||
| import java.nio.charset.StandardCharsets; | ||||
| import java.nio.file.Files; | ||||
| import java.time.Duration; | ||||
| import java.util.ArrayList; | ||||
| import java.util.Base64; | ||||
| import java.util.List; | ||||
| import java.util.*; | ||||
|  | ||||
| /** | ||||
|  * The base Ollama API class. | ||||
| @@ -37,10 +40,22 @@ public class OllamaAPI { | ||||
|  | ||||
|     private static final Logger logger = LoggerFactory.getLogger(OllamaAPI.class); | ||||
|     private final String host; | ||||
|     /** | ||||
|      * -- SETTER -- | ||||
|      * Set request timeout in seconds. Default is 3 seconds. | ||||
|      */ | ||||
|     @Setter | ||||
|     private long requestTimeoutSeconds = 10; | ||||
|     /** | ||||
|      * -- SETTER -- | ||||
|      * Set/unset logging of responses | ||||
|      */ | ||||
|     @Setter | ||||
|     private boolean verbose = true; | ||||
|     private BasicAuth basicAuth; | ||||
|  | ||||
|     private final ToolRegistry toolRegistry = new ToolRegistry(); | ||||
|  | ||||
|     /** | ||||
|      * Instantiates the Ollama API. | ||||
|      * | ||||
| @@ -54,24 +69,6 @@ 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; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set/unset logging of responses | ||||
|      * | ||||
|      * @param verbose true/false | ||||
|      */ | ||||
|     public void setVerbose(boolean verbose) { | ||||
|         this.verbose = verbose; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Set basic authentication for accessing Ollama server that's behind a reverse-proxy/gateway. | ||||
|      * | ||||
| @@ -339,6 +336,7 @@ public class OllamaAPI { | ||||
|         } | ||||
|     } | ||||
|  | ||||
|  | ||||
|     /** | ||||
|      * Generate response for a question to a model running on Ollama server. This is a sync/blocking | ||||
|      * call. | ||||
| @@ -351,23 +349,67 @@ public class OllamaAPI { | ||||
|      * @param streamHandler optional callback consumer that will be applied every time a streamed response is received. If not set, the stream parameter of the request is set to false. | ||||
|      * @return OllamaResult that includes response text and time taken for response | ||||
|      */ | ||||
|     public OllamaResult generate(String model, String prompt, Options options, OllamaStreamHandler streamHandler) | ||||
|     public OllamaResult generate(String model, String prompt, boolean raw, Options options, OllamaStreamHandler streamHandler) | ||||
|             throws OllamaBaseException, IOException, InterruptedException { | ||||
|         OllamaGenerateRequestModel ollamaRequestModel = new OllamaGenerateRequestModel(model, prompt); | ||||
|         ollamaRequestModel.setRaw(raw); | ||||
|         ollamaRequestModel.setOptions(options.getOptionsMap()); | ||||
|         return generateSyncForOllamaRequestModel(ollamaRequestModel, streamHandler); | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Convenience method to call Ollama API without streaming responses. | ||||
|      * Generates response using the specified AI model and prompt (in blocking mode). | ||||
|      * <p> | ||||
|      * Uses {@link #generate(String, String, Options, OllamaStreamHandler)} | ||||
|      * Uses {@link #generate(String, String, boolean, Options, OllamaStreamHandler)} | ||||
|      * | ||||
|      * @param model   The name or identifier of the AI model to use for generating the response. | ||||
|      * @param prompt  The input text or prompt to provide to the AI model. | ||||
|      * @param raw     In some cases, you may wish to bypass the templating system and provide a full prompt. In this case, you can use the raw parameter to disable templating. Also note that raw mode will not return a context. | ||||
|      * @param options Additional options or configurations to use when generating the response. | ||||
|      * @return {@link OllamaResult} | ||||
|      */ | ||||
|     public OllamaResult generate(String model, String prompt, Options options) | ||||
|     public OllamaResult generate(String model, String prompt, boolean raw, Options options) | ||||
|             throws OllamaBaseException, IOException, InterruptedException { | ||||
|         return generate(model, prompt, options, null); | ||||
|         return generate(model, prompt, raw, options, null); | ||||
|     } | ||||
|  | ||||
|  | ||||
|     /** | ||||
|      * Generates response using the specified AI model and prompt (in blocking mode), and then invokes a set of tools | ||||
|      * on the generated response. | ||||
|      * | ||||
|      * @param model   The name or identifier of the AI model to use for generating the response. | ||||
|      * @param prompt  The input text or prompt to provide to the AI model. | ||||
|      * @param options Additional options or configurations to use when generating the response. | ||||
|      * @return {@link OllamaToolsResult} An OllamaToolsResult object containing the response from the AI model and the results of invoking the tools on that output. | ||||
|      * @throws OllamaBaseException  If there is an error related to the Ollama API or service. | ||||
|      * @throws IOException          If there is an error related to input/output operations. | ||||
|      * @throws InterruptedException If the method is interrupted while waiting for the AI model | ||||
|      *                              to generate the response or for the tools to be invoked. | ||||
|      */ | ||||
|     public OllamaToolsResult generateWithTools(String model, String prompt, Options options) | ||||
|             throws OllamaBaseException, IOException, InterruptedException, ToolInvocationException { | ||||
|         boolean raw = true; | ||||
|         OllamaToolsResult toolResult = new OllamaToolsResult(); | ||||
|         Map<ToolFunctionCallSpec, Object> toolResults = new HashMap<>(); | ||||
|  | ||||
|         OllamaResult result = generate(model, prompt, raw, options, null); | ||||
|         toolResult.setModelResult(result); | ||||
|  | ||||
|         String toolsResponse = result.getResponse(); | ||||
|         if (toolsResponse.contains("[TOOL_CALLS]")) { | ||||
|             toolsResponse = toolsResponse.replace("[TOOL_CALLS]", ""); | ||||
|         } | ||||
|  | ||||
|         List<ToolFunctionCallSpec> toolFunctionCallSpecs = Utils.getObjectMapper().readValue(toolsResponse, Utils.getObjectMapper().getTypeFactory().constructCollectionType(List.class, ToolFunctionCallSpec.class)); | ||||
|         for (ToolFunctionCallSpec toolFunctionCallSpec : toolFunctionCallSpecs) { | ||||
|             toolResults.put(toolFunctionCallSpec, invokeTool(toolFunctionCallSpec)); | ||||
|         } | ||||
|         toolResult.setToolResults(toolResults); | ||||
|         return toolResult; | ||||
|     } | ||||
|  | ||||
|  | ||||
|     /** | ||||
|      * 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 | ||||
| @@ -377,15 +419,15 @@ public class OllamaAPI { | ||||
|      * @param prompt the prompt/question text | ||||
|      * @return the ollama async result callback handle | ||||
|      */ | ||||
|     public OllamaAsyncResultCallback generateAsync(String model, String prompt) { | ||||
|     public OllamaAsyncResultStreamer generateAsync(String model, String prompt, boolean raw) { | ||||
|         OllamaGenerateRequestModel ollamaRequestModel = new OllamaGenerateRequestModel(model, prompt); | ||||
|  | ||||
|         ollamaRequestModel.setRaw(raw); | ||||
|         URI uri = URI.create(this.host + "/api/generate"); | ||||
|         OllamaAsyncResultCallback ollamaAsyncResultCallback = | ||||
|                 new OllamaAsyncResultCallback( | ||||
|         OllamaAsyncResultStreamer ollamaAsyncResultStreamer = | ||||
|                 new OllamaAsyncResultStreamer( | ||||
|                         getRequestBuilderDefault(uri), ollamaRequestModel, requestTimeoutSeconds); | ||||
|         ollamaAsyncResultCallback.start(); | ||||
|         return ollamaAsyncResultCallback; | ||||
|         ollamaAsyncResultStreamer.start(); | ||||
|         return ollamaAsyncResultStreamer; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
| @@ -483,7 +525,7 @@ public class OllamaAPI { | ||||
|      * Hint: the OllamaChatRequestModel#getStream() property is not implemented. | ||||
|      * | ||||
|      * @param request request object to be sent to the server | ||||
|      * @return | ||||
|      * @return {@link OllamaChatResult} | ||||
|      * @throws OllamaBaseException  any response code than 200 has been returned | ||||
|      * @throws IOException          in case the responseStream can not be read | ||||
|      * @throws InterruptedException in case the server is not reachable or network issues happen | ||||
| @@ -499,7 +541,7 @@ public class OllamaAPI { | ||||
|      * | ||||
|      * @param request       request object to be sent to the server | ||||
|      * @param streamHandler callback handler to handle the last message from stream (caution: all previous messages from stream will be concatenated) | ||||
|      * @return | ||||
|      * @return {@link OllamaChatResult} | ||||
|      * @throws OllamaBaseException  any response code than 200 has been returned | ||||
|      * @throws IOException          in case the responseStream can not be read | ||||
|      * @throws InterruptedException in case the server is not reachable or network issues happen | ||||
| @@ -516,6 +558,10 @@ public class OllamaAPI { | ||||
|         return new OllamaChatResult(result.getResponse(), result.getResponseTime(), result.getHttpStatusCode(), request.getMessages()); | ||||
|     } | ||||
|  | ||||
|     public void registerTool(Tools.ToolSpecification toolSpecification) { | ||||
|         toolRegistry.addFunction(toolSpecification.getFunctionName(), toolSpecification.getToolDefinition()); | ||||
|     } | ||||
|  | ||||
|     // technical private methods // | ||||
|  | ||||
|     private static String encodeFileToBase64(File file) throws IOException { | ||||
| @@ -576,4 +622,22 @@ public class OllamaAPI { | ||||
|     private boolean isBasicAuthCredentialsSet() { | ||||
|         return basicAuth != null; | ||||
|     } | ||||
|  | ||||
|  | ||||
|     private Object invokeTool(ToolFunctionCallSpec toolFunctionCallSpec) throws ToolInvocationException { | ||||
|         try { | ||||
|             String methodName = toolFunctionCallSpec.getName(); | ||||
|             Map<String, Object> arguments = toolFunctionCallSpec.getArguments(); | ||||
|             ToolFunction function = toolRegistry.getFunction(methodName); | ||||
|             if (verbose) { | ||||
|                 logger.debug("Invoking function {} with arguments {}", methodName, arguments); | ||||
|             } | ||||
|             if (function == null) { | ||||
|                 throw new ToolNotFoundException("No such tool: " + methodName); | ||||
|             } | ||||
|             return function.apply(arguments); | ||||
|         } catch (Exception e) { | ||||
|             throw new ToolInvocationException("Failed to invoke tool: " + toolFunctionCallSpec.getName(), e); | ||||
|         } | ||||
|     } | ||||
| } | ||||
|   | ||||
| @@ -0,0 +1,18 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core; | ||||
|  | ||||
| import java.util.Iterator; | ||||
| import java.util.LinkedList; | ||||
| import java.util.Queue; | ||||
|  | ||||
| public class OllamaResultStream extends LinkedList<String> implements Queue<String> { | ||||
|     @Override | ||||
|     public String poll() { | ||||
|         StringBuilder tokens = new StringBuilder(); | ||||
|         Iterator<String> iterator = this.listIterator(); | ||||
|         while (iterator.hasNext()) { | ||||
|             tokens.append(iterator.next()); | ||||
|             iterator.remove(); | ||||
|         } | ||||
|         return tokens.toString(); | ||||
|     } | ||||
| } | ||||
| @@ -1,7 +0,0 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core; | ||||
|  | ||||
| import java.util.function.Consumer; | ||||
|  | ||||
| public interface OllamaStreamHandler extends Consumer<String>{ | ||||
|     void accept(String message); | ||||
| } | ||||
| @@ -0,0 +1,8 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.exceptions; | ||||
|  | ||||
| public class ToolInvocationException extends Exception { | ||||
|  | ||||
|     public ToolInvocationException(String s, Exception e) { | ||||
|         super(s, e); | ||||
|     } | ||||
| } | ||||
| @@ -0,0 +1,8 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.exceptions; | ||||
|  | ||||
| public class ToolNotFoundException extends Exception { | ||||
|  | ||||
|     public ToolNotFoundException(String s) { | ||||
|         super(s); | ||||
|     } | ||||
| } | ||||
| @@ -1,6 +1,6 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.impl; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaStreamHandler; | ||||
|  | ||||
| public class ConsoleOutputStreamHandler implements OllamaStreamHandler { | ||||
|     private final StringBuffer response = new StringBuffer(); | ||||
|   | ||||
| @@ -1,5 +1,8 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models; | ||||
|  | ||||
| import java.time.LocalDateTime; | ||||
| import java.time.OffsetDateTime; | ||||
|  | ||||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| @@ -11,7 +14,9 @@ public class Model { | ||||
|   private String name; | ||||
|   private String model; | ||||
|   @JsonProperty("modified_at") | ||||
|   private String modifiedAt; | ||||
|   private OffsetDateTime modifiedAt; | ||||
|   @JsonProperty("expires_at") | ||||
|   private OffsetDateTime expiresAt; | ||||
|   private String digest; | ||||
|   private long size; | ||||
|   @JsonProperty("details") | ||||
|   | ||||
| @@ -1,143 +0,0 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateResponseModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import java.io.BufferedReader; | ||||
| import java.io.IOException; | ||||
| import java.io.InputStream; | ||||
| import java.io.InputStreamReader; | ||||
| import java.net.http.HttpClient; | ||||
| import java.net.http.HttpRequest; | ||||
| import java.net.http.HttpResponse; | ||||
| 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 HttpRequest.Builder requestBuilder; | ||||
|   private final OllamaGenerateRequestModel ollamaRequestModel; | ||||
|   private final Queue<String> queue = new LinkedList<>(); | ||||
|   private String result; | ||||
|   private boolean isDone; | ||||
|  | ||||
|   /** | ||||
|    * -- 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; | ||||
|  | ||||
|   /** | ||||
|    * -- 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( | ||||
|       HttpRequest.Builder requestBuilder, | ||||
|       OllamaGenerateRequestModel ollamaRequestModel, | ||||
|       long requestTimeoutSeconds) { | ||||
|     this.requestBuilder = requestBuilder; | ||||
|     this.ollamaRequestModel = ollamaRequestModel; | ||||
|     this.isDone = false; | ||||
|     this.result = ""; | ||||
|     this.queue.add(""); | ||||
|     this.requestTimeoutSeconds = requestTimeoutSeconds; | ||||
|   } | ||||
|  | ||||
|   @Override | ||||
|   public void run() { | ||||
|     HttpClient httpClient = HttpClient.newHttpClient(); | ||||
|     try { | ||||
|       long startTime = System.currentTimeMillis(); | ||||
|       HttpRequest request = | ||||
|           requestBuilder | ||||
|               .POST( | ||||
|                   HttpRequest.BodyPublishers.ofString( | ||||
|                       Utils.getObjectMapper().writeValueAsString(ollamaRequestModel))) | ||||
|               .header("Content-Type", "application/json") | ||||
|               .timeout(Duration.ofSeconds(requestTimeoutSeconds)) | ||||
|               .build(); | ||||
|       HttpResponse<InputStream> response = | ||||
|           httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream()); | ||||
|       int statusCode = response.statusCode(); | ||||
|       this.httpStatusCode = statusCode; | ||||
|  | ||||
|       InputStream responseBodyStream = response.body(); | ||||
|       try (BufferedReader reader = | ||||
|           new BufferedReader(new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) { | ||||
|         String line; | ||||
|         StringBuilder responseBuffer = new StringBuilder(); | ||||
|         while ((line = reader.readLine()) != null) { | ||||
|           if (statusCode == 404) { | ||||
|             OllamaErrorResponseModel ollamaResponseModel = | ||||
|                 Utils.getObjectMapper().readValue(line, OllamaErrorResponseModel.class); | ||||
|             queue.add(ollamaResponseModel.getError()); | ||||
|             responseBuffer.append(ollamaResponseModel.getError()); | ||||
|           } else { | ||||
|             OllamaGenerateResponseModel ollamaResponseModel = | ||||
|                 Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class); | ||||
|             queue.add(ollamaResponseModel.getResponse()); | ||||
|             if (!ollamaResponseModel.isDone()) { | ||||
|               responseBuffer.append(ollamaResponseModel.getResponse()); | ||||
|             } | ||||
|           } | ||||
|         } | ||||
|  | ||||
|         this.isDone = true; | ||||
|         this.succeeded = true; | ||||
|         this.result = responseBuffer.toString(); | ||||
|         long endTime = System.currentTimeMillis(); | ||||
|         responseTime = endTime - startTime; | ||||
|       } | ||||
|       if (statusCode != 200) { | ||||
|         throw new OllamaBaseException(this.result); | ||||
|       } | ||||
|     } catch (IOException | InterruptedException | OllamaBaseException e) { | ||||
|       this.isDone = true; | ||||
|       this.succeeded = false; | ||||
|       this.result = "[FAILED] " + e.getMessage(); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   /** | ||||
|    * Returns the status of the thread. This does not indicate that the request was successful or a | ||||
|    * failure, rather it is just a status flag to indicate if the thread is active or ended. | ||||
|    * | ||||
|    * @return boolean - status | ||||
|    */ | ||||
|   public boolean isComplete() { | ||||
|     return isDone; | ||||
|   } | ||||
|  | ||||
|   /** | ||||
|    * Returns the final completion/response when the execution completes. Does not return intermediate results. | ||||
|    * | ||||
|    * @return String completion/response text | ||||
|    */ | ||||
|   public String getResponse() { | ||||
|     return result; | ||||
|   } | ||||
|  | ||||
|   public Queue<String> getStream() { | ||||
|     return queue; | ||||
|   } | ||||
|  | ||||
|   public void setRequestTimeoutSeconds(long requestTimeoutSeconds) { | ||||
|     this.requestTimeoutSeconds = requestTimeoutSeconds; | ||||
|   } | ||||
| } | ||||
| @@ -0,0 +1,124 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaResultStream; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateResponseModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import lombok.Data; | ||||
| import lombok.EqualsAndHashCode; | ||||
| import lombok.Getter; | ||||
| import lombok.Setter; | ||||
|  | ||||
| import java.io.BufferedReader; | ||||
| import java.io.IOException; | ||||
| import java.io.InputStream; | ||||
| import java.io.InputStreamReader; | ||||
| import java.net.http.HttpClient; | ||||
| import java.net.http.HttpRequest; | ||||
| import java.net.http.HttpResponse; | ||||
| import java.nio.charset.StandardCharsets; | ||||
| import java.time.Duration; | ||||
|  | ||||
| @Data | ||||
| @EqualsAndHashCode(callSuper = true) | ||||
| @SuppressWarnings("unused") | ||||
| public class OllamaAsyncResultStreamer extends Thread { | ||||
|     private final HttpRequest.Builder requestBuilder; | ||||
|     private final OllamaGenerateRequestModel ollamaRequestModel; | ||||
|     private final OllamaResultStream stream = new OllamaResultStream(); | ||||
|     private String completeResponse; | ||||
|  | ||||
|  | ||||
|     /** | ||||
|      * -- 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; | ||||
|  | ||||
|     @Setter | ||||
|     private long requestTimeoutSeconds; | ||||
|  | ||||
|     /** | ||||
|      * -- 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 OllamaAsyncResultStreamer( | ||||
|             HttpRequest.Builder requestBuilder, | ||||
|             OllamaGenerateRequestModel ollamaRequestModel, | ||||
|             long requestTimeoutSeconds) { | ||||
|         this.requestBuilder = requestBuilder; | ||||
|         this.ollamaRequestModel = ollamaRequestModel; | ||||
|         this.completeResponse = ""; | ||||
|         this.stream.add(""); | ||||
|         this.requestTimeoutSeconds = requestTimeoutSeconds; | ||||
|     } | ||||
|  | ||||
|     @Override | ||||
|     public void run() { | ||||
|         ollamaRequestModel.setStream(true); | ||||
|         HttpClient httpClient = HttpClient.newHttpClient(); | ||||
|         try { | ||||
|             long startTime = System.currentTimeMillis(); | ||||
|             HttpRequest request = | ||||
|                     requestBuilder | ||||
|                             .POST( | ||||
|                                     HttpRequest.BodyPublishers.ofString( | ||||
|                                             Utils.getObjectMapper().writeValueAsString(ollamaRequestModel))) | ||||
|                             .header("Content-Type", "application/json") | ||||
|                             .timeout(Duration.ofSeconds(requestTimeoutSeconds)) | ||||
|                             .build(); | ||||
|             HttpResponse<InputStream> response = | ||||
|                     httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream()); | ||||
|             int statusCode = response.statusCode(); | ||||
|             this.httpStatusCode = statusCode; | ||||
|  | ||||
|             InputStream responseBodyStream = response.body(); | ||||
|             try (BufferedReader reader = | ||||
|                          new BufferedReader(new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) { | ||||
|                 String line; | ||||
|                 StringBuilder responseBuffer = new StringBuilder(); | ||||
|                 while ((line = reader.readLine()) != null) { | ||||
|                     if (statusCode == 404) { | ||||
|                         OllamaErrorResponseModel ollamaResponseModel = | ||||
|                                 Utils.getObjectMapper().readValue(line, OllamaErrorResponseModel.class); | ||||
|                         stream.add(ollamaResponseModel.getError()); | ||||
|                         responseBuffer.append(ollamaResponseModel.getError()); | ||||
|                     } else { | ||||
|                         OllamaGenerateResponseModel ollamaResponseModel = | ||||
|                                 Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class); | ||||
|                         String res = ollamaResponseModel.getResponse(); | ||||
|                         stream.add(res); | ||||
|                         if (!ollamaResponseModel.isDone()) { | ||||
|                             responseBuffer.append(res); | ||||
|                         } | ||||
|                     } | ||||
|                 } | ||||
|  | ||||
|                 this.succeeded = true; | ||||
|                 this.completeResponse = responseBuffer.toString(); | ||||
|                 long endTime = System.currentTimeMillis(); | ||||
|                 responseTime = endTime - startTime; | ||||
|             } | ||||
|             if (statusCode != 200) { | ||||
|                 throw new OllamaBaseException(this.completeResponse); | ||||
|             } | ||||
|         } catch (IOException | InterruptedException | OllamaBaseException e) { | ||||
|             this.succeeded = false; | ||||
|             this.completeResponse = "[FAILED] " + e.getMessage(); | ||||
|         } | ||||
|     } | ||||
|  | ||||
| } | ||||
|  | ||||
| @@ -1,10 +1,10 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models.chat; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaStreamHandler; | ||||
|  | ||||
| import java.util.ArrayList; | ||||
| import java.util.List; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler; | ||||
|  | ||||
| public class OllamaChatStreamObserver { | ||||
|  | ||||
|     private OllamaStreamHandler streamHandler; | ||||
| @@ -17,12 +17,12 @@ public class OllamaChatStreamObserver { | ||||
|         this.streamHandler = streamHandler; | ||||
|     } | ||||
|  | ||||
|     public void notify(OllamaChatResponseModel currentResponsePart){ | ||||
|     public void notify(OllamaChatResponseModel currentResponsePart) { | ||||
|         responseParts.add(currentResponsePart); | ||||
|         handleCurrentResponsePart(currentResponsePart); | ||||
|     } | ||||
|  | ||||
|     protected void handleCurrentResponsePart(OllamaChatResponseModel currentResponsePart){ | ||||
|     protected void handleCurrentResponsePart(OllamaChatResponseModel currentResponsePart) { | ||||
|         message = message + currentResponsePart.getMessage().getContent(); | ||||
|         streamHandler.accept(message); | ||||
|     } | ||||
|   | ||||
| @@ -3,8 +3,6 @@ package io.github.amithkoujalgi.ollama4j.core.models.generate; | ||||
| import java.util.ArrayList; | ||||
| import java.util.List; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler; | ||||
|  | ||||
| public class OllamaGenerateStreamObserver { | ||||
|  | ||||
|     private OllamaStreamHandler streamHandler; | ||||
| @@ -17,12 +15,12 @@ public class OllamaGenerateStreamObserver { | ||||
|         this.streamHandler = streamHandler; | ||||
|     } | ||||
|  | ||||
|     public void notify(OllamaGenerateResponseModel currentResponsePart){ | ||||
|     public void notify(OllamaGenerateResponseModel currentResponsePart) { | ||||
|         responseParts.add(currentResponsePart); | ||||
|         handleCurrentResponsePart(currentResponsePart); | ||||
|     } | ||||
|  | ||||
|     protected void handleCurrentResponsePart(OllamaGenerateResponseModel currentResponsePart){ | ||||
|     protected void handleCurrentResponsePart(OllamaGenerateResponseModel currentResponsePart) { | ||||
|         message = message + currentResponsePart.getResponse(); | ||||
|         streamHandler.accept(message); | ||||
|     } | ||||
|   | ||||
| @@ -0,0 +1,7 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models.generate; | ||||
|  | ||||
| import java.util.function.Consumer; | ||||
|  | ||||
| public interface OllamaStreamHandler extends Consumer<String> { | ||||
|     void accept(String message); | ||||
| } | ||||
| @@ -1,12 +1,12 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models.request; | ||||
|  | ||||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResponseModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatStreamObserver; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import org.slf4j.Logger; | ||||
|   | ||||
| @@ -1,20 +1,20 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.models.request; | ||||
|  | ||||
| import java.io.IOException; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.BasicAuth; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateResponseModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateStreamObserver; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaStreamHandler; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OllamaRequestBody; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| public class OllamaGenerateEndpointCaller extends OllamaEndpointCaller{ | ||||
| import java.io.IOException; | ||||
|  | ||||
| public class OllamaGenerateEndpointCaller extends OllamaEndpointCaller { | ||||
|  | ||||
|     private static final Logger LOG = LoggerFactory.getLogger(OllamaGenerateEndpointCaller.class); | ||||
|  | ||||
| @@ -31,24 +31,22 @@ public class OllamaGenerateEndpointCaller extends OllamaEndpointCaller{ | ||||
|  | ||||
|     @Override | ||||
|     protected boolean parseResponseAndAddToBuffer(String line, StringBuilder responseBuffer) { | ||||
|                 try { | ||||
|                     OllamaGenerateResponseModel ollamaResponseModel = Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class); | ||||
|                     responseBuffer.append(ollamaResponseModel.getResponse()); | ||||
|                     if(streamObserver != null) { | ||||
|                         streamObserver.notify(ollamaResponseModel); | ||||
|                     } | ||||
|                     return ollamaResponseModel.isDone(); | ||||
|                 } catch (JsonProcessingException e) { | ||||
|                     LOG.error("Error parsing the Ollama chat response!",e); | ||||
|                     return true; | ||||
|                 }          | ||||
|         try { | ||||
|             OllamaGenerateResponseModel ollamaResponseModel = Utils.getObjectMapper().readValue(line, OllamaGenerateResponseModel.class); | ||||
|             responseBuffer.append(ollamaResponseModel.getResponse()); | ||||
|             if (streamObserver != null) { | ||||
|                 streamObserver.notify(ollamaResponseModel); | ||||
|             } | ||||
|             return ollamaResponseModel.isDone(); | ||||
|         } catch (JsonProcessingException e) { | ||||
|             LOG.error("Error parsing the Ollama chat response!", e); | ||||
|             return true; | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     public OllamaResult call(OllamaRequestBody body, OllamaStreamHandler streamHandler) | ||||
|         throws OllamaBaseException, IOException, InterruptedException { | ||||
|     streamObserver = new OllamaGenerateStreamObserver(streamHandler); | ||||
|     return super.callSync(body); | ||||
|             throws OllamaBaseException, IOException, InterruptedException { | ||||
|         streamObserver = new OllamaGenerateStreamObserver(streamHandler); | ||||
|         return super.callSync(body); | ||||
|     } | ||||
|      | ||||
|      | ||||
| } | ||||
|   | ||||
| @@ -0,0 +1,35 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.tools; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult; | ||||
| import lombok.AllArgsConstructor; | ||||
| import lombok.Data; | ||||
| import lombok.NoArgsConstructor; | ||||
|  | ||||
| import java.util.ArrayList; | ||||
| import java.util.List; | ||||
| import java.util.Map; | ||||
|  | ||||
| @Data | ||||
| @NoArgsConstructor | ||||
| @AllArgsConstructor | ||||
| public class OllamaToolsResult { | ||||
|     private OllamaResult modelResult; | ||||
|     private Map<ToolFunctionCallSpec, Object> toolResults; | ||||
|  | ||||
|     public List<ToolResult> getToolResults() { | ||||
|         List<ToolResult> results = new ArrayList<>(); | ||||
|         for (Map.Entry<ToolFunctionCallSpec, Object> r : this.toolResults.entrySet()) { | ||||
|             results.add(new ToolResult(r.getKey().getName(), r.getKey().getArguments(), r.getValue())); | ||||
|         } | ||||
|         return results; | ||||
|     } | ||||
|  | ||||
|     @Data | ||||
|     @NoArgsConstructor | ||||
|     @AllArgsConstructor | ||||
|     public static class ToolResult { | ||||
|         private String functionName; | ||||
|         private Map<String, Object> functionArguments; | ||||
|         private Object result; | ||||
|     } | ||||
| } | ||||
| @@ -0,0 +1,8 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.tools; | ||||
|  | ||||
| import java.util.Map; | ||||
|  | ||||
| @FunctionalInterface | ||||
| public interface ToolFunction { | ||||
|     Object apply(Map<String, Object> arguments); | ||||
| } | ||||
| @@ -0,0 +1,16 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.tools; | ||||
|  | ||||
| import lombok.AllArgsConstructor; | ||||
| import lombok.Data; | ||||
| import lombok.NoArgsConstructor; | ||||
|  | ||||
| import java.util.Map; | ||||
|  | ||||
| @Data | ||||
| @AllArgsConstructor | ||||
| @NoArgsConstructor | ||||
| public class ToolFunctionCallSpec { | ||||
|     private String name; | ||||
|     private Map<String, Object> arguments; | ||||
| } | ||||
|  | ||||
| @@ -0,0 +1,16 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.tools; | ||||
|  | ||||
| import java.util.HashMap; | ||||
| import java.util.Map; | ||||
|  | ||||
| public class ToolRegistry { | ||||
|     private final Map<String, ToolFunction> functionMap = new HashMap<>(); | ||||
|  | ||||
|     public ToolFunction getFunction(String name) { | ||||
|         return functionMap.get(name); | ||||
|     } | ||||
|  | ||||
|     public void addFunction(String name, ToolFunction function) { | ||||
|         functionMap.put(name, function); | ||||
|     } | ||||
| } | ||||
| @@ -0,0 +1,113 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.core.tools; | ||||
|  | ||||
| import com.fasterxml.jackson.annotation.JsonIgnore; | ||||
| import com.fasterxml.jackson.annotation.JsonIgnoreProperties; | ||||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| import lombok.Builder; | ||||
| import lombok.Data; | ||||
|  | ||||
| import java.util.ArrayList; | ||||
| import java.util.HashMap; | ||||
| import java.util.List; | ||||
| import java.util.Map; | ||||
|  | ||||
| public class Tools { | ||||
|     @Data | ||||
|     @Builder | ||||
|     public static class ToolSpecification { | ||||
|         private String functionName; | ||||
|         private String functionDescription; | ||||
|         private Map<String, PromptFuncDefinition.Property> properties; | ||||
|         private ToolFunction toolDefinition; | ||||
|     } | ||||
|  | ||||
|     @Data | ||||
|     @JsonIgnoreProperties(ignoreUnknown = true) | ||||
|     public static class PromptFuncDefinition { | ||||
|         private String type; | ||||
|         private PromptFuncSpec function; | ||||
|  | ||||
|         @Data | ||||
|         public static class PromptFuncSpec { | ||||
|             private String name; | ||||
|             private String description; | ||||
|             private Parameters parameters; | ||||
|         } | ||||
|  | ||||
|         @Data | ||||
|         public static class Parameters { | ||||
|             private String type; | ||||
|             private Map<String, Property> properties; | ||||
|             private List<String> required; | ||||
|         } | ||||
|  | ||||
|         @Data | ||||
|         @Builder | ||||
|         public static class Property { | ||||
|             private String type; | ||||
|             private String description; | ||||
|             @JsonProperty("enum") | ||||
|             @JsonInclude(JsonInclude.Include.NON_NULL) | ||||
|             private List<String> enumValues; | ||||
|             @JsonIgnore | ||||
|             private boolean required; | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     public static class PropsBuilder { | ||||
|         private final Map<String, PromptFuncDefinition.Property> props = new HashMap<>(); | ||||
|  | ||||
|         public PropsBuilder withProperty(String key, PromptFuncDefinition.Property property) { | ||||
|             props.put(key, property); | ||||
|             return this; | ||||
|         } | ||||
|  | ||||
|         public Map<String, PromptFuncDefinition.Property> build() { | ||||
|             return props; | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     public static class PromptBuilder { | ||||
|         private final List<PromptFuncDefinition> tools = new ArrayList<>(); | ||||
|  | ||||
|         private String promptText; | ||||
|  | ||||
|         public String build() throws JsonProcessingException { | ||||
|             return "[AVAILABLE_TOOLS] " + Utils.getObjectMapper().writeValueAsString(tools) + "[/AVAILABLE_TOOLS][INST] " + promptText + " [/INST]"; | ||||
|         } | ||||
|  | ||||
|         public PromptBuilder withPrompt(String prompt) throws JsonProcessingException { | ||||
|             promptText = prompt; | ||||
|             return this; | ||||
|         } | ||||
|  | ||||
|         public PromptBuilder withToolSpecification(ToolSpecification spec) { | ||||
|             PromptFuncDefinition def = new PromptFuncDefinition(); | ||||
|             def.setType("function"); | ||||
|  | ||||
|             PromptFuncDefinition.PromptFuncSpec functionDetail = new PromptFuncDefinition.PromptFuncSpec(); | ||||
|             functionDetail.setName(spec.getFunctionName()); | ||||
|             functionDetail.setDescription(spec.getFunctionDescription()); | ||||
|  | ||||
|             PromptFuncDefinition.Parameters parameters = new PromptFuncDefinition.Parameters(); | ||||
|             parameters.setType("object"); | ||||
|             parameters.setProperties(spec.getProperties()); | ||||
|  | ||||
|             List<String> requiredValues = new ArrayList<>(); | ||||
|             for (Map.Entry<String, PromptFuncDefinition.Property> p : spec.getProperties().entrySet()) { | ||||
|                 if (p.getValue().isRequired()) { | ||||
|                     requiredValues.add(p.getKey()); | ||||
|                 } | ||||
|             } | ||||
|             parameters.setRequired(requiredValues); | ||||
|             functionDetail.setParameters(parameters); | ||||
|             def.setFunction(functionDetail); | ||||
|  | ||||
|             tools.add(def); | ||||
|             return this; | ||||
|         } | ||||
|     } | ||||
| } | ||||
| @@ -9,6 +9,9 @@ package io.github.amithkoujalgi.ollama4j.core.types; | ||||
| @SuppressWarnings("ALL") | ||||
| public class OllamaModelType { | ||||
|     public static final String GEMMA = "gemma"; | ||||
|     public static final String GEMMA2 = "gemma2"; | ||||
|  | ||||
|  | ||||
|     public static final String LLAMA2 = "llama2"; | ||||
|     public static final String LLAMA3 = "llama3"; | ||||
|     public static final String MISTRAL = "mistral"; | ||||
| @@ -30,6 +33,8 @@ public class OllamaModelType { | ||||
|     public static final String ZEPHYR = "zephyr"; | ||||
|     public static final String OPENHERMES = "openhermes"; | ||||
|     public static final String QWEN = "qwen"; | ||||
|  | ||||
|     public static final String QWEN2 = "qwen2"; | ||||
|     public static final String WIZARDCODER = "wizardcoder"; | ||||
|     public static final String LLAMA2_CHINESE = "llama2-chinese"; | ||||
|     public static final String TINYLLAMA = "tinyllama"; | ||||
| @@ -79,4 +84,5 @@ public class OllamaModelType { | ||||
|     public static final String NOTUS = "notus"; | ||||
|     public static final String DUCKDB_NSQL = "duckdb-nsql"; | ||||
|     public static final String ALL_MINILM = "all-minilm"; | ||||
|     public static final String CODESTRAL = "codestral"; | ||||
| } | ||||
|   | ||||
| @@ -8,10 +8,18 @@ import java.net.URISyntaxException; | ||||
| import java.net.URL; | ||||
|  | ||||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||||
| import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; | ||||
|  | ||||
| public class Utils { | ||||
|  | ||||
|   private static ObjectMapper objectMapper; | ||||
|  | ||||
|   public static ObjectMapper getObjectMapper() { | ||||
|     return new ObjectMapper(); | ||||
|     if(objectMapper == null) { | ||||
|       objectMapper = new ObjectMapper(); | ||||
|       objectMapper.registerModule(new JavaTimeModule()); | ||||
|     } | ||||
|     return objectMapper; | ||||
|   } | ||||
|  | ||||
|   public static byte[] loadImageBytesFromUrl(String imageUrl) | ||||
|   | ||||
| @@ -1,7 +1,5 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.integrationtests; | ||||
|  | ||||
| import static org.junit.jupiter.api.Assertions.*; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaAPI; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail; | ||||
| @@ -10,9 +8,16 @@ import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatMessageRole; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilder; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestBuilder; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
| import lombok.Data; | ||||
| import org.junit.jupiter.api.BeforeEach; | ||||
| import org.junit.jupiter.api.Order; | ||||
| import org.junit.jupiter.api.Test; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| import java.io.File; | ||||
| import java.io.IOException; | ||||
| import java.io.InputStream; | ||||
| @@ -22,372 +27,369 @@ import java.net.http.HttpConnectTimeoutException; | ||||
| import java.util.List; | ||||
| import java.util.Objects; | ||||
| import java.util.Properties; | ||||
| import lombok.Data; | ||||
| import org.junit.jupiter.api.BeforeEach; | ||||
| import org.junit.jupiter.api.Order; | ||||
| import org.junit.jupiter.api.Test; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| import static org.junit.jupiter.api.Assertions.*; | ||||
|  | ||||
| class TestRealAPIs { | ||||
|  | ||||
|   private static final Logger LOG = LoggerFactory.getLogger(TestRealAPIs.class); | ||||
|     private static final Logger LOG = LoggerFactory.getLogger(TestRealAPIs.class); | ||||
|  | ||||
|   OllamaAPI ollamaAPI; | ||||
|   Config config; | ||||
|     OllamaAPI ollamaAPI; | ||||
|     Config config; | ||||
|  | ||||
|   private File getImageFileFromClasspath(String fileName) { | ||||
|     ClassLoader classLoader = getClass().getClassLoader(); | ||||
|     return new File(Objects.requireNonNull(classLoader.getResource(fileName)).getFile()); | ||||
|   } | ||||
|  | ||||
|   @BeforeEach | ||||
|   void setUp() { | ||||
|     config = new Config(); | ||||
|     ollamaAPI = new OllamaAPI(config.getOllamaURL()); | ||||
|     ollamaAPI.setRequestTimeoutSeconds(config.getRequestTimeoutSeconds()); | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(1) | ||||
|   void testWrongEndpoint() { | ||||
|     OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434"); | ||||
|     assertThrows(ConnectException.class, ollamaAPI::listModels); | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(1) | ||||
|   void testEndpointReachability() { | ||||
|     try { | ||||
|       assertNotNull(ollamaAPI.listModels()); | ||||
|     } catch (HttpConnectTimeoutException e) { | ||||
|       fail(e.getMessage()); | ||||
|     } catch (Exception e) { | ||||
|       fail(e); | ||||
|     private File getImageFileFromClasspath(String fileName) { | ||||
|         ClassLoader classLoader = getClass().getClassLoader(); | ||||
|         return new File(Objects.requireNonNull(classLoader.getResource(fileName)).getFile()); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(2) | ||||
|   void testListModels() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       assertNotNull(ollamaAPI.listModels()); | ||||
|       ollamaAPI.listModels().forEach(System.out::println); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       fail(e); | ||||
|     @BeforeEach | ||||
|     void setUp() { | ||||
|         config = new Config(); | ||||
|         ollamaAPI = new OllamaAPI(config.getOllamaURL()); | ||||
|         ollamaAPI.setRequestTimeoutSeconds(config.getRequestTimeoutSeconds()); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(2) | ||||
|   void testPullModel() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       ollamaAPI.pullModel(config.getModel()); | ||||
|       boolean found = | ||||
|           ollamaAPI.listModels().stream() | ||||
|               .anyMatch(model -> model.getModel().equalsIgnoreCase(config.getModel())); | ||||
|       assertTrue(found); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(1) | ||||
|     void testWrongEndpoint() { | ||||
|         OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434"); | ||||
|         assertThrows(ConnectException.class, ollamaAPI::listModels); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testListDtails() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       ModelDetail modelDetails = ollamaAPI.getModelDetails(config.getModel()); | ||||
|       assertNotNull(modelDetails); | ||||
|       System.out.println(modelDetails); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(1) | ||||
|     void testEndpointReachability() { | ||||
|         try { | ||||
|             assertNotNull(ollamaAPI.listModels()); | ||||
|         } catch (HttpConnectTimeoutException e) { | ||||
|             fail(e.getMessage()); | ||||
|         } catch (Exception e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithDefaultOptions() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaResult result = | ||||
|           ollamaAPI.generate( | ||||
|               config.getModel(), | ||||
|               "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|               new OptionsBuilder().build()); | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(2) | ||||
|     void testListModels() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             assertNotNull(ollamaAPI.listModels()); | ||||
|             ollamaAPI.listModels().forEach(System.out::println); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithDefaultOptionsStreamed() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|  | ||||
|       StringBuffer sb = new StringBuffer(""); | ||||
|  | ||||
|       OllamaResult result = ollamaAPI.generate(config.getModel(), | ||||
|           "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|           new OptionsBuilder().build(), (s) -> { | ||||
|             LOG.info(s); | ||||
|             String substring = s.substring(sb.toString().length(), s.length()); | ||||
|             LOG.info(substring); | ||||
|             sb.append(substring); | ||||
|           }); | ||||
|  | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|       assertEquals(sb.toString().trim(), result.getResponse().trim()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(2) | ||||
|     void testPullModel() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             ollamaAPI.pullModel(config.getModel()); | ||||
|             boolean found = | ||||
|                     ollamaAPI.listModels().stream() | ||||
|                             .anyMatch(model -> model.getModel().equalsIgnoreCase(config.getModel())); | ||||
|             assertTrue(found); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithOptions() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaResult result = | ||||
|           ollamaAPI.generate( | ||||
|               config.getModel(), | ||||
|               "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|               new OptionsBuilder().setTemperature(0.9f).build()); | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testListDtails() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             ModelDetail modelDetails = ollamaAPI.getModelDetails(config.getModel()); | ||||
|             assertNotNull(modelDetails); | ||||
|             System.out.println(modelDetails); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testChat() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|       OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What is the capital of France?") | ||||
|              .withMessage(OllamaChatMessageRole.ASSISTANT, "Should be Paris!") | ||||
|              .withMessage(OllamaChatMessageRole.USER,"And what is the second larges city?") | ||||
|              .build(); | ||||
|  | ||||
|       OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|       assertNotNull(chatResult); | ||||
|       assertFalse(chatResult.getResponse().isBlank()); | ||||
|       assertEquals(4,chatResult.getChatHistory().size()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithDefaultOptions() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaResult result = | ||||
|                     ollamaAPI.generate( | ||||
|                             config.getModel(), | ||||
|                             "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|                             false, | ||||
|                             new OptionsBuilder().build()); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testChatWithSystemPrompt() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|       OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.SYSTEM, | ||||
|           "You are a silent bot that only says 'NI'. Do not say anything else under any circumstances!") | ||||
|           .withMessage(OllamaChatMessageRole.USER, | ||||
|               "What is the capital of France? And what's France's connection with Mona Lisa?") | ||||
|           .build(); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithDefaultOptionsStreamed() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             StringBuffer sb = new StringBuffer(""); | ||||
|             OllamaResult result = ollamaAPI.generate(config.getModel(), | ||||
|                     "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|                     false, | ||||
|                     new OptionsBuilder().build(), (s) -> { | ||||
|                         LOG.info(s); | ||||
|                         String substring = s.substring(sb.toString().length(), s.length()); | ||||
|                         LOG.info(substring); | ||||
|                         sb.append(substring); | ||||
|                     }); | ||||
|  | ||||
|       OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|       assertNotNull(chatResult); | ||||
|       assertFalse(chatResult.getResponse().isBlank()); | ||||
|       assertTrue(chatResult.getResponse().startsWith("NI")); | ||||
|       assertEquals(3, chatResult.getChatHistory().size()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|             assertEquals(sb.toString().trim(), result.getResponse().trim()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testChatWithStream() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|       OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, | ||||
|               "What is the capital of France? And what's France's connection with Mona Lisa?") | ||||
|           .build(); | ||||
|  | ||||
|       StringBuffer sb = new StringBuffer(""); | ||||
|  | ||||
|       OllamaChatResult chatResult = ollamaAPI.chat(requestModel,(s) -> { | ||||
|         LOG.info(s); | ||||
|         String substring = s.substring(sb.toString().length(), s.length()); | ||||
|         LOG.info(substring); | ||||
|         sb.append(substring); | ||||
|       }); | ||||
|       assertNotNull(chatResult); | ||||
|       assertEquals(sb.toString().trim(), chatResult.getResponse().trim()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithOptions() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaResult result = | ||||
|                     ollamaAPI.generate( | ||||
|                             config.getModel(), | ||||
|                             "What is the capital of France? And what's France's connection with Mona Lisa?", | ||||
|                             true, | ||||
|                             new OptionsBuilder().setTemperature(0.9f).build()); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testChatWithImageFromFileWithHistoryRecognition() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaChatRequestBuilder builder = | ||||
|           OllamaChatRequestBuilder.getInstance(config.getImageModel()); | ||||
|       OllamaChatRequestModel requestModel = | ||||
|           builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?", | ||||
|               List.of(getImageFileFromClasspath("dog-on-a-boat.jpg"))).build(); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testChat() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|             OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What is the capital of France?") | ||||
|                     .withMessage(OllamaChatMessageRole.ASSISTANT, "Should be Paris!") | ||||
|                     .withMessage(OllamaChatMessageRole.USER, "And what is the second larges city?") | ||||
|                     .build(); | ||||
|  | ||||
|       OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|       assertNotNull(chatResult); | ||||
|       assertNotNull(chatResult.getResponse()); | ||||
|  | ||||
|       builder.reset(); | ||||
|  | ||||
|       requestModel = | ||||
|           builder.withMessages(chatResult.getChatHistory()) | ||||
|             .withMessage(OllamaChatMessageRole.USER, "What's the dogs breed?").build(); | ||||
|  | ||||
|       chatResult = ollamaAPI.chat(requestModel); | ||||
|       assertNotNull(chatResult); | ||||
|       assertNotNull(chatResult.getResponse()); | ||||
|  | ||||
|  | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|             OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|             assertNotNull(chatResult); | ||||
|             assertFalse(chatResult.getResponse().isBlank()); | ||||
|             assertEquals(4, chatResult.getChatHistory().size()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testChatWithImageFromURL() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getImageModel()); | ||||
|       OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?", | ||||
|       "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg") | ||||
|              .build(); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testChatWithSystemPrompt() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|             OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.SYSTEM, | ||||
|                             "You are a silent bot that only says 'NI'. Do not say anything else under any circumstances!") | ||||
|                     .withMessage(OllamaChatMessageRole.USER, | ||||
|                             "What is the capital of France? And what's France's connection with Mona Lisa?") | ||||
|                     .build(); | ||||
|  | ||||
|       OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|       assertNotNull(chatResult); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|             OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|             assertNotNull(chatResult); | ||||
|             assertFalse(chatResult.getResponse().isBlank()); | ||||
|             assertTrue(chatResult.getResponse().startsWith("NI")); | ||||
|             assertEquals(3, chatResult.getChatHistory().size()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithOptionsAndImageFiles() { | ||||
|     testEndpointReachability(); | ||||
|     File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg"); | ||||
|     try { | ||||
|       OllamaResult result = | ||||
|           ollamaAPI.generateWithImageFiles( | ||||
|               config.getImageModel(), | ||||
|               "What is in this image?", | ||||
|               List.of(imageFile), | ||||
|               new OptionsBuilder().build()); | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testChatWithStream() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getModel()); | ||||
|             OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, | ||||
|                             "What is the capital of France? And what's France's connection with Mona Lisa?") | ||||
|                     .build(); | ||||
|  | ||||
|             StringBuffer sb = new StringBuffer(""); | ||||
|  | ||||
|             OllamaChatResult chatResult = ollamaAPI.chat(requestModel, (s) -> { | ||||
|                 LOG.info(s); | ||||
|                 String substring = s.substring(sb.toString().length(), s.length()); | ||||
|                 LOG.info(substring); | ||||
|                 sb.append(substring); | ||||
|             }); | ||||
|             assertNotNull(chatResult); | ||||
|             assertEquals(sb.toString().trim(), chatResult.getResponse().trim()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithOptionsAndImageFilesStreamed() { | ||||
|     testEndpointReachability(); | ||||
|     File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg"); | ||||
|     try { | ||||
|       StringBuffer sb = new StringBuffer(""); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testChatWithImageFromFileWithHistoryRecognition() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaChatRequestBuilder builder = | ||||
|                     OllamaChatRequestBuilder.getInstance(config.getImageModel()); | ||||
|             OllamaChatRequestModel requestModel = | ||||
|                     builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?", | ||||
|                             List.of(getImageFileFromClasspath("dog-on-a-boat.jpg"))).build(); | ||||
|  | ||||
|       OllamaResult result = ollamaAPI.generateWithImageFiles(config.getImageModel(), | ||||
|           "What is in this image?", List.of(imageFile), new OptionsBuilder().build(), (s) -> { | ||||
|             LOG.info(s); | ||||
|             String substring = s.substring(sb.toString().length(), s.length()); | ||||
|             LOG.info(substring); | ||||
|             sb.append(substring); | ||||
|           }); | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|       assertEquals(sb.toString().trim(), result.getResponse().trim()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|             OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|             assertNotNull(chatResult); | ||||
|             assertNotNull(chatResult.getResponse()); | ||||
|  | ||||
|             builder.reset(); | ||||
|  | ||||
|             requestModel = | ||||
|                     builder.withMessages(chatResult.getChatHistory()) | ||||
|                             .withMessage(OllamaChatMessageRole.USER, "What's the dogs breed?").build(); | ||||
|  | ||||
|             chatResult = ollamaAPI.chat(requestModel); | ||||
|             assertNotNull(chatResult); | ||||
|             assertNotNull(chatResult.getResponse()); | ||||
|  | ||||
|  | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   void testAskModelWithOptionsAndImageURLs() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaResult result = | ||||
|           ollamaAPI.generateWithImageURLs( | ||||
|               config.getImageModel(), | ||||
|               "What is in this image?", | ||||
|               List.of( | ||||
|                   "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"), | ||||
|               new OptionsBuilder().build()); | ||||
|       assertNotNull(result); | ||||
|       assertNotNull(result.getResponse()); | ||||
|       assertFalse(result.getResponse().isEmpty()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testChatWithImageFromURL() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaChatRequestBuilder builder = OllamaChatRequestBuilder.getInstance(config.getImageModel()); | ||||
|             OllamaChatRequestModel requestModel = builder.withMessage(OllamaChatMessageRole.USER, "What's in the picture?", | ||||
|                             "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg") | ||||
|                     .build(); | ||||
|  | ||||
|             OllamaChatResult chatResult = ollamaAPI.chat(requestModel); | ||||
|             assertNotNull(chatResult); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   @Order(3) | ||||
|   public void testEmbedding() { | ||||
|     testEndpointReachability(); | ||||
|     try { | ||||
|       OllamaEmbeddingsRequestModel request = OllamaEmbeddingsRequestBuilder | ||||
|           .getInstance(config.getModel(), "What is the capital of France?").build(); | ||||
|  | ||||
|       List<Double> embeddings = ollamaAPI.generateEmbeddings(request); | ||||
|  | ||||
|       assertNotNull(embeddings); | ||||
|       assertFalse(embeddings.isEmpty()); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       fail(e); | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithOptionsAndImageFiles() { | ||||
|         testEndpointReachability(); | ||||
|         File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg"); | ||||
|         try { | ||||
|             OllamaResult result = | ||||
|                     ollamaAPI.generateWithImageFiles( | ||||
|                             config.getImageModel(), | ||||
|                             "What is in this image?", | ||||
|                             List.of(imageFile), | ||||
|                             new OptionsBuilder().build()); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithOptionsAndImageFilesStreamed() { | ||||
|         testEndpointReachability(); | ||||
|         File imageFile = getImageFileFromClasspath("dog-on-a-boat.jpg"); | ||||
|         try { | ||||
|             StringBuffer sb = new StringBuffer(""); | ||||
|  | ||||
|             OllamaResult result = ollamaAPI.generateWithImageFiles(config.getImageModel(), | ||||
|                     "What is in this image?", List.of(imageFile), new OptionsBuilder().build(), (s) -> { | ||||
|                         LOG.info(s); | ||||
|                         String substring = s.substring(sb.toString().length(), s.length()); | ||||
|                         LOG.info(substring); | ||||
|                         sb.append(substring); | ||||
|                     }); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|             assertEquals(sb.toString().trim(), result.getResponse().trim()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     void testAskModelWithOptionsAndImageURLs() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaResult result = | ||||
|                     ollamaAPI.generateWithImageURLs( | ||||
|                             config.getImageModel(), | ||||
|                             "What is in this image?", | ||||
|                             List.of( | ||||
|                                     "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"), | ||||
|                             new OptionsBuilder().build()); | ||||
|             assertNotNull(result); | ||||
|             assertNotNull(result.getResponse()); | ||||
|             assertFalse(result.getResponse().isEmpty()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     @Order(3) | ||||
|     public void testEmbedding() { | ||||
|         testEndpointReachability(); | ||||
|         try { | ||||
|             OllamaEmbeddingsRequestModel request = OllamaEmbeddingsRequestBuilder | ||||
|                     .getInstance(config.getModel(), "What is the capital of France?").build(); | ||||
|  | ||||
|             List<Double> embeddings = ollamaAPI.generateEmbeddings(request); | ||||
|  | ||||
|             assertNotNull(embeddings); | ||||
|             assertFalse(embeddings.isEmpty()); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             fail(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
| } | ||||
|  | ||||
| @Data | ||||
| class Config { | ||||
|   private String ollamaURL; | ||||
|   private String model; | ||||
|   private String imageModel; | ||||
|   private int requestTimeoutSeconds; | ||||
|     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); | ||||
|     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); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,163 +1,164 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.unittests; | ||||
|  | ||||
| import static org.mockito.Mockito.*; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.OllamaAPI; | ||||
| import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.ModelDetail; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaAsyncResultCallback; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaAsyncResultStreamer; | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.OllamaResult; | ||||
| import io.github.amithkoujalgi.ollama4j.core.types.OllamaModelType; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
| import org.junit.jupiter.api.Test; | ||||
| import org.mockito.Mockito; | ||||
|  | ||||
| import java.io.IOException; | ||||
| import java.net.URISyntaxException; | ||||
| import java.util.ArrayList; | ||||
| import java.util.Collections; | ||||
| import org.junit.jupiter.api.Test; | ||||
| import org.mockito.Mockito; | ||||
|  | ||||
| import static org.mockito.Mockito.*; | ||||
|  | ||||
| class TestMockedAPIs { | ||||
|   @Test | ||||
|   void testPullModel() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     try { | ||||
|       doNothing().when(ollamaAPI).pullModel(model); | ||||
|       ollamaAPI.pullModel(model); | ||||
|       verify(ollamaAPI, times(1)).pullModel(model); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testPullModel() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         try { | ||||
|             doNothing().when(ollamaAPI).pullModel(model); | ||||
|             ollamaAPI.pullModel(model); | ||||
|             verify(ollamaAPI, times(1)).pullModel(model); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testListModels() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     try { | ||||
|       when(ollamaAPI.listModels()).thenReturn(new ArrayList<>()); | ||||
|       ollamaAPI.listModels(); | ||||
|       verify(ollamaAPI, times(1)).listModels(); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testListModels() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         try { | ||||
|             when(ollamaAPI.listModels()).thenReturn(new ArrayList<>()); | ||||
|             ollamaAPI.listModels(); | ||||
|             verify(ollamaAPI, times(1)).listModels(); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testCreateModel() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     String modelFilePath = "FROM llama2\nSYSTEM You are mario from Super Mario Bros."; | ||||
|     try { | ||||
|       doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath); | ||||
|       ollamaAPI.createModelWithModelFileContents(model, modelFilePath); | ||||
|       verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testCreateModel() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         String modelFilePath = "FROM llama2\nSYSTEM You are mario from Super Mario Bros."; | ||||
|         try { | ||||
|             doNothing().when(ollamaAPI).createModelWithModelFileContents(model, modelFilePath); | ||||
|             ollamaAPI.createModelWithModelFileContents(model, modelFilePath); | ||||
|             verify(ollamaAPI, times(1)).createModelWithModelFileContents(model, modelFilePath); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testDeleteModel() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     try { | ||||
|       doNothing().when(ollamaAPI).deleteModel(model, true); | ||||
|       ollamaAPI.deleteModel(model, true); | ||||
|       verify(ollamaAPI, times(1)).deleteModel(model, true); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testDeleteModel() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         try { | ||||
|             doNothing().when(ollamaAPI).deleteModel(model, true); | ||||
|             ollamaAPI.deleteModel(model, true); | ||||
|             verify(ollamaAPI, times(1)).deleteModel(model, true); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testGetModelDetails() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     try { | ||||
|       when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail()); | ||||
|       ollamaAPI.getModelDetails(model); | ||||
|       verify(ollamaAPI, times(1)).getModelDetails(model); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testGetModelDetails() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         try { | ||||
|             when(ollamaAPI.getModelDetails(model)).thenReturn(new ModelDetail()); | ||||
|             ollamaAPI.getModelDetails(model); | ||||
|             verify(ollamaAPI, times(1)).getModelDetails(model); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException | URISyntaxException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testGenerateEmbeddings() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     String prompt = "some prompt text"; | ||||
|     try { | ||||
|       when(ollamaAPI.generateEmbeddings(model, prompt)).thenReturn(new ArrayList<>()); | ||||
|       ollamaAPI.generateEmbeddings(model, prompt); | ||||
|       verify(ollamaAPI, times(1)).generateEmbeddings(model, prompt); | ||||
|     } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|       throw new RuntimeException(e); | ||||
|     @Test | ||||
|     void testGenerateEmbeddings() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         String prompt = "some prompt text"; | ||||
|         try { | ||||
|             when(ollamaAPI.generateEmbeddings(model, prompt)).thenReturn(new ArrayList<>()); | ||||
|             ollamaAPI.generateEmbeddings(model, prompt); | ||||
|             verify(ollamaAPI, times(1)).generateEmbeddings(model, prompt); | ||||
|         } catch (IOException | OllamaBaseException | InterruptedException e) { | ||||
|             throw new RuntimeException(e); | ||||
|         } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   @Test | ||||
|   void testAsk() { | ||||
|     OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|     String model = OllamaModelType.LLAMA2; | ||||
|     String prompt = "some prompt text"; | ||||
|     OptionsBuilder optionsBuilder = new OptionsBuilder(); | ||||
|     try { | ||||
|       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 testAsk() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         String prompt = "some prompt text"; | ||||
|         OptionsBuilder optionsBuilder = new OptionsBuilder(); | ||||
|         try { | ||||
|             when(ollamaAPI.generate(model, prompt, false, optionsBuilder.build())) | ||||
|                     .thenReturn(new OllamaResult("", 0, 200)); | ||||
|             ollamaAPI.generate(model, prompt, false, optionsBuilder.build()); | ||||
|             verify(ollamaAPI, times(1)).generate(model, prompt, false, 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 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 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.generateAsync(model, prompt)) | ||||
|         .thenReturn(new OllamaAsyncResultCallback(null, null, 3)); | ||||
|     ollamaAPI.generateAsync(model, prompt); | ||||
|     verify(ollamaAPI, times(1)).generateAsync(model, prompt); | ||||
|   } | ||||
|     @Test | ||||
|     void testAskAsync() { | ||||
|         OllamaAPI ollamaAPI = Mockito.mock(OllamaAPI.class); | ||||
|         String model = OllamaModelType.LLAMA2; | ||||
|         String prompt = "some prompt text"; | ||||
|         when(ollamaAPI.generateAsync(model, prompt, false)) | ||||
|                 .thenReturn(new OllamaAsyncResultStreamer(null, null, 3)); | ||||
|         ollamaAPI.generateAsync(model, prompt, false); | ||||
|         verify(ollamaAPI, times(1)).generateAsync(model, prompt, false); | ||||
|     } | ||||
| } | ||||
|   | ||||
| @@ -6,30 +6,30 @@ import com.fasterxml.jackson.core.JsonProcessingException; | ||||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.Utils; | ||||
| 
 | ||||
| public abstract class AbstractRequestSerializationTest<T> { | ||||
| public abstract class AbstractSerializationTest<T> { | ||||
| 
 | ||||
|     protected ObjectMapper mapper = Utils.getObjectMapper(); | ||||
| 
 | ||||
|     protected String serializeRequest(T req) { | ||||
|     protected String serialize(T obj) { | ||||
|         try { | ||||
|             return mapper.writeValueAsString(req); | ||||
|             return mapper.writeValueAsString(obj); | ||||
|         } catch (JsonProcessingException e) { | ||||
|             fail("Could not serialize request!", e); | ||||
|             return null; | ||||
|         } | ||||
|     } | ||||
| 
 | ||||
|     protected T deserializeRequest(String jsonRequest, Class<T> requestClass) { | ||||
|     protected T deserialize(String jsonObject, Class<T> deserializationClass) { | ||||
|         try { | ||||
|             return mapper.readValue(jsonRequest, requestClass); | ||||
|             return mapper.readValue(jsonObject, deserializationClass); | ||||
|         } catch (JsonProcessingException e) { | ||||
|             fail("Could not deserialize jsonRequest!", e); | ||||
|             fail("Could not deserialize jsonObject!", e); | ||||
|             return null; | ||||
|         } | ||||
|     } | ||||
| 
 | ||||
|     protected void assertEqualsAfterUnmarshalling(T unmarshalledRequest, | ||||
|     protected void assertEqualsAfterUnmarshalling(T unmarshalledObject, | ||||
|         T req) { | ||||
|         assertEquals(req, unmarshalledRequest); | ||||
|         assertEquals(req, unmarshalledObject); | ||||
|     } | ||||
| } | ||||
| @@ -14,7 +14,7 @@ import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestBuilde | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.chat.OllamaChatRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
|  | ||||
| public class TestChatRequestSerialization extends AbstractRequestSerializationTest<OllamaChatRequestModel>{ | ||||
| public class TestChatRequestSerialization extends AbstractSerializationTest<OllamaChatRequestModel> { | ||||
|  | ||||
|     private OllamaChatRequestBuilder builder; | ||||
|  | ||||
| @@ -26,8 +26,8 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|     @Test | ||||
|     public void testRequestOnlyMandatoryFields() { | ||||
|         OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt").build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
| @@ -35,16 +35,16 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|         OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.SYSTEM, "System prompt") | ||||
|         .withMessage(OllamaChatMessageRole.USER, "Some prompt") | ||||
|         .build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     public void testRequestWithMessageAndImage() { | ||||
|         OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt", | ||||
|                 List.of(new File("src/test/resources/dog-on-a-boat.jpg"))).build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaChatRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
| @@ -61,8 +61,8 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|             .withOptions(b.setTopP(1).build()) | ||||
|             .build(); | ||||
|  | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         OllamaChatRequestModel deserializeRequest = deserializeRequest(jsonRequest, OllamaChatRequestModel.class); | ||||
|         String jsonRequest = serialize(req); | ||||
|         OllamaChatRequestModel deserializeRequest = deserialize(jsonRequest, OllamaChatRequestModel.class); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest, req); | ||||
|         assertEquals(1, deserializeRequest.getOptions().get("mirostat")); | ||||
|         assertEquals(1.0, deserializeRequest.getOptions().get("temperature")); | ||||
| @@ -79,7 +79,7 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|         OllamaChatRequestModel req = builder.withMessage(OllamaChatMessageRole.USER, "Some prompt") | ||||
|                 .withGetJsonResponse().build(); | ||||
|  | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         // no jackson deserialization as format property is not boolean ==> omit as deserialization | ||||
|         // of request is never used in real code anyways | ||||
|         JSONObject jsonObject = new JSONObject(jsonRequest); | ||||
| @@ -91,15 +91,15 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|     public void testWithTemplate() { | ||||
|         OllamaChatRequestModel req = builder.withTemplate("System Template") | ||||
|             .build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest, OllamaChatRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest, OllamaChatRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     public void testWithStreaming() { | ||||
|         OllamaChatRequestModel req = builder.withStreaming().build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEquals(deserializeRequest(jsonRequest, OllamaChatRequestModel.class).isStream(), true); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEquals(deserialize(jsonRequest, OllamaChatRequestModel.class).isStream(), true); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
| @@ -107,7 +107,7 @@ public class TestChatRequestSerialization extends AbstractRequestSerializationTe | ||||
|         String expectedKeepAlive = "5m"; | ||||
|         OllamaChatRequestModel req = builder.withKeepAlive(expectedKeepAlive) | ||||
|             .build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEquals(deserializeRequest(jsonRequest, OllamaChatRequestModel.class).getKeepAlive(), expectedKeepAlive); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEquals(deserialize(jsonRequest, OllamaChatRequestModel.class).getKeepAlive(), expectedKeepAlive); | ||||
|     } | ||||
| } | ||||
|   | ||||
| @@ -7,7 +7,7 @@ import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsR | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.embeddings.OllamaEmbeddingsRequestBuilder; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
|  | ||||
| public class TestEmbeddingsRequestSerialization extends AbstractRequestSerializationTest<OllamaEmbeddingsRequestModel>{ | ||||
| public class TestEmbeddingsRequestSerialization extends AbstractSerializationTest<OllamaEmbeddingsRequestModel> { | ||||
|  | ||||
|         private OllamaEmbeddingsRequestBuilder builder; | ||||
|  | ||||
| @@ -19,8 +19,8 @@ public class TestEmbeddingsRequestSerialization extends AbstractRequestSerializa | ||||
|             @Test | ||||
|     public void testRequestOnlyMandatoryFields() { | ||||
|         OllamaEmbeddingsRequestModel req = builder.build(); | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest,OllamaEmbeddingsRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest,OllamaEmbeddingsRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|         @Test | ||||
| @@ -29,8 +29,8 @@ public class TestEmbeddingsRequestSerialization extends AbstractRequestSerializa | ||||
|             OllamaEmbeddingsRequestModel req = builder | ||||
|                     .withOptions(b.setMirostat(1).build()).build(); | ||||
|  | ||||
|             String jsonRequest = serializeRequest(req); | ||||
|             OllamaEmbeddingsRequestModel deserializeRequest = deserializeRequest(jsonRequest,OllamaEmbeddingsRequestModel.class); | ||||
|             String jsonRequest = serialize(req); | ||||
|             OllamaEmbeddingsRequestModel deserializeRequest = deserialize(jsonRequest,OllamaEmbeddingsRequestModel.class); | ||||
|             assertEqualsAfterUnmarshalling(deserializeRequest, req); | ||||
|             assertEquals(1, deserializeRequest.getOptions().get("mirostat")); | ||||
|         } | ||||
|   | ||||
| @@ -11,7 +11,7 @@ import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateReque | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.generate.OllamaGenerateRequestModel; | ||||
| import io.github.amithkoujalgi.ollama4j.core.utils.OptionsBuilder; | ||||
|  | ||||
| public class TestGenerateRequestSerialization extends AbstractRequestSerializationTest<OllamaGenerateRequestModel>{ | ||||
| public class TestGenerateRequestSerialization extends AbstractSerializationTest<OllamaGenerateRequestModel> { | ||||
|  | ||||
|     private OllamaGenerateRequestBuilder builder; | ||||
|  | ||||
| @@ -24,8 +24,8 @@ public class TestGenerateRequestSerialization extends AbstractRequestSerializati | ||||
|     public void testRequestOnlyMandatoryFields() { | ||||
|         OllamaGenerateRequestModel req = builder.withPrompt("Some prompt").build(); | ||||
|  | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest(jsonRequest, OllamaGenerateRequestModel.class), req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         assertEqualsAfterUnmarshalling(deserialize(jsonRequest, OllamaGenerateRequestModel.class), req); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
| @@ -34,8 +34,8 @@ public class TestGenerateRequestSerialization extends AbstractRequestSerializati | ||||
|         OllamaGenerateRequestModel req = | ||||
|                 builder.withPrompt("Some prompt").withOptions(b.setMirostat(1).build()).build(); | ||||
|  | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         OllamaGenerateRequestModel deserializeRequest = deserializeRequest(jsonRequest, OllamaGenerateRequestModel.class); | ||||
|         String jsonRequest = serialize(req); | ||||
|         OllamaGenerateRequestModel deserializeRequest = deserialize(jsonRequest, OllamaGenerateRequestModel.class); | ||||
|         assertEqualsAfterUnmarshalling(deserializeRequest, req); | ||||
|         assertEquals(1, deserializeRequest.getOptions().get("mirostat")); | ||||
|     } | ||||
| @@ -45,7 +45,7 @@ public class TestGenerateRequestSerialization extends AbstractRequestSerializati | ||||
|         OllamaGenerateRequestModel req = | ||||
|                 builder.withPrompt("Some prompt").withGetJsonResponse().build(); | ||||
|  | ||||
|         String jsonRequest = serializeRequest(req); | ||||
|         String jsonRequest = serialize(req); | ||||
|         // no jackson deserialization as format property is not boolean ==> omit as deserialization | ||||
|         // of request is never used in real code anyways | ||||
|         JSONObject jsonObject = new JSONObject(jsonRequest); | ||||
|   | ||||
| @@ -0,0 +1,42 @@ | ||||
| package io.github.amithkoujalgi.ollama4j.unittests.jackson; | ||||
|  | ||||
| import io.github.amithkoujalgi.ollama4j.core.models.Model; | ||||
| import org.junit.jupiter.api.Test; | ||||
|  | ||||
| public class TestModelRequestSerialization extends AbstractSerializationTest<Model> { | ||||
|  | ||||
|     @Test | ||||
|     public void testDeserializationOfModelResponseWithOffsetTime(){ | ||||
|         String serializedTestStringWithOffsetTime = "{\n" | ||||
|                 + "\"name\": \"codellama:13b\",\n" | ||||
|                 + "\"modified_at\": \"2023-11-04T14:56:49.277302595-07:00\",\n" | ||||
|                 + "\"size\": 7365960935,\n" | ||||
|                 + "\"digest\": \"9f438cb9cd581fc025612d27f7c1a6669ff83a8bb0ed86c94fcf4c5440555697\",\n" | ||||
|                 + "\"details\": {\n" | ||||
|                 + "\"format\": \"gguf\",\n" | ||||
|                 + "\"family\": \"llama\",\n" | ||||
|                 + "\"families\": null,\n" | ||||
|                 + "\"parameter_size\": \"13B\",\n" | ||||
|                 + "\"quantization_level\": \"Q4_0\"\n" | ||||
|                 + "}}"; | ||||
|         deserialize(serializedTestStringWithOffsetTime,Model.class); | ||||
|     } | ||||
|  | ||||
|     @Test | ||||
|     public void testDeserializationOfModelResponseWithZuluTime(){ | ||||
|         String serializedTestStringWithZuluTimezone = "{\n" | ||||
|                 + "\"name\": \"codellama:13b\",\n" | ||||
|                 + "\"modified_at\": \"2023-11-04T14:56:49.277302595Z\",\n" | ||||
|                 + "\"size\": 7365960935,\n" | ||||
|                 + "\"digest\": \"9f438cb9cd581fc025612d27f7c1a6669ff83a8bb0ed86c94fcf4c5440555697\",\n" | ||||
|                 + "\"details\": {\n" | ||||
|                 + "\"format\": \"gguf\",\n" | ||||
|                 + "\"family\": \"llama\",\n" | ||||
|                 + "\"families\": null,\n" | ||||
|                 + "\"parameter_size\": \"13B\",\n" | ||||
|                 + "\"quantization_level\": \"Q4_0\"\n" | ||||
|                 + "}}"; | ||||
|         deserialize(serializedTestStringWithZuluTimezone,Model.class); | ||||
|     } | ||||
|  | ||||
| } | ||||
		Reference in New Issue
	
	Block a user