Update Java docs

eoctet · Oct 16, 2023 · eb1d43f · eb1d43f
1 parent 9f5263b
commit eb1d43f
Show file tree

Hide file tree

Showing 118 changed files with 8,239 additions and 6,935 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1 +1,2 @@
-1. Update llama.cpp libs version to b1381.
+1. Add model prompt templates.
+2. Update Java docs.
diff --git a/README.Zh_CN.md b/README.Zh_CN.md
@@ -26,7 +26,7 @@
 <dependency>
     <groupId>chat.octet</groupId>
     <artifactId>llama-java-core</artifactId>
-    <version>1.1.9</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 

diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ Another simple Java bindings for 🦙 [**llama.cpp**](https://github.com/ggergan
 <dependency>
     <groupId>chat.octet</groupId>
     <artifactId>llama-java-core</artifactId>
-    <version>1.1.9</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -1,46 +1,47 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
-<html lang="zh">
+<html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_381) on Sun Oct 08 15:09:39 CST 2023 -->
+<!-- Generated by javadoc (1.8.0_381) on Mon Oct 16  2023 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>所有类 (llama-java-core 1.1.6 API)</title>
-<meta name="date" content="2023-10-08">
+<title>All Classes (llama-java-core 1.2.0 API)</title>
+<meta name="date" content="2023-10-16">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
-<h1 class="bar">所有类</h1>
+<h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
-<li><a href="chat/octet/model/beans/ChatMessage.html" title="chat.octet.model.beans中的类" target="classFrame">ChatMessage</a></li>
-<li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="chat.octet.model.beans中的枚举" target="classFrame">ChatMessage.ChatRole</a></li>
-<li><a href="chat/octet/model/beans/CompletionResult.html" title="chat.octet.model.beans中的类" target="classFrame">CompletionResult</a></li>
-<li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类" target="classFrame">CustomBiasLogitsProcessor</a></li>
-<li><a href="chat/octet/model/exceptions/DecodeException.html" title="chat.octet.model.exceptions中的类" target="classFrame">DecodeException</a></li>
-<li><a href="chat/octet/model/beans/FinishReason.html" title="chat.octet.model.beans中的枚举" target="classFrame">FinishReason</a></li>
-<li><a href="chat/octet/model/parameters/GenerateParameter.html" title="chat.octet.model.parameters中的类" target="classFrame">GenerateParameter</a></li>
-<li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="chat.octet.model.parameters中的枚举" target="classFrame">GenerateParameter.MirostatMode</a></li>
-<li><a href="chat/octet/model/Generator.html" title="chat.octet.model中的类" target="classFrame">Generator</a></li>
-<li><a href="chat/octet/model/beans/LlamaContextParams.html" title="chat.octet.model.beans中的类" target="classFrame">LlamaContextParams</a></li>
-<li><a href="chat/octet/model/beans/LlamaModelParams.html" title="chat.octet.model.beans中的类" target="classFrame">LlamaModelParams</a></li>
-<li><a href="chat/octet/model/LlamaService.html" title="chat.octet.model中的类" target="classFrame">LlamaService</a></li>
-<li><a href="chat/octet/model/beans/LlamaTokenType.html" title="chat.octet.model.beans中的枚举" target="classFrame">LlamaTokenType</a></li>
-<li><a href="chat/octet/model/components/processor/LogitsProcessor.html" title="chat.octet.model.components.processor中的接口" target="classFrame"><span class="interfaceName">LogitsProcessor</span></a></li>
-<li><a href="chat/octet/model/components/processor/LogitsProcessorList.html" title="chat.octet.model.components.processor中的类" target="classFrame">LogitsProcessorList</a></li>
-<li><a href="chat/octet/model/components/criteria/impl/MaxTimeCriteria.html" title="chat.octet.model.components.criteria.impl中的类" target="classFrame">MaxTimeCriteria</a></li>
-<li><a href="chat/octet/model/beans/Metrics.html" title="chat.octet.model.beans中的类" target="classFrame">Metrics</a></li>
-<li><a href="chat/octet/model/Model.html" title="chat.octet.model中的类" target="classFrame">Model</a></li>
-<li><a href="chat/octet/model/exceptions/ModelException.html" title="chat.octet.model.exceptions中的类" target="classFrame">ModelException</a></li>
-<li><a href="chat/octet/model/parameters/ModelParameter.html" title="chat.octet.model.parameters中的类" target="classFrame">ModelParameter</a></li>
-<li><a href="chat/octet/model/components/processor/impl/NoBadWordsLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类" target="classFrame">NoBadWordsLogitsProcessor</a></li>
-<li><a href="chat/octet/model/utils/Platform.html" title="chat.octet.model.utils中的类" target="classFrame">Platform</a></li>
-<li><a href="chat/octet/model/utils/PromptBuilder.html" title="chat.octet.model.utils中的类" target="classFrame">PromptBuilder</a></li>
-<li><a href="chat/octet/model/beans/Status.html" title="chat.octet.model.beans中的类" target="classFrame">Status</a></li>
-<li><a href="chat/octet/model/components/criteria/StoppingCriteria.html" title="chat.octet.model.components.criteria中的接口" target="classFrame"><span class="interfaceName">StoppingCriteria</span></a></li>
-<li><a href="chat/octet/model/components/criteria/StoppingCriteriaList.html" title="chat.octet.model.components.criteria中的类" target="classFrame">StoppingCriteriaList</a></li>
-<li><a href="chat/octet/model/beans/Token.html" title="chat.octet.model.beans中的类" target="classFrame">Token</a></li>
-<li><a href="chat/octet/model/TokenDecoder.html" title="chat.octet.model中的类" target="classFrame">TokenDecoder</a></li>
+<li><a href="chat/octet/model/beans/ChatMessage.html" title="class in chat.octet.model.beans" target="classFrame">ChatMessage</a></li>
+<li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="enum in chat.octet.model.beans" target="classFrame">ChatMessage.ChatRole</a></li>
+<li><a href="chat/octet/model/beans/CompletionResult.html" title="class in chat.octet.model.beans" target="classFrame">CompletionResult</a></li>
+<li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="class in chat.octet.model.components.processor.impl" target="classFrame">CustomBiasLogitsProcessor</a></li>
+<li><a href="chat/octet/model/exceptions/DecodeException.html" title="class in chat.octet.model.exceptions" target="classFrame">DecodeException</a></li>
+<li><a href="chat/octet/model/enums/FinishReason.html" title="enum in chat.octet.model.enums" target="classFrame">FinishReason</a></li>
+<li><a href="chat/octet/model/parameters/GenerateParameter.html" title="class in chat.octet.model.parameters" target="classFrame">GenerateParameter</a></li>
+<li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="enum in chat.octet.model.parameters" target="classFrame">GenerateParameter.MirostatMode</a></li>
+<li><a href="chat/octet/model/Generator.html" title="class in chat.octet.model" target="classFrame">Generator</a></li>
+<li><a href="chat/octet/model/beans/LlamaContextParams.html" title="class in chat.octet.model.beans" target="classFrame">LlamaContextParams</a></li>
+<li><a href="chat/octet/model/beans/LlamaModelParams.html" title="class in chat.octet.model.beans" target="classFrame">LlamaModelParams</a></li>
+<li><a href="chat/octet/model/LlamaService.html" title="class in chat.octet.model" target="classFrame">LlamaService</a></li>
+<li><a href="chat/octet/model/enums/LlamaTokenType.html" title="enum in chat.octet.model.enums" target="classFrame">LlamaTokenType</a></li>
+<li><a href="chat/octet/model/components/processor/LogitsProcessor.html" title="interface in chat.octet.model.components.processor" target="classFrame"><span class="interfaceName">LogitsProcessor</span></a></li>
+<li><a href="chat/octet/model/components/processor/LogitsProcessorList.html" title="class in chat.octet.model.components.processor" target="classFrame">LogitsProcessorList</a></li>
+<li><a href="chat/octet/model/components/criteria/impl/MaxTimeCriteria.html" title="class in chat.octet.model.components.criteria.impl" target="classFrame">MaxTimeCriteria</a></li>
+<li><a href="chat/octet/model/beans/Metrics.html" title="class in chat.octet.model.beans" target="classFrame">Metrics</a></li>
+<li><a href="chat/octet/model/Model.html" title="class in chat.octet.model" target="classFrame">Model</a></li>
+<li><a href="chat/octet/model/exceptions/ModelException.html" title="class in chat.octet.model.exceptions" target="classFrame">ModelException</a></li>
+<li><a href="chat/octet/model/parameters/ModelParameter.html" title="class in chat.octet.model.parameters" target="classFrame">ModelParameter</a></li>
+<li><a href="chat/octet/model/enums/ModelType.html" title="enum in chat.octet.model.enums" target="classFrame">ModelType</a></li>
+<li><a href="chat/octet/model/components/processor/impl/NoBadWordsLogitsProcessor.html" title="class in chat.octet.model.components.processor.impl" target="classFrame">NoBadWordsLogitsProcessor</a></li>
+<li><a href="chat/octet/model/utils/Platform.html" title="class in chat.octet.model.utils" target="classFrame">Platform</a></li>
+<li><a href="chat/octet/model/utils/PromptBuilder.html" title="class in chat.octet.model.utils" target="classFrame">PromptBuilder</a></li>
+<li><a href="chat/octet/model/beans/Status.html" title="class in chat.octet.model.beans" target="classFrame">Status</a></li>
+<li><a href="chat/octet/model/components/criteria/StoppingCriteria.html" title="interface in chat.octet.model.components.criteria" target="classFrame"><span class="interfaceName">StoppingCriteria</span></a></li>
+<li><a href="chat/octet/model/components/criteria/StoppingCriteriaList.html" title="class in chat.octet.model.components.criteria" target="classFrame">StoppingCriteriaList</a></li>
+<li><a href="chat/octet/model/beans/Token.html" title="class in chat.octet.model.beans" target="classFrame">Token</a></li>
+<li><a href="chat/octet/model/TokenDecoder.html" title="class in chat.octet.model" target="classFrame">TokenDecoder</a></li>
 </ul>
 </div>
 </body>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -1,46 +1,47 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
-<html lang="zh">
+<html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_381) on Sun Oct 08 15:09:39 CST 2023 -->
+<!-- Generated by javadoc (1.8.0_381) on Mon Oct 16  2023 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>所有类 (llama-java-core 1.1.6 API)</title>
-<meta name="date" content="2023-10-08">
+<title>All Classes (llama-java-core 1.2.0 API)</title>
+<meta name="date" content="2023-10-16">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
-<h1 class="bar">所有类</h1>
+<h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
-<li><a href="chat/octet/model/beans/ChatMessage.html" title="chat.octet.model.beans中的类">ChatMessage</a></li>
-<li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="chat.octet.model.beans中的枚举">ChatMessage.ChatRole</a></li>
-<li><a href="chat/octet/model/beans/CompletionResult.html" title="chat.octet.model.beans中的类">CompletionResult</a></li>
-<li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类">CustomBiasLogitsProcessor</a></li>
-<li><a href="chat/octet/model/exceptions/DecodeException.html" title="chat.octet.model.exceptions中的类">DecodeException</a></li>
-<li><a href="chat/octet/model/beans/FinishReason.html" title="chat.octet.model.beans中的枚举">FinishReason</a></li>
-<li><a href="chat/octet/model/parameters/GenerateParameter.html" title="chat.octet.model.parameters中的类">GenerateParameter</a></li>
-<li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="chat.octet.model.parameters中的枚举">GenerateParameter.MirostatMode</a></li>
-<li><a href="chat/octet/model/Generator.html" title="chat.octet.model中的类">Generator</a></li>
-<li><a href="chat/octet/model/beans/LlamaContextParams.html" title="chat.octet.model.beans中的类">LlamaContextParams</a></li>
-<li><a href="chat/octet/model/beans/LlamaModelParams.html" title="chat.octet.model.beans中的类">LlamaModelParams</a></li>
-<li><a href="chat/octet/model/LlamaService.html" title="chat.octet.model中的类">LlamaService</a></li>
-<li><a href="chat/octet/model/beans/LlamaTokenType.html" title="chat.octet.model.beans中的枚举">LlamaTokenType</a></li>
-<li><a href="chat/octet/model/components/processor/LogitsProcessor.html" title="chat.octet.model.components.processor中的接口"><span class="interfaceName">LogitsProcessor</span></a></li>
-<li><a href="chat/octet/model/components/processor/LogitsProcessorList.html" title="chat.octet.model.components.processor中的类">LogitsProcessorList</a></li>
-<li><a href="chat/octet/model/components/criteria/impl/MaxTimeCriteria.html" title="chat.octet.model.components.criteria.impl中的类">MaxTimeCriteria</a></li>
-<li><a href="chat/octet/model/beans/Metrics.html" title="chat.octet.model.beans中的类">Metrics</a></li>
-<li><a href="chat/octet/model/Model.html" title="chat.octet.model中的类">Model</a></li>
-<li><a href="chat/octet/model/exceptions/ModelException.html" title="chat.octet.model.exceptions中的类">ModelException</a></li>
-<li><a href="chat/octet/model/parameters/ModelParameter.html" title="chat.octet.model.parameters中的类">ModelParameter</a></li>
-<li><a href="chat/octet/model/components/processor/impl/NoBadWordsLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类">NoBadWordsLogitsProcessor</a></li>
-<li><a href="chat/octet/model/utils/Platform.html" title="chat.octet.model.utils中的类">Platform</a></li>
-<li><a href="chat/octet/model/utils/PromptBuilder.html" title="chat.octet.model.utils中的类">PromptBuilder</a></li>
-<li><a href="chat/octet/model/beans/Status.html" title="chat.octet.model.beans中的类">Status</a></li>
-<li><a href="chat/octet/model/components/criteria/StoppingCriteria.html" title="chat.octet.model.components.criteria中的接口"><span class="interfaceName">StoppingCriteria</span></a></li>
-<li><a href="chat/octet/model/components/criteria/StoppingCriteriaList.html" title="chat.octet.model.components.criteria中的类">StoppingCriteriaList</a></li>
-<li><a href="chat/octet/model/beans/Token.html" title="chat.octet.model.beans中的类">Token</a></li>
-<li><a href="chat/octet/model/TokenDecoder.html" title="chat.octet.model中的类">TokenDecoder</a></li>
+<li><a href="chat/octet/model/beans/ChatMessage.html" title="class in chat.octet.model.beans">ChatMessage</a></li>
+<li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="enum in chat.octet.model.beans">ChatMessage.ChatRole</a></li>
+<li><a href="chat/octet/model/beans/CompletionResult.html" title="class in chat.octet.model.beans">CompletionResult</a></li>
+<li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="class in chat.octet.model.components.processor.impl">CustomBiasLogitsProcessor</a></li>
+<li><a href="chat/octet/model/exceptions/DecodeException.html" title="class in chat.octet.model.exceptions">DecodeException</a></li>
+<li><a href="chat/octet/model/enums/FinishReason.html" title="enum in chat.octet.model.enums">FinishReason</a></li>
+<li><a href="chat/octet/model/parameters/GenerateParameter.html" title="class in chat.octet.model.parameters">GenerateParameter</a></li>
+<li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="enum in chat.octet.model.parameters">GenerateParameter.MirostatMode</a></li>
+<li><a href="chat/octet/model/Generator.html" title="class in chat.octet.model">Generator</a></li>
+<li><a href="chat/octet/model/beans/LlamaContextParams.html" title="class in chat.octet.model.beans">LlamaContextParams</a></li>
+<li><a href="chat/octet/model/beans/LlamaModelParams.html" title="class in chat.octet.model.beans">LlamaModelParams</a></li>
+<li><a href="chat/octet/model/LlamaService.html" title="class in chat.octet.model">LlamaService</a></li>
+<li><a href="chat/octet/model/enums/LlamaTokenType.html" title="enum in chat.octet.model.enums">LlamaTokenType</a></li>
+<li><a href="chat/octet/model/components/processor/LogitsProcessor.html" title="interface in chat.octet.model.components.processor"><span class="interfaceName">LogitsProcessor</span></a></li>
+<li><a href="chat/octet/model/components/processor/LogitsProcessorList.html" title="class in chat.octet.model.components.processor">LogitsProcessorList</a></li>
+<li><a href="chat/octet/model/components/criteria/impl/MaxTimeCriteria.html" title="class in chat.octet.model.components.criteria.impl">MaxTimeCriteria</a></li>
+<li><a href="chat/octet/model/beans/Metrics.html" title="class in chat.octet.model.beans">Metrics</a></li>
+<li><a href="chat/octet/model/Model.html" title="class in chat.octet.model">Model</a></li>
+<li><a href="chat/octet/model/exceptions/ModelException.html" title="class in chat.octet.model.exceptions">ModelException</a></li>
+<li><a href="chat/octet/model/parameters/ModelParameter.html" title="class in chat.octet.model.parameters">ModelParameter</a></li>
+<li><a href="chat/octet/model/enums/ModelType.html" title="enum in chat.octet.model.enums">ModelType</a></li>
+<li><a href="chat/octet/model/components/processor/impl/NoBadWordsLogitsProcessor.html" title="class in chat.octet.model.components.processor.impl">NoBadWordsLogitsProcessor</a></li>
+<li><a href="chat/octet/model/utils/Platform.html" title="class in chat.octet.model.utils">Platform</a></li>
+<li><a href="chat/octet/model/utils/PromptBuilder.html" title="class in chat.octet.model.utils">PromptBuilder</a></li>
+<li><a href="chat/octet/model/beans/Status.html" title="class in chat.octet.model.beans">Status</a></li>
+<li><a href="chat/octet/model/components/criteria/StoppingCriteria.html" title="interface in chat.octet.model.components.criteria"><span class="interfaceName">StoppingCriteria</span></a></li>
+<li><a href="chat/octet/model/components/criteria/StoppingCriteriaList.html" title="class in chat.octet.model.components.criteria">StoppingCriteriaList</a></li>
+<li><a href="chat/octet/model/beans/Token.html" title="class in chat.octet.model.beans">Token</a></li>
+<li><a href="chat/octet/model/TokenDecoder.html" title="class in chat.octet.model">TokenDecoder</a></li>
 </ul>
 </div>
 </body>