Skip to content

Commit

Permalink
Update Quarkus to 3.15.2 and update documentation
Browse files Browse the repository at this point in the history
It is important as it includes a fix for enum handling in the doc.
  • Loading branch information
gsmet committed Nov 18, 2024
1 parent 55c9c69 commit eef1f77
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 395 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|Type
a|`message-window`, `token-window`
|`message-window`

a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled[`quarkus.langchain4j.devservices.enabled`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|Type
a|`message-window`, `token-window`
|`message-window`

a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled[`quarkus.langchain4j.devservices.enabled`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++`
endif::add-copy-button-to-env-var[]
--
a|IngestionStrategy
a|`on`, `off`, `manual`
|`on`

a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled[`quarkus.langchain4j.easy-rag.reuse-embeddings.enabled`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++`
endif::add-copy-button-to-env-var[]
--
a|IngestionStrategy
a|`on`, `off`, `manual`
|`on`

a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled[`quarkus.langchain4j.easy-rag.reuse-embeddings.enabled`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|IndexType
a|`none`, `flat`, `ivf-flat`, `ivf-sq8`, `ivf-pq`, `hnsw`, `diskann`, `autoindex`, `scann`, `gpu-ivf-flat`, `gpu-ivf-pq`, `bin-flat`, `bin-ivf-flat`, `trie`, `stl-sort`
|`flat`

a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type[`quarkus.langchain4j.milvus.metric-type`]##
Expand All @@ -345,7 +345,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|MetricType
a|`none`, `l2`, `ip`, `cosine`, `hamming`, `jaccard`
|`cosine`

a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level[`quarkus.langchain4j.milvus.consistency-level`]##
Expand All @@ -362,7 +362,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++`
endif::add-copy-button-to-env-var[]
--
a|ConsistencyLevelEnum
a|`strong`, `bounded`, `eventually`
|`eventually`

|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|IndexType
a|`none`, `flat`, `ivf-flat`, `ivf-sq8`, `ivf-pq`, `hnsw`, `diskann`, `autoindex`, `scann`, `gpu-ivf-flat`, `gpu-ivf-pq`, `bin-flat`, `bin-ivf-flat`, `trie`, `stl-sort`
|`flat`

a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type[`quarkus.langchain4j.milvus.metric-type`]##
Expand All @@ -345,7 +345,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++`
endif::add-copy-button-to-env-var[]
--
a|MetricType
a|`none`, `l2`, `ip`, `cosine`, `hamming`, `jaccard`
|`cosine`

a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level[`quarkus.langchain4j.milvus.consistency-level`]##
Expand All @@ -362,7 +362,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++`
endif::add-copy-button-to-env-var[]
--
a|ConsistencyLevelEnum
a|`strong`, `bounded`, `eventually`
|`eventually`

|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++`
endif::add-copy-button-to-env-var[]
--
a|MetadataStorageMode
a|`column-per-key`, `combined-json`, `combined-jsonb`
|`combined-json`

a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions[`quarkus.langchain4j.pgvector.metadata.column-definitions`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++`
endif::add-copy-button-to-env-var[]
--
a|MetadataStorageMode
a|`column-per-key`, `combined-json`, `combined-jsonb`
|`combined-json`

a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions[`quarkus.langchain4j.pgvector.metadata.column-definitions`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++`
endif::add-copy-button-to-env-var[]
--
a|Distance
a|`unknown-distance`, `cosine`, `euclid`, `dot`, `manhattan`
|required icon:exclamation-circle[title=Configuration property is required]

a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.size`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++`
endif::add-copy-button-to-env-var[]
--
a|Distance
a|`unknown-distance`, `cosine`, `euclid`, `dot`, `manhattan`
|required icon:exclamation-circle[title=Configuration property is required]

a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.size`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++`
endif::add-copy-button-to-env-var[]
--
a|DistanceMetric
a|`l2`, `ip`, `cosine`
|`cosine`

a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name[`quarkus.langchain4j.redis.vector-field-name`]##
Expand Down Expand Up @@ -177,7 +177,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++`
endif::add-copy-button-to-env-var[]
--
a|VectorAlgorithm
a|`flat`, `hnsw`
|`hnsw`

|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++`
endif::add-copy-button-to-env-var[]
--
a|DistanceMetric
a|`l2`, `ip`, `cosine`
|`cosine`

a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name[`quarkus.langchain4j.redis.vector-field-name`]##
Expand Down Expand Up @@ -177,7 +177,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++`
endif::add-copy-button-to-env-var[]
--
a|VectorAlgorithm
a|`flat`, `hnsw`
|`hnsw`

|===
Expand Down
189 changes: 1 addition & 188 deletions docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,194 +124,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_SEARCH_DEPTH+++`
endif::add-copy-button-to-env-var[]
--
a|SearchDepth
|`basic`

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer[`quarkus.langchain4j.tavily.include-answer`]##

[.description]
--
Include a short answer to original query. Default is false.


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-raw-content]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-raw-content[`quarkus.langchain4j.tavily.include-raw-content`]##

[.description]
--
Include the cleaned and parsed HTML content of each search result. Default is false.


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-domains]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-domains[`quarkus.langchain4j.tavily.include-domains`]##

[.description]
--
A list of domains to specifically include in the search results. Default is ++[]++, which includes all domains.


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains[`quarkus.langchain4j.tavily.exclude-domains`]##

[.description]
--
A list of domains to specifically exclude from the search results. Default is ++[]++, which doesn't exclude any domains.


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-base-url]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-base-url[`quarkus.langchain4j.tavily.base-url`]##

[.description]
--
Base URL of the Tavily API


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TAVILY_BASE_URL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_BASE_URL+++`
endif::add-copy-button-to-env-var[]
--
|string
|`https://api.tavily.com`

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-api-key]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-api-key[`quarkus.langchain4j.tavily.api-key`]##

[.description]
--
API key for the Tavily API


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-max-results]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-max-results[`quarkus.langchain4j.tavily.max-results`]##

[.description]
--
Maximum number of results to return


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-timeout]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-timeout[`quarkus.langchain4j.tavily.timeout`]##

[.description]
--
The timeout duration for Tavily requests.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TAVILY_TIMEOUT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_TIMEOUT+++`
endif::add-copy-button-to-env-var[]
--
|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]]
|`60S`

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-requests]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-requests[`quarkus.langchain4j.tavily.log-requests`]##

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


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-responses]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-responses[`quarkus.langchain4j.tavily.log-responses`]##

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


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

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-search-depth]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-search-depth[`quarkus.langchain4j.tavily.search-depth`]##

[.description]
--
The search depth to use. This can be "basic" or "advanced". Basic is the default.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TAVILY_SEARCH_DEPTH+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_SEARCH_DEPTH+++`
endif::add-copy-button-to-env-var[]
--
a|SearchDepth
a|`basic`, `advanced`
|`basic`

a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer[`quarkus.langchain4j.tavily.include-answer`]##
Expand Down
Loading

0 comments on commit eef1f77

Please sign in to comment.