Skip to content

Commit c458c3f

Browse files
authored
Merge pull request quarkiverse#1017 from gsmet/new-config-doc-maven-plugin
Switch config doc generation to the new plugin introduced in 3.14
2 parents 8c7758d + fea477c commit c458c3f

File tree

52 files changed

+20649
-1514
lines changed

Some content is hidden

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

52 files changed

+20649
-1514
lines changed

docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc

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

docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic_quarkus.langchain4j.adoc

Lines changed: 611 additions & 0 deletions
Large diffs are not rendered by default.

docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai.adoc

Lines changed: 1688 additions & 0 deletions
Large diffs are not rendered by default.

docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai_quarkus.langchain4j.adoc

Lines changed: 1688 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 61 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,69 @@
1-
2-
:summaryTableId: quarkus-langchain4j-chroma
1+
:summaryTableId: quarkus-langchain4j-chroma_quarkus-langchain4j
32
[.configuration-legend]
43
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
54
[.configuration-reference.searchable, cols="80,.^10,.^10"]
65
|===
76

8-
h|[[quarkus-langchain4j-chroma_configuration]]link:#quarkus-langchain4j-chroma_configuration[Configuration property]
9-
7+
h|[.header-title]##Configuration property##
108
h|Type
119
h|Default
1210

13-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled[quarkus.langchain4j.chroma.devservices.enabled]`
14-
11+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled[`quarkus.langchain4j.chroma.devservices.enabled`]##
1512

1613
[.description]
1714
--
1815
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.
1916

2017
When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.
2118

19+
2220
ifdef::add-copy-button-to-env-var[]
2321
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++[]
2422
endif::add-copy-button-to-env-var[]
2523
ifndef::add-copy-button-to-env-var[]
2624
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++`
2725
endif::add-copy-button-to-env-var[]
28-
--|boolean
26+
--
27+
|boolean
2928
|`true`
3029

31-
32-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name[quarkus.langchain4j.chroma.devservices.image-name]`
33-
30+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name[`quarkus.langchain4j.chroma.devservices.image-name`]##
3431

3532
[.description]
3633
--
3734
The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack:latest`.
3835

36+
3937
ifdef::add-copy-button-to-env-var[]
4038
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++[]
4139
endif::add-copy-button-to-env-var[]
4240
ifndef::add-copy-button-to-env-var[]
4341
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++`
4442
endif::add-copy-button-to-env-var[]
45-
--|string
43+
--
44+
|string
4645
|`ghcr.io/chroma-core/chroma:0.4.15`
4746

48-
49-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port[quarkus.langchain4j.chroma.devservices.port]`
50-
47+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port[`quarkus.langchain4j.chroma.devservices.port`]##
5148

5249
[.description]
5350
--
5451
Optional fixed port the dev service will listen to.
5552

5653
If not defined, the port will be chosen randomly.
5754

55+
5856
ifdef::add-copy-button-to-env-var[]
5957
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++[]
6058
endif::add-copy-button-to-env-var[]
6159
ifndef::add-copy-button-to-env-var[]
6260
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++`
6361
endif::add-copy-button-to-env-var[]
64-
--|int
62+
--
63+
|int
6564
|
6665

67-
68-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared[quarkus.langchain4j.chroma.devservices.shared]`
69-
66+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared[`quarkus.langchain4j.chroma.devservices.shared`]##
7067

7168
[.description]
7269
--
@@ -76,141 +73,143 @@ The discovery uses the `quarkus-dev-service-chroma` label. The value is configur
7673

7774
Container sharing is only used in dev mode.
7875

76+
7977
ifdef::add-copy-button-to-env-var[]
8078
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++[]
8179
endif::add-copy-button-to-env-var[]
8280
ifndef::add-copy-button-to-env-var[]
8381
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++`
8482
endif::add-copy-button-to-env-var[]
85-
--|boolean
83+
--
84+
|boolean
8685
|`true`
8786

88-
89-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name[quarkus.langchain4j.chroma.devservices.service-name]`
90-
87+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name[`quarkus.langchain4j.chroma.devservices.service-name`]##
9188

9289
[.description]
9390
--
9491
The value of the `quarkus-dev-service-chroma` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-chroma` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-chroma` label set to the specified value.
9592

9693
This property is used when you need multiple shared Chroma servers.
9794

95+
9896
ifdef::add-copy-button-to-env-var[]
9997
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++[]
10098
endif::add-copy-button-to-env-var[]
10199
ifndef::add-copy-button-to-env-var[]
102100
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++`
103101
endif::add-copy-button-to-env-var[]
104-
--|string
102+
--
103+
|string
105104
|`chroma`
106105

106+
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env[`quarkus.langchain4j.chroma.devservices.container-env."container-env"`]##
107+
108+
[.description]
109+
--
110+
Environment variables that are passed to the container.
111+
107112

108-
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[quarkus.langchain4j.chroma.url]`
113+
ifdef::add-copy-button-to-env-var[]
114+
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++[]
115+
endif::add-copy-button-to-env-var[]
116+
ifndef::add-copy-button-to-env-var[]
117+
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++`
118+
endif::add-copy-button-to-env-var[]
119+
--
120+
|Map<String,String>
121+
|
109122

123+
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[`quarkus.langchain4j.chroma.url`]##
110124

111125
[.description]
112126
--
113127
URL where the Chroma database is listening for requests
114128

129+
115130
ifdef::add-copy-button-to-env-var[]
116131
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++[]
117132
endif::add-copy-button-to-env-var[]
118133
ifndef::add-copy-button-to-env-var[]
119134
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++`
120135
endif::add-copy-button-to-env-var[]
121-
--|string
136+
--
137+
|string
122138
|required icon:exclamation-circle[title=Configuration property is required]
123139

124-
125-
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[quarkus.langchain4j.chroma.collection-name]`
126-
140+
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[`quarkus.langchain4j.chroma.collection-name`]##
127141

128142
[.description]
129143
--
130144
The collection name.
131145

146+
132147
ifdef::add-copy-button-to-env-var[]
133148
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++[]
134149
endif::add-copy-button-to-env-var[]
135150
ifndef::add-copy-button-to-env-var[]
136151
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++`
137152
endif::add-copy-button-to-env-var[]
138-
--|string
153+
--
154+
|string
139155
|`default`
140156

141-
142-
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[quarkus.langchain4j.chroma.timeout]`
143-
157+
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[`quarkus.langchain4j.chroma.timeout`]##
144158

145159
[.description]
146160
--
147161
The timeout duration for the Chroma client. If not specified, 5 seconds will be used.
148162

163+
149164
ifdef::add-copy-button-to-env-var[]
150165
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++[]
151166
endif::add-copy-button-to-env-var[]
152167
ifndef::add-copy-button-to-env-var[]
153168
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++`
154169
endif::add-copy-button-to-env-var[]
155-
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
156-
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
170+
--
171+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
157172
|
158173

159-
160-
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[quarkus.langchain4j.chroma.log-requests]`
161-
174+
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[`quarkus.langchain4j.chroma.log-requests`]##
162175

163176
[.description]
164177
--
165178
Whether requests to Chroma should be logged
166179

180+
167181
ifdef::add-copy-button-to-env-var[]
168182
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++[]
169183
endif::add-copy-button-to-env-var[]
170184
ifndef::add-copy-button-to-env-var[]
171185
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++`
172186
endif::add-copy-button-to-env-var[]
173-
--|boolean
187+
--
188+
|boolean
174189
|`false`
175190

176-
177-
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[quarkus.langchain4j.chroma.log-responses]`
178-
191+
a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[`quarkus.langchain4j.chroma.log-responses`]##
179192

180193
[.description]
181194
--
182195
Whether responses from Chroma should be logged
183196

197+
184198
ifdef::add-copy-button-to-env-var[]
185199
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++[]
186200
endif::add-copy-button-to-env-var[]
187201
ifndef::add-copy-button-to-env-var[]
188202
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++`
189203
endif::add-copy-button-to-env-var[]
190-
--|boolean
191-
|`false`
192-
193-
194-
a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env[quarkus.langchain4j.chroma.devservices.container-env]`
195-
196-
197-
[.description]
198204
--
199-
Environment variables that are passed to the container.
200-
201-
ifdef::add-copy-button-to-env-var[]
202-
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++[]
203-
endif::add-copy-button-to-env-var[]
204-
ifndef::add-copy-button-to-env-var[]
205-
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++`
206-
endif::add-copy-button-to-env-var[]
207-
--|`Map<String,String>`
208-
|
205+
|boolean
206+
|`false`
209207

210208
|===
209+
211210
ifndef::no-duration-note[]
212211
[NOTE]
213-
[id='duration-note-anchor-{summaryTableId}']
212+
[id=duration-note-anchor-quarkus-langchain4j-chroma_quarkus-langchain4j]
214213
.About the Duration format
215214
====
216215
To write duration values, use the standard `java.time.Duration` format.
@@ -227,3 +226,5 @@ In other cases, the simplified format is translated to the `java.time.Duration`
227226
* If the value is a number followed by `d`, it is prefixed with `P`.
228227
====
229228
endif::no-duration-note[]
229+
230+
:!summaryTableId:

0 commit comments

Comments
 (0)