mirror of
https://github.com/amithkoujalgi/ollama4j.git
synced 2025-11-02 17:40:41 +01:00
Updated docs
This commit is contained in:
@@ -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 <code>APIs</code>, focused on seamless interaction with Ollama.
|
||||
Provides clean and simple <code>APIs</code> 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 (
|
||||
<div className={clsx('col col--4')}>
|
||||
<div className="text--center">
|
||||
@@ -47,16 +114,53 @@ function Feature({Svg, title, description}) {
|
||||
);
|
||||
}
|
||||
|
||||
export default function HomepageFeatures() {
|
||||
function Usage({ Svg, title, description, link, imageSize }) {
|
||||
return (
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
<div className="row">
|
||||
{FeatureList.map((props, idx) => (
|
||||
<Feature key={idx} {...props} />
|
||||
))}
|
||||
</div>
|
||||
<div className={clsx('col col--4')}>
|
||||
<div className="text--center">
|
||||
<Svg className={styles.featureSvg} role="img" style={{ width: imageSize }} />
|
||||
</div>
|
||||
</section>
|
||||
<div className="text--center padding-horiz--md">
|
||||
<Heading as="h3" style={{ color: 'red' }}>
|
||||
{link ? (
|
||||
<a href={link} target="_blank" rel="noopener noreferrer" style={{ color: '#11bc11' }}>
|
||||
{title}
|
||||
</a>
|
||||
) : (
|
||||
<span style={{ color: 'red' }}>{title}</span>
|
||||
)}
|
||||
</Heading>
|
||||
<p>{description}</p>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function HomepageFeatures() {
|
||||
return (
|
||||
<>
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
<div className="row">
|
||||
{FeatureList.map((props, idx) => (
|
||||
<Feature key={idx} {...props} />
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<hr />
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
<div style={{ fontSize: '20px', fontWeight: 'bold', display: 'flex', flexDirection: 'column', alignItems: 'center' }}>
|
||||
Check out who's using Ollama4j
|
||||
</div>
|
||||
<div className="row">
|
||||
{UsageList.map((props, idx) => (
|
||||
<Usage key={idx} {...props} />
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -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 = () => {
|
||||
<div>
|
||||
{/* <h4 style={{ display: 'flex', justifyContent: 'center'}}>Latest Release</h4> */}
|
||||
<div>
|
||||
<span style={{ fontWeight: 'bold'}}>Latest Version</span>: <a href={releaseInfo.html_url} target='_blank' rel="noopener noreferrer"><span style={{color: 'white', fontWeight: 'bold', backgroundColor:'#11bc11', borderRadius: '15px', padding: '5px'}}>{releaseInfo.name}</span></a> released on {new Date(releaseInfo.published_at).toLocaleDateString(undefined, { year: 'numeric', month: 'long', day: 'numeric' })}.
|
||||
<span style={{ fontWeight: 'bold'}}>Latest Version</span>: <a href={releaseInfo.html_url} target='_blank' rel="noopener noreferrer"><span style={{color: 'white', fontWeight: 'bold', backgroundColor:'#11bc11', borderRadius: '15px', padding: '5px'}}>{releaseInfo.name}</span></a>
|
||||
{showReleaseDate && ` released on ${new Date(releaseInfo.published_at).toLocaleDateString(undefined, { year: 'numeric', month: 'long', day: 'numeric' })}`}
|
||||
</div>
|
||||
{/* <pre style={{ whiteSpace: 'pre-wrap' }}>
|
||||
{JSON.stringify(releaseInfo, null, 2)}
|
||||
|
||||
@@ -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() {
|
||||
</Link>
|
||||
</div>
|
||||
<div style={{ marginTop: '3rem' }}>
|
||||
<LatestRelease />
|
||||
<LatestRelease showReleaseDate={false} />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
Reference in New Issue
Block a user