forked from Mirror/ollama4j
		
	Update readme
This commit is contained in:
		
							
								
								
									
										49
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										49
									
								
								README.md
									
									
									
									
									
								
							@@ -1,7 +1,8 @@
 | 
				
			|||||||
<div align="center">
 | 
					<div align="center">
 | 
				
			||||||
  <img src='https://raw.githubusercontent.com/ollama4j/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
 | 
					  <img src='https://raw.githubusercontent.com/ollama4j/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  ### Ollama4j
 | 
					### Ollama4j
 | 
				
			||||||
 | 
					
 | 
				
			||||||
</div>
 | 
					</div>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
<div align="center">
 | 
					<div align="center">
 | 
				
			||||||
@@ -40,15 +41,53 @@ _Find more details on the **[website](https://ollama4j.github.io/ollama4j/)**._
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Table of Contents
 | 
					## Table of Contents
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- [Table of Contents](#table-of-contents)
 | 
				
			||||||
 | 
					- [Capabilities](#capabilities)
 | 
				
			||||||
- [How does it work?](#how-does-it-work)
 | 
					- [How does it work?](#how-does-it-work)
 | 
				
			||||||
- [Requirements](#requirements)
 | 
					- [Requirements](#requirements)
 | 
				
			||||||
- [Installation](#installation)
 | 
					- [Installation](#installation)
 | 
				
			||||||
- [API Spec](https://ollama4j.github.io/ollama4j/category/apis---model-management)
 | 
					    - [For Maven](#for-maven)
 | 
				
			||||||
 | 
					        - [Using Maven Central](#using-maven-central)
 | 
				
			||||||
 | 
					        - [Using GitHub's Maven Package Repository](#using-githubs-maven-package-repository)
 | 
				
			||||||
 | 
					    - [For Gradle](#for-gradle)
 | 
				
			||||||
 | 
					        - [API Spec](#api-spec)
 | 
				
			||||||
- [Examples](#examples)
 | 
					- [Examples](#examples)
 | 
				
			||||||
- [Javadoc](https://ollama4j.github.io/ollama4j/apidocs/)
 | 
					 | 
				
			||||||
- [Development](#development)
 | 
					- [Development](#development)
 | 
				
			||||||
- [Contributions](#get-involved)
 | 
					    - [Setup dev environment](#setup-dev-environment)
 | 
				
			||||||
- [References](#references)
 | 
					    - [Build](#build)
 | 
				
			||||||
 | 
					    - [Run unit tests](#run-unit-tests)
 | 
				
			||||||
 | 
					    - [Run integration tests](#run-integration-tests)
 | 
				
			||||||
 | 
					    - [Releases](#releases)
 | 
				
			||||||
 | 
					- [Get Involved](#get-involved)
 | 
				
			||||||
 | 
					- [Who's using Ollama4j?](#whos-using-ollama4j)
 | 
				
			||||||
 | 
					- [Growth](#growth)
 | 
				
			||||||
 | 
					    - [References](#references)
 | 
				
			||||||
 | 
					    - [Credits](#credits)
 | 
				
			||||||
 | 
					    - [Appreciate the work?](#appreciate-the-work)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Capabilities
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- **Text generation**: Single-turn `generate` with optional streaming and advanced options
 | 
				
			||||||
 | 
					- **Chat**: Multi-turn chat with conversation history and roles
 | 
				
			||||||
 | 
					- **Tool/function calling**: Built-in tool invocation via annotations and tool specs
 | 
				
			||||||
 | 
					- **Reasoning/thinking modes**: Generate and chat with “thinking” outputs where supported
 | 
				
			||||||
 | 
					- **Image inputs (multimodal)**: Generate with images as inputs where models support vision
 | 
				
			||||||
 | 
					- **Embeddings**: Create vector embeddings for text
 | 
				
			||||||
 | 
					- **Async generation**: Fire-and-forget style generation APIs
 | 
				
			||||||
 | 
					- **Custom roles**: Define and use custom chat roles
 | 
				
			||||||
 | 
					- **Model management**: List, pull, create, delete, and get model details
 | 
				
			||||||
 | 
					- **Connectivity utilities**: Server `ping` and process status (`ps`)
 | 
				
			||||||
 | 
					- **Authentication**: Basic auth and bearer token support
 | 
				
			||||||
 | 
					- **Options builder**: Type-safe builder for model parameters and request options
 | 
				
			||||||
 | 
					- **Timeouts**: Configure connect/read/write timeouts
 | 
				
			||||||
 | 
					- **Logging**: Built-in logging hooks for requests and responses
 | 
				
			||||||
 | 
					- **Metrics & Monitoring** 🆕: Built-in Prometheus metrics export for real-time monitoring of requests, model usage, and
 | 
				
			||||||
 | 
					  performance. *(Beta feature – feedback/contributions welcome!)* -
 | 
				
			||||||
 | 
					  Checkout [ollama4j-examples](https://github.com/ollama4j/ollama4j-examples) repository for details.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					<div align="center">
 | 
				
			||||||
 | 
					  <img src='metrics.png' width='100%' alt="ollama4j-icon">
 | 
				
			||||||
 | 
					</div>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## How does it work?
 | 
					## How does it work?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										
											BIN
										
									
								
								metrics.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								metrics.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 373 KiB  | 
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Reference in New Issue
	
	Block a user