Skip to content

Commit 6332daf

Browse files
geoandgeoand
committed
Fix docs
1 parent 4426476 commit 6332daf

File tree

2 files changed

+157
-4
lines changed

2 files changed

+157
-4
lines changed

‎docs/modules/ROOT/pages/includes/quarkus-langchain4j-huggingface.adoc‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,57 @@ h|[[quarkus-langchain4j-huggingface_configuration]]link:#quarkus-langchain4j-hug
1010
h|Type
1111
h|Default
1212

13+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.enabled]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.enabled[quarkus.langchain4j.huggingface.chat-model.enabled]`
14+
15+
16+
[.description]
17+
--
18+
Whether the model should be enabled
19+
20+
ifdef::add-copy-button-to-env-var[]
21+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_ENABLED+++[]
22+
endif::add-copy-button-to-env-var[]
23+
ifndef::add-copy-button-to-env-var[]
24+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_ENABLED+++`
25+
endif::add-copy-button-to-env-var[]
26+
--|boolean
27+
|`true`
28+
29+
30+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.embedding-model.enabled]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.embedding-model.enabled[quarkus.langchain4j.huggingface.embedding-model.enabled]`
31+
32+
33+
[.description]
34+
--
35+
Whether the model should be enabled
36+
37+
ifdef::add-copy-button-to-env-var[]
38+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++[]
39+
endif::add-copy-button-to-env-var[]
40+
ifndef::add-copy-button-to-env-var[]
41+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++`
42+
endif::add-copy-button-to-env-var[]
43+
--|boolean
44+
|`true`
45+
46+
47+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.moderation-model.enabled]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.moderation-model.enabled[quarkus.langchain4j.huggingface.moderation-model.enabled]`
48+
49+
50+
[.description]
51+
--
52+
Whether the model should be enabled
53+
54+
ifdef::add-copy-button-to-env-var[]
55+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_MODERATION_MODEL_ENABLED+++[]
56+
endif::add-copy-button-to-env-var[]
57+
ifndef::add-copy-button-to-env-var[]
58+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_MODERATION_MODEL_ENABLED+++`
59+
endif::add-copy-button-to-env-var[]
60+
--|boolean
61+
|`true`
62+
63+
1364
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.api-key]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.api-key[quarkus.langchain4j.huggingface.api-key]`
1465

1566

@@ -135,6 +186,74 @@ endif::add-copy-button-to-env-var[]
135186
|`true`
136187

137188

189+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.do-sample]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.do-sample[quarkus.langchain4j.huggingface.chat-model.do-sample]`
190+
191+
192+
[.description]
193+
--
194+
Whether or not to use sampling ; use greedy decoding otherwise.
195+
196+
ifdef::add-copy-button-to-env-var[]
197+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++[]
198+
endif::add-copy-button-to-env-var[]
199+
ifndef::add-copy-button-to-env-var[]
200+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++`
201+
endif::add-copy-button-to-env-var[]
202+
--|boolean
203+
|
204+
205+
206+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.top-k]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.top-k[quarkus.langchain4j.huggingface.chat-model.top-k]`
207+
208+
209+
[.description]
210+
--
211+
The number of highest probability vocabulary tokens to keep for top-k-filtering.
212+
213+
ifdef::add-copy-button-to-env-var[]
214+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++[]
215+
endif::add-copy-button-to-env-var[]
216+
ifndef::add-copy-button-to-env-var[]
217+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++`
218+
endif::add-copy-button-to-env-var[]
219+
--|int
220+
|
221+
222+
223+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.top-p]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.top-p[quarkus.langchain4j.huggingface.chat-model.top-p]`
224+
225+
226+
[.description]
227+
--
228+
If set to less than `1`, only the most probable tokens with probabilities that add up to `top_p` or higher are kept for generation.
229+
230+
ifdef::add-copy-button-to-env-var[]
231+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++[]
232+
endif::add-copy-button-to-env-var[]
233+
ifndef::add-copy-button-to-env-var[]
234+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++`
235+
endif::add-copy-button-to-env-var[]
236+
--|double
237+
|
238+
239+
240+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.repetition-penalty]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.chat-model.repetition-penalty[quarkus.langchain4j.huggingface.chat-model.repetition-penalty]`
241+
242+
243+
[.description]
244+
--
245+
The parameter for repetition penalty. 1.0 means no penalty. See link:https://arxiv.org/pdf/1909.05858.pdf[this paper] for more details.
246+
247+
ifdef::add-copy-button-to-env-var[]
248+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++[]
249+
endif::add-copy-button-to-env-var[]
250+
ifndef::add-copy-button-to-env-var[]
251+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++`
252+
endif::add-copy-button-to-env-var[]
253+
--|double
254+
|
255+
256+
138257
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.embedding-model.inference-endpoint-url]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.embedding-model.inference-endpoint-url[quarkus.langchain4j.huggingface.embedding-model.inference-endpoint-url]`
139258

140259

@@ -173,6 +292,40 @@ endif::add-copy-button-to-env-var[]
173292
--|boolean
174293
|`true`
175294

295+
296+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.log-requests]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.log-requests[quarkus.langchain4j.huggingface.log-requests]`
297+
298+
299+
[.description]
300+
--
301+
Whether the OpenAI client should log requests
302+
303+
ifdef::add-copy-button-to-env-var[]
304+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++[]
305+
endif::add-copy-button-to-env-var[]
306+
ifndef::add-copy-button-to-env-var[]
307+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++`
308+
endif::add-copy-button-to-env-var[]
309+
--|boolean
310+
|`false`
311+
312+
313+
a| [[quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.log-responses]]`link:#quarkus-langchain4j-huggingface_quarkus.langchain4j.huggingface.log-responses[quarkus.langchain4j.huggingface.log-responses]`
314+
315+
316+
[.description]
317+
--
318+
Whether the OpenAI client should log responses
319+
320+
ifdef::add-copy-button-to-env-var[]
321+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++[]
322+
endif::add-copy-button-to-env-var[]
323+
ifndef::add-copy-button-to-env-var[]
324+
Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++`
325+
endif::add-copy-button-to-env-var[]
326+
--|boolean
327+
|`false`
328+
176329
|===
177330
ifndef::no-duration-note[]
178331
[NOTE]

‎docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,21 +78,21 @@ endif::add-copy-button-to-env-var[]
7878
|
7979

8080

81-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-redis_quarkus.langchain4j.redis.metric-type]]`link:#quarkus-langchain4j-redis_quarkus.langchain4j.redis.metric-type[quarkus.langchain4j.redis.metric-type]`
81+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-redis_quarkus.langchain4j.redis.distance-metric]]`link:#quarkus-langchain4j-redis_quarkus.langchain4j.redis.distance-metric[quarkus.langchain4j.redis.distance-metric]`
8282

8383

8484
[.description]
8585
--
8686
Metric used to compute the distance between two vectors.
8787

8888
ifdef::add-copy-button-to-env-var[]
89-
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_METRIC_TYPE+++[]
89+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++[]
9090
endif::add-copy-button-to-env-var[]
9191
ifndef::add-copy-button-to-env-var[]
92-
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_METRIC_TYPE+++`
92+
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++`
9393
endif::add-copy-button-to-env-var[]
9494
-- a|
95-
`cosine`, `ip`, `l2`
95+
`l2`, `ip`, `cosine`
9696
|`cosine`
9797

9898

0 commit comments

Comments
 (0)