diff --git a/docs/docs/intro.md b/docs/docs/intro.md index edb742b..e6da3a1 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -76,13 +76,12 @@ The command runs the Ollama server locally at **http://localhost:11434/**. ### Setup your project - Add the dependency to your project's `pom.xml`.
- +
Find the latest version of the library from [Maven Central Repository](https://central.sonatype.com/artifact/io.github.ollama4j/ollama4j). diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js index 5802e04..70507f5 100644 --- a/docs/src/components/HomepageFeatures/index.js +++ b/docs/src/components/HomepageFeatures/index.js @@ -3,37 +3,104 @@ import Heading from '@theme/Heading'; import styles from './styles.module.css'; const FeatureList = [ - { - title: 'Easy LLM Integration', - Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, - description: ( - <> - Easy integration with Ollama, enabling the execution of large language models locally. - - - ), - }, { title: 'Developer-Friendly', Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, description: ( <> - Clean and simple APIs, focused on seamless interaction with Ollama. + Provides clean and simple APIs for interacting with Ollama, including model management, chat functionalities, and authentication capability when Ollama is deployed behind proxy server. ), }, { - title: 'Powered by Java', + title: 'Chat with Images', + Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, + description: ( + <> + Supports interactions with vision/image models, allowing you to build applications that can understand and respond to visual content. Upload images directly into your chat sessions and receive intelligent, context-aware replies. + + ), + }, + { + title: 'Tools Support', Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, description: ( <> - Empowers Java developers to harness the full capabilities of Ollama. + Supports tool/function calling with tool calling models such as mistral, llama3.x, qwen, etc. Empower your models to interact with external services and data sources, enabling more complex and dynamic AI workflows. ), }, ]; +const UsageList = [ + { + title: 'Datafaker', + Svg: require('@site/static/img/datafaker.svg').default, + link: 'https://www.datafaker.net/', + description: ( + <> + A powerful fake data generation library designed for JVM programs, offering over 200 data providers to easily create realistic and diverse datasets within minutes. + + ), + imageSize: '20%', + }, + { + title: 'Katie', + Svg: require('@site/static/img/katie_logo_v3.svg').default, + link: 'https://katie.qa/home', + description: ( + <> + An Open Source AI-based question-answering platform that helps companies and organizations make their private domain knowledge accessible and useful to their employees and customers. + + ), + imageSize: '30%', + }, + { + title: 'AI Player', + Svg: require('@site/static/img/ai-player.svg').default, + link: 'https://modrinth.com/mod/ai-player', + description: ( + <> + A minecraft mod which aims to add a "second player" into the game which will actually be intelligent. + + ), + imageSize: '15%', + }, + { + title: 'Ollama Translator Plugin', + Svg: require('@site/static/img/minecraft-spigot.svg').default, + link: 'https://github.com/liebki/ollama-translator', + description: ( + <> + A minecraft 1.21 spigot plugin allows to easily break language barriers by using ollama on the server to translate all messages into a specfic target language. + + ), + imageSize: '20%', + }, + { + title: 'JnsCLI', + Svg: require('@site/static/img/jnscli.svg').default, + link: 'https://github.com/mirum8/jnscli', + description: ( + <> + JnsCLI is a command-line tool for Jenkins, allowing you to manage jobs, builds, and configurations directly from the terminal. It also features AI-powered error analysis for quick troubleshooting. + + ), + imageSize: '20%', + }, + { + title: 'Featured in a Research Article on AI-Assisted Code Optimization', + Svg: require('@site/static/img/pmc-logo.svg').default, + link: 'https://pmc.ncbi.nlm.nih.gov/articles/PMC11750896/', + description: ( + <> + Ollama4j was used in a research article – “Large Language Model Based Mutations in Genetic Improvement” (PubMed Central). + + ), + imageSize: '50%', + }, +]; -function Feature({Svg, title, description}) { +function Feature({ Svg, title, description }) { return (
@@ -47,16 +114,53 @@ function Feature({Svg, title, description}) { ); } -export default function HomepageFeatures() { +function Usage({ Svg, title, description, link, imageSize }) { return ( -
-
-
- {FeatureList.map((props, idx) => ( - - ))} -
+
+
+
-
+
+ + {link ? ( + + {title} + + ) : ( + {title} + )} + +

{description}

+
+
+ ); +} + +export default function HomepageFeatures() { + return ( + <> +
+
+
+ {FeatureList.map((props, idx) => ( + + ))} +
+
+
+
+
+
+
+ Check out who's using Ollama4j +
+
+ {UsageList.map((props, idx) => ( + + ))} +
+
+
+ ); } diff --git a/docs/src/components/LatestRelease/index.js b/docs/src/components/LatestRelease/index.js index 6efd1b5..21edeed 100644 --- a/docs/src/components/LatestRelease/index.js +++ b/docs/src/components/LatestRelease/index.js @@ -1,6 +1,6 @@ import React, { useState, useEffect } from 'react'; -const LatestRelease = () => { +const LatestRelease = ({ showReleaseDate }) => { const [releaseInfo, setReleaseInfo] = useState(null); const [loading, setLoading] = useState(true); const [error, setError] = useState(null); @@ -37,7 +37,8 @@ const LatestRelease = () => {
{/*

Latest Release

*/}
- Latest Version: {releaseInfo.name} released on {new Date(releaseInfo.published_at).toLocaleDateString(undefined, { year: 'numeric', month: 'long', day: 'numeric' })}. + Latest Version: {releaseInfo.name} + {showReleaseDate && ` released on ${new Date(releaseInfo.published_at).toLocaleDateString(undefined, { year: 'numeric', month: 'long', day: 'numeric' })}`}
{/* 
                         {JSON.stringify(releaseInfo, null, 2)}
diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js
index b5f99e9..6f8597b 100644
--- a/docs/src/pages/index.js
+++ b/docs/src/pages/index.js
@@ -10,7 +10,6 @@ import BrowserOnly from '@docusaurus/BrowserOnly';
 import LatestRelease from '@site/src/components/LatestRelease';
 
 
-
 function HomepageHeader() {
   const {siteConfig} = useDocusaurusContext();
   return (
@@ -32,7 +31,7 @@ function HomepageHeader() {
- +
diff --git a/docs/static/img/ai-player.svg b/docs/static/img/ai-player.svg new file mode 100644 index 0000000..b968420 --- /dev/null +++ b/docs/static/img/ai-player.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/static/img/datafaker.svg b/docs/static/img/datafaker.svg new file mode 100644 index 0000000..0e82595 --- /dev/null +++ b/docs/static/img/datafaker.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/jnscli.svg b/docs/static/img/jnscli.svg new file mode 100644 index 0000000..d6c0f67 --- /dev/null +++ b/docs/static/img/jnscli.svg @@ -0,0 +1,345 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/static/img/katie_logo_v3.svg b/docs/static/img/katie_logo_v3.svg new file mode 100644 index 0000000..eb6c9df --- /dev/null +++ b/docs/static/img/katie_logo_v3.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/static/img/minecraft-spigot.svg b/docs/static/img/minecraft-spigot.svg new file mode 100644 index 0000000..1faf134 --- /dev/null +++ b/docs/static/img/minecraft-spigot.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/ollama4j-ui/1.png b/docs/static/img/ollama4j-ui/1.png new file mode 100644 index 0000000..e5ef8dc Binary files /dev/null and b/docs/static/img/ollama4j-ui/1.png differ diff --git a/docs/static/img/ollama4j-ui/2.png b/docs/static/img/ollama4j-ui/2.png new file mode 100644 index 0000000..17eac4b Binary files /dev/null and b/docs/static/img/ollama4j-ui/2.png differ diff --git a/docs/static/img/ollama4j-ui/3.png b/docs/static/img/ollama4j-ui/3.png new file mode 100644 index 0000000..a23a4e6 Binary files /dev/null and b/docs/static/img/ollama4j-ui/3.png differ diff --git a/docs/static/img/ollama4j-ui/4.png b/docs/static/img/ollama4j-ui/4.png new file mode 100644 index 0000000..98381d8 Binary files /dev/null and b/docs/static/img/ollama4j-ui/4.png differ diff --git a/docs/static/img/pmc-logo.svg b/docs/static/img/pmc-logo.svg new file mode 100644 index 0000000..1894cb7 --- /dev/null +++ b/docs/static/img/pmc-logo.svg @@ -0,0 +1,12 @@ + \ No newline at end of file