updated docs

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

@@ -0,0 +1,41 @@
+---
+sidebar_position: 2
+---
+
+# Ask - Async
+
+This API lets you ask questions to the LLMs in a asynchronous way.
+These APIs correlate to
+the [completion](https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion) APIs.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        OllamaAsyncResultCallback ollamaAsyncResultCallback = ollamaAPI.askAsync(OllamaModelType.LLAMA2,
+                "Who are you?");
+
+        while (true) {
+            if (ollamaAsyncResultCallback.isComplete()) {
+                System.out.println(ollamaAsyncResultCallback.getResponse());
+                break;
+            }
+            // introduce sleep to check for status with a time interval
+            Thread.sleep(100);
+        }
+    }
+}
+```
+
+You will get a response similar to:
+
+> I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational
+> manner. I am trained on a massive dataset of text from the internet and can generate human-like responses to a wide
+> range of topics and questions. I can be used to create chatbots, virtual assistants, and other applications that
+> require
+> natural language understanding and generation capabilities.

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

@@ -0,0 +1,44 @@
+---
+sidebar_position: 3
+---
+
+# Ask - 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.
+
+:::caution
+
+Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
+recommended.
+
+:::
+
+## Ask (Sync)
+
+If you have this image downloaded and you pass the path to the downloaded image to the following code:
+
+![Img](https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg)
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(10);
+
+        OllamaResult result = ollamaAPI.askWithImageFiles(OllamaModelType.LLAVA,
+                "What's in this image?",
+                List.of(
+                        new File("/path/to/image")));
+        System.out.println(result.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> This image features a white boat with brown cushions, where a dog is sitting on the back of the boat. The dog seems to
+> be enjoying its time outdoors, perhaps on a lake.

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

@@ -0,0 +1,44 @@
+---
+sidebar_position: 4
+---
+
+# Ask - 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.
+
+:::caution
+
+Executing this on Ollama server running in CPU-mode will take longer to generate response. Hence, GPU-mode is
+recommended.
+
+:::
+
+## Ask (Sync)
+
+Passing the link of this image the following code:
+
+![Img](https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg)
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setRequestTimeoutSeconds(10);
+
+        OllamaResult result = ollamaAPI.askWithImageURLs(OllamaModelType.LLAVA,
+                "What's in this image?",
+                List.of(
+                        "https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"));
+        System.out.println(result.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> This image features a white boat with brown cushions, where a dog is sitting on the back of the boat. The dog seems to
+> be enjoying its time outdoors, perhaps on a lake.

docs/docs/apis-ask/ask.md

@@ -0,0 +1,33 @@
+---
+sidebar_position: 1
+---
+
+# Ask - 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.
+
+```java
+public class Main {
+
+    public static void main(String[] args) {
+        
+        String host = "http://localhost:11434/";
+
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+
+        OllamaResult result = ollamaAPI.ask(OllamaModelType.LLAMA2, "Who are you?");
+
+        System.out.println(result.getResponse());
+    }
+}
+```
+
+You will get a response similar to:
+
+> I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational
+> manner. I am trained on a massive dataset of text from the internet and can generate human-like responses to a wide
+> range of topics and questions. I can be used to create chatbots, virtual assistants, and other applications that
+> require
+> natural language understanding and generation capabilities.

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

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

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

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

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

@@ -1,57 +1,42 @@
 ---
-sidebar_position: 2
+sidebar_position: 5
 ---
 
 # Generate Embeddings
 
-Documents are **groups of pages** connected through:
+Generate embeddings from a model.
 
-- a **sidebar**
+Parameters:
-- **previous/next navigation**
-- **versioning**
 
-## Create your first Doc
+- `model`: name of model to generate embeddings from
+- `prompt`: text to generate embeddings for
 
-Create a Markdown file at `docs/hello.md`:
+```java
+public class Main {
 
-```md title="docs/hello.md"
+    public static void main(String[] args) {
-# Hello
+        String host = "http://localhost:11434/";
-
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
-This is my **first Docusaurus document**!
+        List<Double> embeddings = ollamaAPI.generateEmbeddings(OllamaModelType.LLAMA2,
+                "Here is an article about llamas...");
+        embeddings.forEach(System.out::println);
+    }
+}
 ```
 
-A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+You will get a response similar to:
 
-## Configure the Sidebar
+```json
-
+ [
-Docusaurus automatically **creates a sidebar** from the `docs` folder.
+  0.5670403838157654,
-
+  0.009260174818336964,
-Add metadata to customize the sidebar label and position:
+  0.23178744316101074,
-
+  -0.2916173040866852,
-```md title="docs/hello.md" {1-4}
+  -0.8924556970596313,
----
+  0.8785552978515625,
-sidebar_label: 'Hi!'
+  -0.34576427936553955,
-sidebar_position: 3
+  0.5742510557174683,
----
+  -0.04222835972905159,
-
+  -0.137906014919281
-# Hello
+]
-
+```
-This is my **first Docusaurus document**!
-```
-
-It is also possible to create your sidebar explicitly in `sidebars.js`:
-
-```js title="sidebars.js"
-export default {
-  tutorialSidebar: [
-    'intro',
-    // highlight-next-line
-    'hello',
-    {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
-    },
-  ],
-};
-```

docs/docs/apis-ask/get-model-details.md

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

docs/docs/apis-ask/list-models.md

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

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

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

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

@@ -1,34 +1,23 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # Create Model
 
-Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
+This API lets you create a custom model on the Ollama server.
 
-## Create your first Post
+```java title="CreateModel.java"
+public class CreateModel {
 
-Create a file at `blog/2021-02-28-greetings.md`:
+    public static void main(String[] args) {
 
-```md title="blog/2021-02-28-greetings.md"
+        String host = "http://localhost:11434/";
----
-slug: greetings
-title: Greetings!
-authors:
-  - name: Joel Marcey
-    title: Co-creator of Docusaurus 1
-    url: https://github.com/JoelMarcey
-    image_url: https://github.com/JoelMarcey.png
-  - name: Sébastien Lorber
-    title: Docusaurus maintainer
-    url: https://sebastienlorber.com
-    image_url: https://github.com/slorber.png
-tags: [greetings]
----
 
-Congratulations, you have made your first post!
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-Feel free to play around and edit this post as much you like.
+        ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server");
+    }
+}
 ```
 
-A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
+Once created, you can see it when you use [list models](./list-models) API.

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

@@ -4,28 +4,19 @@ sidebar_position: 5
 
 # Delete Model
 
-Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
+This API lets you create a delete a model from the Ollama server.
 
-It builds your site as simple **static HTML, JavaScript and CSS files**.
+```java title="DeleteModel.java"
+public class Main {
 
-## Build your site
+    public static void main(String[] args) {
+        String host = "http://localhost:11434/";
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
+        ollamaAPI.setVerbose(false);
+        ollamaAPI.deleteModel("mycustommodel", true);
+    }
+}
 
-Build your site **for production**:
-
-```bash
-npm run build
 ```
 
-The static files are generated in the `build` folder.
+Once deleted, you can verify it using [list models](./list-models) API.
-
-## Deploy your site
-
-Test your production build locally:
-
-```bash
-npm run serve
-```
-
-The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
-
-You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).

docs/docs/apis-model-management/generate-embeddings.md

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

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

@@ -4,40 +4,27 @@ sidebar_position: 1
 
 # List Models
 
-Add **Markdown or React** files to `src/pages` to create a **standalone page**:
+This API lets you list available models on the Ollama server.
 
-- `src/pages/index.js` → `localhost:3000/`
+```java title="ListModels.java"
-- `src/pages/foo.md` → `localhost:3000/foo`
+public class ListModels {
-- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
 
-## Create your first React Page
+    public static void main(String[] args) {
 
-Create a file at `src/pages/my-react-page.js`:
+        String host = "http://localhost:11434/";
 
-```jsx title="src/pages/my-react-page.js"
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
-import React from 'react';
-import Layout from '@theme/Layout';
 
-export default function MyReactPage() {
+        List<Model> models = ollamaAPI.listModels();
-  return (
+
-    <Layout>
+        models.forEach(model -> System.out.println(model.getName()));
-      <h1>My React page</h1>
+    }
-      <p>This is a React page</p>
-    </Layout>
-  );
 }
 ```
 
-A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
+If you have any models already downloaded on Ollama server, you would have them listed as follows:
 
-## Create your first Markdown Page
+```bash
-
+llama2:latest
-Create a file at `src/pages/my-markdown-page.md`:
+sqlcoder:latest
-
+```
-```mdx title="src/pages/my-markdown-page.md"
-# My Markdown page
-
-This is a Markdown page
-```
-
-A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).

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

@@ -1,23 +1,23 @@
 ---
-sidebar_position: 6
+sidebar_position: 2
 ---
 
 # Pull Model
 
-You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
+This API lets you pull a model on the Ollama server.
 
-Docusaurus has **much more to offer**!
+```java title="PullModel.java"
+public class Main {
 
-Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
+    public static void main(String[] args) {
+        
+        String host = "http://localhost:11434/";
 
-Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-## What's next?
+        ollamaAPI.pullModel(OllamaModelType.LLAMA2);
+    }
+}
+```
 
-- Read the [official documentation](https://docusaurus.io/)
+Once downloaded, you can see them when you use [list models](./list-models) API.
-- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
-- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
-- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
-- Add a [search bar](https://docusaurus.io/docs/search)
-- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
-- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)

docs/docs/intro.md

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Intro
 
-Let's discover **Ollama4J in less than 5 minutes**.
+Let's get started with **Ollama4J**.
 
 ## Getting Started
 
@@ -50,9 +50,9 @@ Add the dependency to your project's `pom.xml`.
 ```xml
 
 <dependency>
-  <groupId>io.github.amithkoujalgi</groupId>
+    <groupId>io.github.amithkoujalgi</groupId>
-  <artifactId>ollama4j</artifactId>
+    <artifactId>ollama4j</artifactId>
-  <version>1.0.27</version>
+    <version>1.0.27</version>
 </dependency>
 ```
 
@@ -61,16 +61,16 @@ Create a new Java class in your project and add this code.
 ```java
 public class OllamaAPITest {
 
-  public static void main(String[] args) {
+    public static void main(String[] args) {
-    String host = "http://localhost:11434/";
+        String host = "http://localhost:11434/";
-    
-    OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-    ollamaAPI.setVerbose(true);
+        OllamaAPI ollamaAPI = new OllamaAPI(host);
 
-    boolean isOllamaServerReachable  = ollamaAPI.ping();
+        ollamaAPI.setVerbose(true);
 
-    System.out.println("Is Ollama server alive: " + isOllamaServerReachable);
+        boolean isOllamaServerReachable = ollamaAPI.ping();
-  }
+
+        System.out.println("Is Ollama server alive: " + isOllamaServerReachable);
+    }
 }
 ```

docs/docs/tutorial-basics/_category_.json

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

docs/docs/tutorial-basics/congratulations.md

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

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

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

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

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

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

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

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

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

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

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

docs/docs/tutorial-extras/_category_.json

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

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

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

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

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

docs/docusaurus.config.js

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