Skip to content

Commit 39a723f

Browse files
geoandgeoand
committed
Fix docs
1 parent bf48500 commit 39a723f

8 files changed

+636
-20
lines changed

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

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-enabled[`quarkus.langchain4j.docling.devservices.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.langchain4j.docling.devservices.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
If DevServices has been explicitly enabled or disabled. DevServices are generally enabled by default, unless there is an existing configuration present.
19+
20+
When DevServices is enabled, Quarkus will attempt to automatically configure and start a Docling server when running in Dev or Test mode.
21+
22+
23+
ifdef::add-copy-button-to-env-var[]
24+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_ENABLED+++[]
25+
endif::add-copy-button-to-env-var[]
26+
ifndef::add-copy-button-to-env-var[]
27+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_ENABLED+++`
28+
endif::add-copy-button-to-env-var[]
29+
--
30+
|boolean
31+
|`true`
32+
33+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-image-name[`quarkus.langchain4j.docling.devservices.image-name`]##
34+
ifdef::add-copy-button-to-config-props[]
35+
config_property_copy_button:+++quarkus.langchain4j.docling.devservices.image-name+++[]
36+
endif::add-copy-button-to-config-props[]
37+
38+
39+
[.description]
40+
--
41+
The container image name to use.
42+
43+
44+
ifdef::add-copy-button-to-env-var[]
45+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_IMAGE_NAME+++[]
46+
endif::add-copy-button-to-env-var[]
47+
ifndef::add-copy-button-to-env-var[]
48+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_IMAGE_NAME+++`
49+
endif::add-copy-button-to-env-var[]
50+
--
51+
|string
52+
|`quay.io/docling-project/docling-serve:latest`
53+
54+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-enable-ui]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-enable-ui[`quarkus.langchain4j.docling.devservices.enable-ui`]##
55+
ifdef::add-copy-button-to-config-props[]
56+
config_property_copy_button:+++quarkus.langchain4j.docling.devservices.enable-ui+++[]
57+
endif::add-copy-button-to-config-props[]
58+
59+
60+
[.description]
61+
--
62+
Whether or not to enable the docling UI
63+
64+
See https://github.com/docling-project/docling-serve?tab=readme-ov-file++#++demonstration-ui
65+
66+
67+
ifdef::add-copy-button-to-env-var[]
68+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_ENABLE_UI+++[]
69+
endif::add-copy-button-to-env-var[]
70+
ifndef::add-copy-button-to-env-var[]
71+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_ENABLE_UI+++`
72+
endif::add-copy-button-to-env-var[]
73+
--
74+
|boolean
75+
|`true`
76+
77+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-container-env-container-env]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-devservices-container-env-container-env[`quarkus.langchain4j.docling.devservices.container-env."container-env"`]##
78+
ifdef::add-copy-button-to-config-props[]
79+
config_property_copy_button:+++quarkus.langchain4j.docling.devservices.container-env."container-env"+++[]
80+
endif::add-copy-button-to-config-props[]
81+
82+
83+
[.description]
84+
--
85+
Environment variables that are passed to the container
86+
87+
88+
ifdef::add-copy-button-to-env-var[]
89+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++[]
90+
endif::add-copy-button-to-env-var[]
91+
ifndef::add-copy-button-to-env-var[]
92+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++`
93+
endif::add-copy-button-to-env-var[]
94+
--
95+
|Map<String,String>
96+
|
97+
98+
a| [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-base-url]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-base-url[`quarkus.langchain4j.docling.base-url`]##
99+
ifdef::add-copy-button-to-config-props[]
100+
config_property_copy_button:+++quarkus.langchain4j.docling.base-url+++[]
101+
endif::add-copy-button-to-config-props[]
102+
103+
104+
[.description]
105+
--
106+
The default base url of where docling is
107+
108+
109+
ifdef::add-copy-button-to-env-var[]
110+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_BASE_URL+++[]
111+
endif::add-copy-button-to-env-var[]
112+
ifndef::add-copy-button-to-env-var[]
113+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_BASE_URL+++`
114+
endif::add-copy-button-to-env-var[]
115+
--
116+
|string
117+
|
118+
119+
a| [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-timeout]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-timeout[`quarkus.langchain4j.docling.timeout`]##
120+
ifdef::add-copy-button-to-config-props[]
121+
config_property_copy_button:+++quarkus.langchain4j.docling.timeout+++[]
122+
endif::add-copy-button-to-config-props[]
123+
124+
125+
[.description]
126+
--
127+
Timeout for Docling calls
128+
129+
130+
ifdef::add-copy-button-to-env-var[]
131+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_TIMEOUT+++[]
132+
endif::add-copy-button-to-env-var[]
133+
ifndef::add-copy-button-to-env-var[]
134+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_TIMEOUT+++`
135+
endif::add-copy-button-to-env-var[]
136+
--
137+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-langchain4j-docling_quarkus-langchain4j[icon:question-circle[title=More information about the Duration format]]
138+
|`1m`
139+
140+
a| [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-log-requests]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-log-requests[`quarkus.langchain4j.docling.log-requests`]##
141+
ifdef::add-copy-button-to-config-props[]
142+
config_property_copy_button:+++quarkus.langchain4j.docling.log-requests+++[]
143+
endif::add-copy-button-to-config-props[]
144+
145+
146+
[.description]
147+
--
148+
Whether the Docling client should log requests
149+
150+
151+
ifdef::add-copy-button-to-env-var[]
152+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_LOG_REQUESTS+++[]
153+
endif::add-copy-button-to-env-var[]
154+
ifndef::add-copy-button-to-env-var[]
155+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_LOG_REQUESTS+++`
156+
endif::add-copy-button-to-env-var[]
157+
--
158+
|boolean
159+
|`false`
160+
161+
a| [[quarkus-langchain4j-docling_quarkus-langchain4j-docling-log-responses]] [.property-path]##link:#quarkus-langchain4j-docling_quarkus-langchain4j-docling-log-responses[`quarkus.langchain4j.docling.log-responses`]##
162+
ifdef::add-copy-button-to-config-props[]
163+
config_property_copy_button:+++quarkus.langchain4j.docling.log-responses+++[]
164+
endif::add-copy-button-to-config-props[]
165+
166+
167+
[.description]
168+
--
169+
Whether the Docling client should log responses
170+
171+
172+
ifdef::add-copy-button-to-env-var[]
173+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DOCLING_LOG_RESPONSES+++[]
174+
endif::add-copy-button-to-env-var[]
175+
ifndef::add-copy-button-to-env-var[]
176+
Environment variable: `+++QUARKUS_LANGCHAIN4J_DOCLING_LOG_RESPONSES+++`
177+
endif::add-copy-button-to-env-var[]
178+
--
179+
|boolean
180+
|`false`
181+
182+
|===
183+
184+
ifndef::no-duration-note[]
185+
[NOTE]
186+
[id=duration-note-anchor-quarkus-langchain4j-docling_quarkus-langchain4j]
187+
.About the Duration format
188+
====
189+
To write duration values, use the standard `java.time.Duration` format.
190+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
191+
192+
You can also use a simplified format, starting with a number:
193+
194+
* If the value is only a number, it represents time in seconds.
195+
* If the value is a number followed by `ms`, it represents time in milliseconds.
196+
197+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
198+
199+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
200+
* If the value is a number followed by `d`, it is prefixed with `P`.
201+
====
202+
endif::no-duration-note[]

0 commit comments

Comments
 (0)