Skip to content

Commit

Permalink
Merge pull request #1017 from gsmet/new-config-doc-maven-plugin
Browse files Browse the repository at this point in the history
Switch config doc generation to the new plugin introduced in 3.14
  • Loading branch information
geoand authored Oct 30, 2024
2 parents 8c7758d + fea477c commit c458c3f
Show file tree
Hide file tree
Showing 52 changed files with 20,649 additions and 1,514 deletions.
280 changes: 140 additions & 140 deletions docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,688 changes: 1,688 additions & 0 deletions docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai.adoc

Large diffs are not rendered by default.

Large diffs are not rendered by default.

121 changes: 61 additions & 60 deletions docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma.adoc
Original file line number Diff line number Diff line change
@@ -1,72 +1,69 @@

:summaryTableId: quarkus-langchain4j-chroma
:summaryTableId: quarkus-langchain4j-chroma_quarkus-langchain4j
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[quarkus-langchain4j-chroma_configuration]]link:#quarkus-langchain4j-chroma_configuration[Configuration property]

h|[.header-title]##Configuration property##
h|Type
h|Default

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]`

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`]##

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

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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
--
|boolean
|`true`


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]`

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`]##

[.description]
--
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`.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++`
endif::add-copy-button-to-env-var[]
--|string
--
|string
|`ghcr.io/chroma-core/chroma:0.4.15`


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]`

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`]##

[.description]
--
Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++`
endif::add-copy-button-to-env-var[]
--|int
--
|int
|


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]`

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`]##

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

Container sharing is only used in dev mode.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++`
endif::add-copy-button-to-env-var[]
--|boolean
--
|boolean
|`true`


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]`

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`]##

[.description]
--
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.

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


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++`
endif::add-copy-button-to-env-var[]
--|string
--
|string
|`chroma`

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"`]##

[.description]
--
Environment variables that are passed to the container.


a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[quarkus.langchain4j.chroma.url]`
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++`
endif::add-copy-button-to-env-var[]
--
|Map<String,String>
|

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

[.description]
--
URL where the Chroma database is listening for requests


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++`
endif::add-copy-button-to-env-var[]
--|string
--
|string
|required icon:exclamation-circle[title=Configuration property is required]


a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[quarkus.langchain4j.chroma.collection-name]`

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`]##

[.description]
--
The collection name.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++`
endif::add-copy-button-to-env-var[]
--|string
--
|string
|`default`


a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[quarkus.langchain4j.chroma.timeout]`

a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[`quarkus.langchain4j.chroma.timeout`]##

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


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
--
|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]]
|


a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[quarkus.langchain4j.chroma.log-requests]`

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`]##

[.description]
--
Whether requests to Chroma should be logged


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++`
endif::add-copy-button-to-env-var[]
--|boolean
--
|boolean
|`false`


a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[quarkus.langchain4j.chroma.log-responses]`

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`]##

[.description]
--
Whether responses from Chroma should be logged


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


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]`


[.description]
--
Environment variables that are passed to the container.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++`
endif::add-copy-button-to-env-var[]
--|`Map<String,String>`
|
|boolean
|`false`

|===

ifndef::no-duration-note[]
[NOTE]
[id='duration-note-anchor-{summaryTableId}']
[id=duration-note-anchor-quarkus-langchain4j-chroma_quarkus-langchain4j]
.About the Duration format
====
To write duration values, use the standard `java.time.Duration` format.
Expand All @@ -227,3 +226,5 @@ In other cases, the simplified format is translated to the `java.time.Duration`
* If the value is a number followed by `d`, it is prefixed with `P`.
====
endif::no-duration-note[]
:!summaryTableId:
Loading

0 comments on commit c458c3f

Please sign in to comment.