Skip to content

Commit f16286c

Browse files
BarqawizBarqawiz
committed
update javadoc to latest version 0.8.0
1 parent fca1077 commit f16286c

File tree

117 files changed

+6460
-624
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+6460
-624
lines changed

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,16 +118,16 @@ The only dependencies is **GSON**.
118118

119119
# Roadmap
120120
Call for contributors:
121-
- [x] Add support to OpenAI Completion.
122-
- [x] Add support to OpenAI DALL·E 2.
123-
- [ ] Add support to other OpenAI functions.
124-
- [x] Add support to cohere generate API.
125-
- [ ] Add support to Google language models.
126-
- [x] Add support to Google speech models.
127-
- [ ] Add support to Amazon language models.
128-
- [ ] Add support to Azure nlp models.
129-
- [ ] Add support to Midjourney image generation.
130-
- [ ] Add support to WuDao 2.0 model.
121+
- [x] Add support to OpenAI Completion.
122+
- [x] Add support to OpenAI DALL·E 2.
123+
- [ ] Add support to other OpenAI functions.
124+
- [x] Add support to cohere generate API.
125+
- [ ] Add support to Google language models.
126+
- [x] Add support to Google speech models.
127+
- [ ] Add support to Amazon language models.
128+
- [ ] Add support to Azure nlp models.
129+
- [ ] Add support to Midjourney image generation.
130+
- [ ] Add support to WuDao 2.0 model.
131131

132132

133133
# License

‎javadocs/allclasses-index.html‎

Lines changed: 105 additions & 52 deletions
Large diffs are not rendered by default.

‎javadocs/allpackages-index.html‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>All Packages (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>All Packages (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="package index">
1010
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
1111
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -58,14 +58,16 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
5858
<div class="table-header col-last">Description</div>
5959
<div class="col-first even-row-color"><a href="com/intellijava/core/controller/package-summary.html">com.intellijava.core.controller</a></div>
6060
<div class="col-last even-row-color">&nbsp;</div>
61-
<div class="col-first odd-row-color"><a href="com/intellijava/core/model/package-summary.html">com.intellijava.core.model</a></div>
61+
<div class="col-first odd-row-color"><a href="com/intellijava/core/function/package-summary.html">com.intellijava.core.function</a></div>
6262
<div class="col-last odd-row-color">&nbsp;</div>
63-
<div class="col-first even-row-color"><a href="com/intellijava/core/model/input/package-summary.html">com.intellijava.core.model.input</a></div>
63+
<div class="col-first even-row-color"><a href="com/intellijava/core/model/package-summary.html">com.intellijava.core.model</a></div>
6464
<div class="col-last even-row-color">&nbsp;</div>
65-
<div class="col-first odd-row-color"><a href="com/intellijava/core/utils/package-summary.html">com.intellijava.core.utils</a></div>
65+
<div class="col-first odd-row-color"><a href="com/intellijava/core/model/input/package-summary.html">com.intellijava.core.model.input</a></div>
6666
<div class="col-last odd-row-color">&nbsp;</div>
67-
<div class="col-first even-row-color"><a href="com/intellijava/core/wrappers/package-summary.html">com.intellijava.core.wrappers</a></div>
67+
<div class="col-first even-row-color"><a href="com/intellijava/core/utils/package-summary.html">com.intellijava.core.utils</a></div>
6868
<div class="col-last even-row-color">&nbsp;</div>
69+
<div class="col-first odd-row-color"><a href="com/intellijava/core/wrappers/package-summary.html">com.intellijava.core.wrappers</a></div>
70+
<div class="col-last odd-row-color">&nbsp;</div>
6971
</div>
7072
</main>
7173
<footer role="contentinfo">

‎javadocs/com/intellijava/core/controller/RemoteImageModel.html‎

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>RemoteImageModel (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>RemoteImageModel (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="declaration: package: com.intellijava.core.controller, class: RemoteImageModel">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -96,6 +96,7 @@ <h1 title="Class RemoteImageModel" class="title">Class RemoteImageModel</h1>
9696
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
9797
<div class="block">The RemoteImageModel class is used to generate images from text descriptions using an API key.
9898
It currently supports OpenAI only.
99+
99100
The class uses the OpenAIWrapper to generate the images and returns a list of URLs for the generated images.</div>
100101
<dl class="notes">
101102
<dt>Author:</dt>
@@ -112,11 +113,16 @@ <h2>Constructor Summary</h2>
112113
<div class="summary-table two-column-summary">
113114
<div class="table-header col-first">Constructor</div>
114115
<div class="table-header col-last">Description</div>
115-
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">RemoteImageModel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyValue,
116-
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyType)</code></div>
116+
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,com.intellijava.core.model.SupportedImageModels)" class="member-name-link">RemoteImageModel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyValue,
117+
<a href="../model/SupportedImageModels.html" title="enum in com.intellijava.core.model">SupportedImageModels</a>&nbsp;keyType)</code></div>
117118
<div class="col-last even-row-color">
118119
<div class="block">Constructor for creating a new RemoteImageModel object.</div>
119120
</div>
121+
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">RemoteImageModel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyValue,
122+
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyTypeString)</code></div>
123+
<div class="col-last odd-row-color">
124+
<div class="block">Constructor for creating a new RemoteImageModel object.</div>
125+
</div>
120126
</div>
121127
</section>
122128
</li>
@@ -136,6 +142,11 @@ <h2>Method Summary</h2>
136142
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
137143
<div class="block">Generates images from a given text description.</div>
138144
</div>
145+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
146+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSupportedModels()" class="member-name-link">getSupportedModels</a>()</code></div>
147+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
148+
<div class="block">Get the supported models names as array of string</div>
149+
</div>
139150
</div>
140151
</div>
141152
</div>
@@ -157,19 +168,34 @@ <h2>Constructor Details</h2>
157168
<section class="detail" id="&lt;init&gt;(java.lang.String,java.lang.String)">
158169
<h3>RemoteImageModel</h3>
159170
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RemoteImageModel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyValue,
160-
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyType)</span></div>
171+
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyTypeString)</span></div>
161172
<div class="block">Constructor for creating a new RemoteImageModel object.
162173

163-
Creates an instance of the class and sets up the API key and the key type.</div>
174+
Creates an instance of the class and set the API key value and type.</div>
164175
<dl class="notes">
165176
<dt>Parameters:</dt>
166177
<dd><code>keyValue</code> - the API key.</dd>
167-
<dd><code>keyType</code> - support openai only.</dd>
178+
<dd><code>keyTypeString</code> - support openai only.</dd>
168179
<dt>Throws:</dt>
169180
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the keyType passed is not "openai".</dd>
170181
</dl>
171182
</section>
172183
</li>
184+
<li>
185+
<section class="detail" id="&lt;init&gt;(java.lang.String,com.intellijava.core.model.SupportedImageModels)">
186+
<h3>RemoteImageModel</h3>
187+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RemoteImageModel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyValue,
188+
<a href="../model/SupportedImageModels.html" title="enum in com.intellijava.core.model">SupportedImageModels</a>&nbsp;keyType)</span></div>
189+
<div class="block">Constructor for creating a new RemoteImageModel object.
190+
191+
Creates an instance of the class and set the API key value and type.</div>
192+
<dl class="notes">
193+
<dt>Parameters:</dt>
194+
<dd><code>keyValue</code> - the API key.</dd>
195+
<dd><code>keyType</code> - the model type from SupportedImageModels enum.</dd>
196+
</dl>
197+
</section>
198+
</li>
173199
</ul>
174200
</section>
175201
</li>
@@ -179,6 +205,17 @@ <h3>RemoteImageModel</h3>
179205
<h2>Method Details</h2>
180206
<ul class="member-list">
181207
<li>
208+
<section class="detail" id="getSupportedModels()">
209+
<h3>getSupportedModels</h3>
210+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getSupportedModels</span>()</div>
211+
<div class="block">Get the supported models names as array of string</div>
212+
<dl class="notes">
213+
<dt>Returns:</dt>
214+
<dd>supportedModels</dd>
215+
</dl>
216+
</section>
217+
</li>
218+
<li>
182219
<section class="detail" id="generateImages(com.intellijava.core.model.input.ImageModelInput)">
183220
<h3>generateImages</h3>
184221
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">generateImages</span><wbr><span class="parameters">(<a href="../model/input/ImageModelInput.html" title="class in com.intellijava.core.model.input">ImageModelInput</a>&nbsp;imageInput)</span>

‎javadocs/com/intellijava/core/controller/RemoteLanguageModel.html‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>RemoteLanguageModel (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>RemoteLanguageModel (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="declaration: package: com.intellijava.core.controller, class: RemoteLanguageModel">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -183,7 +183,7 @@ <h3>RemoteLanguageModel</h3>
183183
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;keyTypeString)</span></div>
184184
<div class="block">Constructor for the RemoteLanguageModel class.
185185

186-
Creates an instance of the class and sets up the key and the API type.</div>
186+
Creates an instance of the class and set the API type and key.</div>
187187
<dl class="notes">
188188
<dt>Parameters:</dt>
189189
<dd><code>keyValue</code> - the API key.</dd>
@@ -201,8 +201,7 @@ <h3>RemoteLanguageModel</h3>
201201
<a href="../model/SupportedLangModels.html" title="enum in com.intellijava.core.model">SupportedLangModels</a>&nbsp;keyType)</span></div>
202202
<div class="block">Constructor for the RemoteLanguageModel class.
203203

204-
Creates an instance of the class and sets up the API key and the enum key
205-
type.</div>
204+
Creates an instance of the class and set the API enum type and key.</div>
206205
<dl class="notes">
207206
<dt>Parameters:</dt>
208207
<dd><code>keyValue</code> - the API key.</dd>

‎javadocs/com/intellijava/core/controller/RemoteSpeechModel.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>RemoteSpeechModel (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>RemoteSpeechModel (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="declaration: package: com.intellijava.core.controller, class: RemoteSpeechModel">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -143,7 +143,7 @@ <h2>Method Summary</h2>
143143
<div class="table-header col-second">Method</div>
144144
<div class="table-header col-last">Description</div>
145145
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div>
146-
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateEnglishText(com.intellijava.core.model.input.SpeechInput)" class="member-name-link">generateEnglishText</a><wbr>(<a href="../model/input/SpeechInput.html" title="class in com.intellijava.core.model.input">SpeechInput</a>&nbsp;input)</code></div>
146+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateEnglishText(com.intellijava.core.model.input.Text2SpeechInput)" class="member-name-link">generateEnglishText</a><wbr>(<a href="../model/input/Text2SpeechInput.html" title="class in com.intellijava.core.model.input">Text2SpeechInput</a>&nbsp;input)</code></div>
147147
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
148148
<div class="block">Generates speech from text using the support models.</div>
149149
</div>
@@ -216,9 +216,9 @@ <h3>getSupportedModels</h3>
216216
</section>
217217
</li>
218218
<li>
219-
<section class="detail" id="generateEnglishText(com.intellijava.core.model.input.SpeechInput)">
219+
<section class="detail" id="generateEnglishText(com.intellijava.core.model.input.Text2SpeechInput)">
220220
<h3>generateEnglishText</h3>
221-
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">generateEnglishText</span><wbr><span class="parameters">(<a href="../model/input/SpeechInput.html" title="class in com.intellijava.core.model.input">SpeechInput</a>&nbsp;input)</span>
221+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">generateEnglishText</span><wbr><span class="parameters">(<a href="../model/input/Text2SpeechInput.html" title="class in com.intellijava.core.model.input">Text2SpeechInput</a>&nbsp;input)</span>
222222
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
223223
<div class="block">Generates speech from text using the support models.
224224

‎javadocs/com/intellijava/core/controller/class-use/RemoteImageModel.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>Uses of Class com.intellijava.core.controller.RemoteImageModel (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>Uses of Class com.intellijava.core.controller.RemoteImageModel (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="use: package: com.intellijava.core.controller, class: RemoteImageModel">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

‎javadocs/com/intellijava/core/controller/class-use/RemoteLanguageModel.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
4-
<!-- Generated by javadoc (19) on Sat Feb 18 00:06:40 GMT 2023 -->
5-
<title>Uses of Class com.intellijava.core.controller.RemoteLanguageModel (Intellijava 0.7.0 API)</title>
4+
<!-- Generated by javadoc (19) on Sat Mar 04 12:40:22 GMT 2023 -->
5+
<title>Uses of Class com.intellijava.core.controller.RemoteLanguageModel (Intellijava 0.8.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-02-18">
8+
<meta name="dc.created" content="2023-03-04">
99
<meta name="description" content="use: package: com.intellijava.core.controller, class: RemoteLanguageModel">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

0 commit comments

Comments
 (0)