diff --git a/docs/docs/apis-ask/_category_.json b/docs/docs/apis-ask/_category_.json index edd59f0..14ea81f 100644 --- a/docs/docs/apis-ask/_category_.json +++ b/docs/docs/apis-ask/_category_.json @@ -3,6 +3,6 @@ "position": 10, "link": { "type": "generated-index", - "description": "Specs of APIs and their usage." + "description": "Details of APIs to interact with LLMs." } } diff --git a/docs/docs/apis-extras/_category_.json b/docs/docs/apis-extras/_category_.json new file mode 100644 index 0000000..aa8b25a --- /dev/null +++ b/docs/docs/apis-extras/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "APIs - Extras", + "position": 10, + "link": { + "type": "generated-index", + "description": "Details of APIs to handle bunch of extra stuff." + } +} diff --git a/docs/docs/apis-extras/ping.md b/docs/docs/apis-extras/ping.md new file mode 100644 index 0000000..cc69f3d --- /dev/null +++ b/docs/docs/apis-extras/ping.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 3 +--- + +# Ping + +This API lets you check the reachability of Ollama server. + +```java +public class Main { + + public static void main(String[] args) { + String host = "http://localhost:11434/"; + + OllamaAPI ollamaAPI = new OllamaAPI(host); + + ollamaAPI.ping(); + } +} +``` \ No newline at end of file diff --git a/docs/docs/apis-extras/request-timeout.md b/docs/docs/apis-extras/request-timeout.md new file mode 100644 index 0000000..ff3f40f --- /dev/null +++ b/docs/docs/apis-extras/request-timeout.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 2 +--- + +# Set Request Timeout + +This API lets you set the request timeout for the Ollama client. + +```java +public class Main { + + public static void main(String[] args) { + + String host = "http://localhost:11434/"; + + OllamaAPI ollamaAPI = new OllamaAPI(host); + + ollamaAPI.setRequestTimeoutSeconds(10); + } +} +``` \ No newline at end of file diff --git a/docs/docs/apis-extras/verbosity.md b/docs/docs/apis-extras/verbosity.md new file mode 100644 index 0000000..35a150e --- /dev/null +++ b/docs/docs/apis-extras/verbosity.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +# Set Verbosity + +This API lets you set the verbosity of the Ollama client. + +## Try asking a question about the model. + +```java +public class Main { + + public static void main(String[] args) { + + String host = "http://localhost:11434/"; + + OllamaAPI ollamaAPI = new OllamaAPI(host); + + ollamaAPI.setVerbose(true); + } +} +``` \ No newline at end of file diff --git a/docs/docs/apis-model-management/_category_.json b/docs/docs/apis-model-management/_category_.json index fee7bea..645545e 100644 --- a/docs/docs/apis-model-management/_category_.json +++ b/docs/docs/apis-model-management/_category_.json @@ -3,6 +3,6 @@ "position": 4, "link": { "type": "generated-index", - "description": "Specs of APIs and their usage." + "description": "Details of APIs to manage LLMs." } }