From c8cf51ca516c982b3c3058787836805ee0e19d5d Mon Sep 17 00:00:00 2001 From: Georgios Andrianakis Date: Fri, 1 Nov 2024 08:06:41 +0200 Subject: [PATCH] Update docs --- .../includes/quarkus-langchain4j-bam.adoc | 556 +++++++++--------- .../quarkus-langchain4j-easy-rag.adoc | 17 + ...gchain4j-easy-rag_quarkus.langchain4j.adoc | 17 + .../includes/quarkus-langchain4j-jlama.adoc | 292 ++++----- .../includes/quarkus-langchain4j-tavily.adoc | 187 ++++++ ...angchain4j-tavily_quarkus.langchain4j.adoc | 187 ++++++ .../includes/quarkus-langchain4j-watsonx.adoc | 8 +- ...ngchain4j-watsonx_quarkus.langchain4j.adoc | 8 +- 8 files changed, 843 insertions(+), 429 deletions(-) diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-bam.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-bam.adoc index 606305edc..0218ee7c0 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-bam.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-bam.adoc @@ -1,206 +1,201 @@ - -:summaryTableId: quarkus-langchain4j-bam +:summaryTableId: quarkus-langchain4j-bam_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-bam_configuration]]link:#quarkus-langchain4j-bam_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-enabled]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-enabled[quarkus.langchain4j.bam.chat-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-enabled[`quarkus.langchain4j.bam.chat-model.enabled`]## [.description] -- Whether the chat model should be enabled + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-enabled]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-enabled[quarkus.langchain4j.bam.embedding-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-enabled[`quarkus.langchain4j.bam.embedding-model.enabled`]## [.description] -- Whether the embedding model should be enabled + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-enabled]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-enabled[quarkus.langchain4j.bam.moderation-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-enabled[`quarkus.langchain4j.bam.moderation-model.enabled`]## [.description] -- Whether the model should be enabled + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-base-url]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-base-url[quarkus.langchain4j.bam.base-url]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-base-url]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-base-url[`quarkus.langchain4j.bam.base-url`]## [.description] -- Base URL where the BAM serving is running + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URL.html[URL] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] |`https://bam-api.res.ibm.com` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-api-key]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-api-key[quarkus.langchain4j.bam.api-key]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-api-key]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-api-key[`quarkus.langchain4j.bam.api-key`]## [.description] -- BAM API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-timeout]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-timeout[quarkus.langchain4j.bam.timeout]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-timeout]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-timeout[`quarkus.langchain4j.bam.timeout`]## [.description] -- Timeout for BAM calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_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]] |`10s` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-version]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-version[quarkus.langchain4j.bam.version]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-version]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-version[`quarkus.langchain4j.bam.version`]## [.description] -- Version to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_VERSION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`2024-04-15` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-requests[quarkus.langchain4j.bam.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-requests[`quarkus.langchain4j.bam.log-requests`]## [.description] -- Whether the BAM client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-responses[quarkus.langchain4j.bam.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-log-responses[`quarkus.langchain4j.bam.log-responses`]## [.description] -- Whether the BAM client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-enable-integration]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-enable-integration[quarkus.langchain4j.bam.enable-integration]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-enable-integration]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-enable-integration[`quarkus.langchain4j.bam.enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the BAM provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-model-id]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-model-id[quarkus.langchain4j.bam.chat-model.model-id]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-model-id[`quarkus.langchain4j.bam.chat-model.model-id`]## [.description] -- Model to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ibm/granite-13b-chat-v2` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-decoding-method]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-decoding-method[quarkus.langchain4j.bam.chat-model.decoding-method]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-decoding-method[`quarkus.langchain4j.bam.chat-model.decoding-method`]## [.description] -- @@ -208,342 +203,341 @@ Represents the strategy used for picking the tokens during generation of the out During text generation when parameter value is set to greedy, each successive token corresponds to the highest probability token given the text that has already been generated. This strategy can lead to repetitive results especially for longer output sequences. The alternative sample strategy generates text by picking subsequent tokens based on the probability distribution of possible next tokens defined by (i.e., conditioned on) the already-generated text and the top_k and top_p parameters described below. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_DECODING_METHOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_DECODING_METHOD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`greedy` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-include-stop-sequence]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-include-stop-sequence[quarkus.langchain4j.bam.chat-model.include-stop-sequence]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-include-stop-sequence[`quarkus.langchain4j.bam.chat-model.include-stop-sequence`]## [.description] -- Pass false to omit matched stop sequences from the end of the output text. The default is currently true meaning that the output will end with the stop sequence text when matched. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-temperature]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-temperature[quarkus.langchain4j.bam.chat-model.temperature]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-temperature[`quarkus.langchain4j.bam.chat-model.temperature`]## [.description] -- A value used to modify the next-token probabilities in sampling mode. Values less than 1.0 sharpen the probability distribution, resulting in "less random" output. Values greater than 1.0 flatten the probability distribution, resulting in "more random" output. A value of 1.0 has no effect and is the default. The allowed range is 0.0 to 2.0. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-min-new-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-min-new-tokens[quarkus.langchain4j.bam.chat-model.min-new-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-min-new-tokens[`quarkus.langchain4j.bam.chat-model.min-new-tokens`]## [.description] -- If stop sequences are given, they are ignored until minimum tokens are generated. Defaults to 0. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MIN_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MIN_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`0` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-max-new-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-max-new-tokens[quarkus.langchain4j.bam.chat-model.max-new-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-max-new-tokens[`quarkus.langchain4j.bam.chat-model.max-new-tokens`]## [.description] -- The maximum number of new tokens to be generated. The range is 0 to 1024. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MAX_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_MAX_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`200` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-random-seed]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-random-seed[quarkus.langchain4j.bam.chat-model.random-seed]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-random-seed[`quarkus.langchain4j.bam.chat-model.random-seed`]## [.description] -- Random number generator seed to use in sampling mode for experimental repeatability. Must be >= 1. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_RANDOM_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_RANDOM_SEED+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-stop-sequences]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-stop-sequences[quarkus.langchain4j.bam.chat-model.stop-sequences]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-stop-sequences[`quarkus.langchain4j.bam.chat-model.stop-sequences`]## [.description] -- Stop sequences are one or more strings which will cause the text generation to stop if/when they are produced as part of the output. Stop sequences encountered prior to the minimum number of tokens being generated will be ignored. The list may contain up to 6 strings. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_STOP_SEQUENCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_STOP_SEQUENCES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-time-limit]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-time-limit[quarkus.langchain4j.bam.chat-model.time-limit]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-time-limit]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-time-limit[`quarkus.langchain4j.bam.chat-model.time-limit`]## [.description] -- Time limit in milliseconds - if not completed within this time, generation will stop. The text generated so far will be returned along with the time_limit stop reason. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TIME_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TIME_LIMIT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-k]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-k[quarkus.langchain4j.bam.chat-model.top-k]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-k[`quarkus.langchain4j.bam.chat-model.top-k`]## [.description] -- The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for sampling mode, with range from 1 to 100. When decoding_strategy is set to sample, only the top_k most likely tokens are considered as candidates for the next generated token. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-p]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-p[quarkus.langchain4j.bam.chat-model.top-p]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-top-p[`quarkus.langchain4j.bam.chat-model.top-p`]## [.description] -- Similar to top_k except the candidates to generate the next token are the most likely tokens with probabilities that add up to at least top_p. The valid range is 0.0 to 1.0 where 1.0 is equivalent to disabled and is the default. Also known as nucleus sampling. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-typical-p]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-typical-p[quarkus.langchain4j.bam.chat-model.typical-p]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-typical-p]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-typical-p[`quarkus.langchain4j.bam.chat-model.typical-p`]## [.description] -- Local typicality measures how similar the conditional probability of predicting a target token next is to the expected conditional probability of predicting a random token next, given the partial text already generated. If set to float < 1, the smallest set of the most locally typical tokens with probabilities that add up to typical_p or higher are kept for generation. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TYPICAL_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TYPICAL_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-repetition-penalty]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-repetition-penalty[quarkus.langchain4j.bam.chat-model.repetition-penalty]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-repetition-penalty[`quarkus.langchain4j.bam.chat-model.repetition-penalty`]## [.description] -- Represents the penalty for penalizing tokens that have already been generated or belong to the context. The range is 1.0 to 2.0 and defaults to 1.0 (no penalty). + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_REPETITION_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_REPETITION_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-truncate-input-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-truncate-input-tokens[quarkus.langchain4j.bam.chat-model.truncate-input-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-truncate-input-tokens[`quarkus.langchain4j.bam.chat-model.truncate-input-tokens`]## [.description] -- Represents the number to which input tokens would be truncated. Can be used to avoid requests failing due to input being longer than configured limits. Zero means don't truncate. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-beam-width]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-beam-width[quarkus.langchain4j.bam.chat-model.beam-width]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-beam-width]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-beam-width[`quarkus.langchain4j.bam.chat-model.beam-width`]## [.description] -- Multiple output sequences of tokens are generated, using your decoding selection, and then the output sequence with the highest overall probability is returned. When beam search is enabled, there will be a performance penalty, and Stop sequences will not be available. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_BEAM_WIDTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_BEAM_WIDTH+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-requests[quarkus.langchain4j.bam.chat-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-requests[`quarkus.langchain4j.bam.chat-model.log-requests`]## [.description] -- Whether the BAM chat model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-responses[quarkus.langchain4j.bam.chat-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-chat-model-log-responses[`quarkus.langchain4j.bam.chat-model.log-responses`]## [.description] -- Whether the BAM chat model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-model-id]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-model-id[quarkus.langchain4j.bam.embedding-model.model-id]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-model-id[`quarkus.langchain4j.bam.embedding-model.model-id`]## [.description] -- Model to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ibm/slate.125m.english.rtrvr` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-requests[quarkus.langchain4j.bam.embedding-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-requests[`quarkus.langchain4j.bam.embedding-model.log-requests`]## [.description] -- Whether the BAM embedding model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-responses[quarkus.langchain4j.bam.embedding-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-embedding-model-log-responses[`quarkus.langchain4j.bam.embedding-model.log-responses`]## [.description] -- Whether the BAM embedding model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-messages-to-moderate]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-messages-to-moderate[quarkus.langchain4j.bam.moderation-model.messages-to-moderate]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-messages-to-moderate]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-messages-to-moderate[`quarkus.langchain4j.bam.moderation-model.messages-to-moderate`]## [.description] -- What types of messages are subject to moderation checks. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_MESSAGES_TO_MODERATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_MESSAGES_TO_MODERATE+++` endif::add-copy-button-to-env-var[] --- a|list of -`system`, `user`, `ai`, `tool-execution-result` +-- +a|list of ChatMessageType |`user` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-hap]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-hap[quarkus.langchain4j.bam.moderation-model.hap]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-hap]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-hap[`quarkus.langchain4j.bam.moderation-model.hap`]## [.description] -- @@ -551,18 +545,18 @@ The HAP detector is intended to identify hateful, abusive, and/or profane langua The float is a value from 0.1 to 1 that allows you to control when a content must be flagged by the detector. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_HAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_HAP+++` endif::add-copy-button-to-env-var[] ---|float +-- +|float | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-social-bias]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-social-bias[quarkus.langchain4j.bam.moderation-model.social-bias]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-social-bias]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-social-bias[`quarkus.langchain4j.bam.moderation-model.social-bias`]## [.description] -- @@ -570,195 +564,192 @@ The social bias detector is intended to identify subtle forms of hate speech and The float is a value from 0.1 to 1 that allows you to control when a content must be flagged by the detector. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_SOCIAL_BIAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_SOCIAL_BIAS+++` endif::add-copy-button-to-env-var[] ---|float +-- +|float | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-requests[quarkus.langchain4j.bam.moderation-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-requests[`quarkus.langchain4j.bam.moderation-model.log-requests`]## [.description] -- Whether the BAM moderation model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-responses[quarkus.langchain4j.bam.moderation-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-moderation-model-log-responses[`quarkus.langchain4j.bam.moderation-model.log-responses`]## [.description] -- Whether the BAM moderation model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM_MODERATION_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -h|[[quarkus-langchain4j-bam_quarkus-langchain4j-bam-named-config-named-model-config]]link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-named-config-named-model-config[Named model config] - +h|[[quarkus-langchain4j-bam_section_quarkus-langchain4j-bam]] [.section-name.section-level0]##link:#quarkus-langchain4j-bam_section_quarkus-langchain4j-bam[Named model config]## h|Type h|Default -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-base-url]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-base-url[quarkus.langchain4j.bam."model-name".base-url]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-base-url[`quarkus.langchain4j.bam."model-name".base-url`]## [.description] -- Base URL where the BAM serving is running + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URL.html[URL] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] |`https://bam-api.res.ibm.com` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-api-key]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-api-key[quarkus.langchain4j.bam."model-name".api-key]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-api-key[`quarkus.langchain4j.bam."model-name".api-key`]## [.description] -- BAM API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-timeout]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-timeout[quarkus.langchain4j.bam."model-name".timeout]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-timeout[`quarkus.langchain4j.bam."model-name".timeout`]## [.description] -- Timeout for BAM calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__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]] |`10s` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-version]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-version[quarkus.langchain4j.bam."model-name".version]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-version]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-version[`quarkus.langchain4j.bam."model-name".version`]## [.description] -- Version to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__VERSION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`2024-04-15` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-requests[quarkus.langchain4j.bam."model-name".log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-requests[`quarkus.langchain4j.bam."model-name".log-requests`]## [.description] -- Whether the BAM client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-responses[quarkus.langchain4j.bam."model-name".log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-log-responses[`quarkus.langchain4j.bam."model-name".log-responses`]## [.description] -- Whether the BAM client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-enable-integration]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-enable-integration[quarkus.langchain4j.bam."model-name".enable-integration]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-enable-integration[`quarkus.langchain4j.bam."model-name".enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the BAM provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-model-id]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-model-id[quarkus.langchain4j.bam."model-name".chat-model.model-id]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-model-id[`quarkus.langchain4j.bam."model-name".chat-model.model-id`]## [.description] -- Model to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ibm/granite-13b-chat-v2` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-decoding-method]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-decoding-method[quarkus.langchain4j.bam."model-name".chat-model.decoding-method]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-decoding-method[`quarkus.langchain4j.bam."model-name".chat-model.decoding-method`]## [.description] -- @@ -766,342 +757,341 @@ Represents the strategy used for picking the tokens during generation of the out During text generation when parameter value is set to greedy, each successive token corresponds to the highest probability token given the text that has already been generated. This strategy can lead to repetitive results especially for longer output sequences. The alternative sample strategy generates text by picking subsequent tokens based on the probability distribution of possible next tokens defined by (i.e., conditioned on) the already-generated text and the top_k and top_p parameters described below. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_DECODING_METHOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_DECODING_METHOD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`greedy` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-include-stop-sequence]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-include-stop-sequence[quarkus.langchain4j.bam."model-name".chat-model.include-stop-sequence]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-include-stop-sequence[`quarkus.langchain4j.bam."model-name".chat-model.include-stop-sequence`]## [.description] -- Pass false to omit matched stop sequences from the end of the output text. The default is currently true meaning that the output will end with the stop sequence text when matched. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-temperature[quarkus.langchain4j.bam."model-name".chat-model.temperature]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-temperature[`quarkus.langchain4j.bam."model-name".chat-model.temperature`]## [.description] -- A value used to modify the next-token probabilities in sampling mode. Values less than 1.0 sharpen the probability distribution, resulting in "less random" output. Values greater than 1.0 flatten the probability distribution, resulting in "more random" output. A value of 1.0 has no effect and is the default. The allowed range is 0.0 to 2.0. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-min-new-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-min-new-tokens[quarkus.langchain4j.bam."model-name".chat-model.min-new-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-min-new-tokens[`quarkus.langchain4j.bam."model-name".chat-model.min-new-tokens`]## [.description] -- If stop sequences are given, they are ignored until minimum tokens are generated. Defaults to 0. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MIN_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MIN_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`0` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-max-new-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-max-new-tokens[quarkus.langchain4j.bam."model-name".chat-model.max-new-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-max-new-tokens[`quarkus.langchain4j.bam."model-name".chat-model.max-new-tokens`]## [.description] -- The maximum number of new tokens to be generated. The range is 0 to 1024. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`200` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-random-seed]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-random-seed[quarkus.langchain4j.bam."model-name".chat-model.random-seed]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-random-seed[`quarkus.langchain4j.bam."model-name".chat-model.random-seed`]## [.description] -- Random number generator seed to use in sampling mode for experimental repeatability. Must be >= 1. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-stop-sequences]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-stop-sequences[quarkus.langchain4j.bam."model-name".chat-model.stop-sequences]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-stop-sequences[`quarkus.langchain4j.bam."model-name".chat-model.stop-sequences`]## [.description] -- Stop sequences are one or more strings which will cause the text generation to stop if/when they are produced as part of the output. Stop sequences encountered prior to the minimum number of tokens being generated will be ignored. The list may contain up to 6 strings. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-time-limit]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-time-limit[quarkus.langchain4j.bam."model-name".chat-model.time-limit]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-time-limit]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-time-limit[`quarkus.langchain4j.bam."model-name".chat-model.time-limit`]## [.description] -- Time limit in milliseconds - if not completed within this time, generation will stop. The text generated so far will be returned along with the time_limit stop reason. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TIME_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TIME_LIMIT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-k]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-k[quarkus.langchain4j.bam."model-name".chat-model.top-k]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-k[`quarkus.langchain4j.bam."model-name".chat-model.top-k`]## [.description] -- The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for sampling mode, with range from 1 to 100. When decoding_strategy is set to sample, only the top_k most likely tokens are considered as candidates for the next generated token. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-p]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-p[quarkus.langchain4j.bam."model-name".chat-model.top-p]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-top-p[`quarkus.langchain4j.bam."model-name".chat-model.top-p`]## [.description] -- Similar to top_k except the candidates to generate the next token are the most likely tokens with probabilities that add up to at least top_p. The valid range is 0.0 to 1.0 where 1.0 is equivalent to disabled and is the default. Also known as nucleus sampling. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-typical-p]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-typical-p[quarkus.langchain4j.bam."model-name".chat-model.typical-p]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-typical-p]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-typical-p[`quarkus.langchain4j.bam."model-name".chat-model.typical-p`]## [.description] -- Local typicality measures how similar the conditional probability of predicting a target token next is to the expected conditional probability of predicting a random token next, given the partial text already generated. If set to float < 1, the smallest set of the most locally typical tokens with probabilities that add up to typical_p or higher are kept for generation. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TYPICAL_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TYPICAL_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-repetition-penalty]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-repetition-penalty[quarkus.langchain4j.bam."model-name".chat-model.repetition-penalty]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-repetition-penalty[`quarkus.langchain4j.bam."model-name".chat-model.repetition-penalty`]## [.description] -- Represents the penalty for penalizing tokens that have already been generated or belong to the context. The range is 1.0 to 2.0 and defaults to 1.0 (no penalty). + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-truncate-input-tokens]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-truncate-input-tokens[quarkus.langchain4j.bam."model-name".chat-model.truncate-input-tokens]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-truncate-input-tokens[`quarkus.langchain4j.bam."model-name".chat-model.truncate-input-tokens`]## [.description] -- Represents the number to which input tokens would be truncated. Can be used to avoid requests failing due to input being longer than configured limits. Zero means don't truncate. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-beam-width]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-beam-width[quarkus.langchain4j.bam."model-name".chat-model.beam-width]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-beam-width]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-beam-width[`quarkus.langchain4j.bam."model-name".chat-model.beam-width`]## [.description] -- Multiple output sequences of tokens are generated, using your decoding selection, and then the output sequence with the highest overall probability is returned. When beam search is enabled, there will be a performance penalty, and Stop sequences will not be available. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_BEAM_WIDTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_BEAM_WIDTH+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-requests[quarkus.langchain4j.bam."model-name".chat-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-requests[`quarkus.langchain4j.bam."model-name".chat-model.log-requests`]## [.description] -- Whether the BAM chat model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-responses[quarkus.langchain4j.bam."model-name".chat-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-chat-model-log-responses[`quarkus.langchain4j.bam."model-name".chat-model.log-responses`]## [.description] -- Whether the BAM chat model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-model-id]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-model-id[quarkus.langchain4j.bam."model-name".embedding-model.model-id]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-model-id[`quarkus.langchain4j.bam."model-name".embedding-model.model-id`]## [.description] -- Model to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ibm/slate.125m.english.rtrvr` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-requests[quarkus.langchain4j.bam."model-name".embedding-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-requests[`quarkus.langchain4j.bam."model-name".embedding-model.log-requests`]## [.description] -- Whether the BAM embedding model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-responses[quarkus.langchain4j.bam."model-name".embedding-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-embedding-model-log-responses[`quarkus.langchain4j.bam."model-name".embedding-model.log-responses`]## [.description] -- Whether the BAM embedding model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-messages-to-moderate]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-messages-to-moderate[quarkus.langchain4j.bam."model-name".moderation-model.messages-to-moderate]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-messages-to-moderate]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-messages-to-moderate[`quarkus.langchain4j.bam."model-name".moderation-model.messages-to-moderate`]## [.description] -- What types of messages are subject to moderation checks. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_MESSAGES_TO_MODERATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_MESSAGES_TO_MODERATE+++` endif::add-copy-button-to-env-var[] --- a|list of -`system`, `user`, `ai`, `tool-execution-result` +-- +a|list of ChatMessageType |`user` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-hap]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-hap[quarkus.langchain4j.bam."model-name".moderation-model.hap]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-hap]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-hap[`quarkus.langchain4j.bam."model-name".moderation-model.hap`]## [.description] -- @@ -1109,18 +1099,18 @@ The HAP detector is intended to identify hateful, abusive, and/or profane langua The float is a value from 0.1 to 1 that allows you to control when a content must be flagged by the detector. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_HAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_HAP+++` endif::add-copy-button-to-env-var[] ---|float +-- +|float | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-social-bias]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-social-bias[quarkus.langchain4j.bam."model-name".moderation-model.social-bias]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-social-bias]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-social-bias[`quarkus.langchain4j.bam."model-name".moderation-model.social-bias`]## [.description] -- @@ -1128,53 +1118,57 @@ The social bias detector is intended to identify subtle forms of hate speech and The float is a value from 0.1 to 1 that allows you to control when a content must be flagged by the detector. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_SOCIAL_BIAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_SOCIAL_BIAS+++` endif::add-copy-button-to-env-var[] ---|float +-- +|float | - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-requests]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-requests[quarkus.langchain4j.bam."model-name".moderation-model.log-requests]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-requests[`quarkus.langchain4j.bam."model-name".moderation-model.log-requests`]## [.description] -- Whether the BAM moderation model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-responses]]`link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-responses[quarkus.langchain4j.bam."model-name".moderation-model.log-responses]` - +a| [[quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-bam_quarkus-langchain4j-bam-model-name-moderation-model-log-responses[`quarkus.langchain4j.bam."model-name".moderation-model.log-responses`]## [.description] -- Whether the BAM moderation model should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_BAM__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-bam_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1191,3 +1185,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: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc index 1d95c1ec4..89fdb9ca0 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc @@ -110,6 +110,23 @@ endif::add-copy-button-to-env-var[] |int |`5` +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-min-score]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-min-score[`quarkus.langchain4j.easy-rag.min-score`]## + +[.description] +-- +The minimum score for results to return when querying the retrieval augmentor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MIN_SCORE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MIN_SCORE+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy[`quarkus.langchain4j.easy-rag.ingestion-strategy`]## [.description] diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc index 1d95c1ec4..89fdb9ca0 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc @@ -110,6 +110,23 @@ endif::add-copy-button-to-env-var[] |int |`5` +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-min-score]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-min-score[`quarkus.langchain4j.easy-rag.min-score`]## + +[.description] +-- +The minimum score for results to return when querying the retrieval augmentor. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MIN_SCORE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MIN_SCORE+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy[`quarkus.langchain4j.easy-rag.ingestion-strategy`]## [.description] diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-jlama.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-jlama.adoc index 0dc890176..c95f01a64 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-jlama.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-jlama.adoc @@ -1,21 +1,36 @@ - -:summaryTableId: quarkus-langchain4j-jlama +:summaryTableId: quarkus-langchain4j-jlama_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-jlama_configuration]]link:#quarkus-langchain4j-jlama_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-enabled]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-enabled[quarkus.langchain4j.jlama.chat-model.enabled]` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-include-models-in-artifact]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-include-models-in-artifact[`quarkus.langchain4j.jlama.include-models-in-artifact`]## + +[.description] +-- +Determines whether the necessary Jlama models are downloaded and included in the jar at build time. Currently, this option is only valid for `fast-jar` deployments. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_INCLUDE_MODELS_IN_ARTIFACT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_INCLUDE_MODELS_IN_ARTIFACT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-enabled[`quarkus.langchain4j.jlama.chat-model.enabled`]## [.description] -- -Whether the chat model should be enabled +Whether the model should be enabled + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_ENABLED+++[] @@ -23,16 +38,16 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-enabled]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-enabled[quarkus.langchain4j.jlama.embedding-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-enabled[`quarkus.langchain4j.jlama.embedding-model.enabled`]## [.description] -- -Whether the embedding model should be enabled +Whether the model should be enabled + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_ENABLED+++[] @@ -40,16 +55,16 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-model-name]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-model-name[quarkus.langchain4j.jlama.chat-model.model-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-model-name[`quarkus.langchain4j.jlama.chat-model.model-name`]## [.description] -- -Chat model to use. The default value is `tjake/granite-3.0-2b-instruct-JQ4` +Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_MODEL_NAME+++[] @@ -57,267 +72,262 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string -|`tjake/granite-3.0-2b-instruct-JQ4` - - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-model-name]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-model-name[quarkus.langchain4j.jlama.embedding-model.model-name]` +-- +|string +|`tjake/TinyLlama-1.1B-Chat-v1.0-Jlama-Q4` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-model-name[`quarkus.langchain4j.jlama.embedding-model.model-name`]## [.description] -- -Embedding model to use. The default value is `intfloat/e5-small-v2` +Model name to use + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`intfloat/e5-small-v2` - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-requests]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-requests[quarkus.langchain4j.jlama.log-requests]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-models-path]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-models-path[`quarkus.langchain4j.jlama.models-path`]## [.description] -- -Whether the jlama requests should be logged +Location on the file-system which serves as a cache for the models + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_MODELS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_MODELS_PATH+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-responses]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-responses[quarkus.langchain4j.jlama.log-responses]` +-- +|path +|`${user.name}/.jlama/models` +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-temperature[`quarkus.langchain4j.jlama.chat-model.temperature`]## [.description] -- -Whether the jlama responses should be logged +What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + +It is generally recommended to set this or the `top-k` property but not both. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-temperature]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-temperature[quarkus.langchain4j.jlama.chat-model.temperature]` +-- +|double +|`0.3f` +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-chat-model-max-tokens[`quarkus.langchain4j.jlama.chat-model.max-tokens`]## [.description] -- -The temperature of the model. Increasing the temperature will make the model answer with more creativity. A lower temperature will make the model answer more conservatively. +The maximum number of tokens to generate in the completion. + +The token count of your prompt plus `max_tokens` cannot exceed the model's context length + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_TEMPERATURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_TEMPERATURE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|double -|`0.3` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-temperature]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-temperature[quarkus.langchain4j.jlama.embedding-model.temperature]` +-- +|int +| +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-enable-integration]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-enable-integration[`quarkus.langchain4j.jlama.enable-integration`]## [.description] -- -The temperature of the model. Increasing the temperature will make the model answer with more variability. A lower temperature will make the model answer more conservatively. +Whether to enable the integration. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_TEMPERATURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_TEMPERATURE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|double -|`0.3` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-log-requests]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-log-requests[quarkus.langchain4j.jlama.embedding-model.log-requests]` +-- +|boolean +|`true` +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-requests]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-requests[`quarkus.langchain4j.jlama.log-requests`]## [.description] -- -Whether the jlama requests should be logged +Whether Jlama should log requests + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-log-responses]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-embedding-model-log-responses[quarkus.langchain4j.jlama.embedding-model.log-responses]` - +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-responses]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-log-responses[`quarkus.langchain4j.jlama.log-responses`]## [.description] -- -Whether the jlama responses should be logged +Whether Jlama client should log responses + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -h|[[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-named-config-named-model-config]]link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-named-config-named-model-config[Named model config] - +h|[[quarkus-langchain4j-jlama_section_quarkus-langchain4j-jlama]] [.section-name.section-level0]##link:#quarkus-langchain4j-jlama_section_quarkus-langchain4j-jlama[Named model config]## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-model-name]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-model-name[quarkus.langchain4j.jlama."model-name".chat-model.model-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-model-name[`quarkus.langchain4j.jlama."model-name".chat-model.model-name`]## [.description] -- -Model to use. The default value is `tjake/granite-3.0-2b-instruct-JQ4` +Model name to use + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string -|`tjake/granite-3.0-2b-instruct-JQ4` - - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-model-name]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-model-name[quarkus.langchain4j.jlama."model-name".embedding-model.model-name]` +-- +|string +|`tjake/TinyLlama-1.1B-Chat-v1.0-Jlama-Q4` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-model-name[`quarkus.langchain4j.jlama."model-name".embedding-model.model-name`]## [.description] -- -Model to use. The default value is `intfloat/e5-small-v2` +Model name to use + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`intfloat/e5-small-v2` - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-requests]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-requests[quarkus.langchain4j.jlama."model-name".log-requests]` - +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-temperature[`quarkus.langchain4j.jlama."model-name".chat-model.temperature`]## [.description] -- -Whether the jlama requests should be logged +What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_REQUESTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_REQUESTS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` +It is generally recommended to set this or the `top-k` property but not both. -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-responses]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-responses[quarkus.langchain4j.jlama."model-name".log-responses]` - - -[.description] --- -Whether the jlama responses should be logged - ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-temperature[quarkus.langchain4j.jlama."model-name".chat-model.temperature]` +-- +|double +|`0.3f` +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-chat-model-max-tokens[`quarkus.langchain4j.jlama."model-name".chat-model.max-tokens`]## [.description] -- -The temperature of the model. Increasing the temperature will make the model answer with more creativity. A lower temperature will make the model answer more conservatively. +The maximum number of tokens to generate in the completion. + +The token count of your prompt plus `max_tokens` cannot exceed the model's context length + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|double -|`0.3` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-temperature]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-temperature[quarkus.langchain4j.jlama."model-name".embedding-model.temperature]` +-- +|int +| +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-enable-integration[`quarkus.langchain4j.jlama."model-name".enable-integration`]## [.description] -- -The temperature of the model. Increasing the temperature will make the model answer with more creativity. A lower temperature will make the model answer more conservatively. +Whether to enable the integration. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|double -|`0.3` - - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-log-requests]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-log-requests[quarkus.langchain4j.jlama."model-name".embedding-model.log-requests]` +-- +|boolean +|`true` +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-requests[`quarkus.langchain4j.jlama."model-name".log-requests`]## [.description] -- -Whether embedding model requests should be logged +Whether Jlama should log requests + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-log-responses]]`link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-embedding-model-log-responses[quarkus.langchain4j.jlama."model-name".embedding-model.log-responses]` - +a| [[quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-jlama_quarkus-langchain4j-jlama-model-name-log-responses[`quarkus.langchain4j.jlama."model-name".log-responses`]## [.description] -- -Whether embedding model responses should be logged +Whether Jlama client should log responses + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_JLAMA__MODEL_NAME__LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` + |=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc index c5fe266be..f0a0b21d5 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc @@ -185,6 +185,193 @@ a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains]] [.p 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 +|`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[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc index c5fe266be..f0a0b21d5 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc @@ -185,6 +185,193 @@ a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains]] [.p 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 +|`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[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc index 23b44ed27..958dca0b9 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc @@ -96,7 +96,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_BASE_URL+++` endif::add-copy-button-to-env-var[] -- |string -|`https://dummy.ai/api` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key[`quarkus.langchain4j.watsonx.api-key`]## @@ -115,7 +115,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_API_KEY+++` endif::add-copy-button-to-env-var[] -- |string -|`dummy` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout[`quarkus.langchain4j.watsonx.timeout`]## @@ -1008,7 +1008,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] -- |string -|`https://dummy.ai/api` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key[`quarkus.langchain4j.watsonx."model-name".api-key`]## @@ -1027,7 +1027,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++` endif::add-copy-button-to-env-var[] -- |string -|`dummy` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout[`quarkus.langchain4j.watsonx."model-name".timeout`]## diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc index 23b44ed27..958dca0b9 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc @@ -96,7 +96,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_BASE_URL+++` endif::add-copy-button-to-env-var[] -- |string -|`https://dummy.ai/api` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key[`quarkus.langchain4j.watsonx.api-key`]## @@ -115,7 +115,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_API_KEY+++` endif::add-copy-button-to-env-var[] -- |string -|`dummy` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout[`quarkus.langchain4j.watsonx.timeout`]## @@ -1008,7 +1008,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] -- |string -|`https://dummy.ai/api` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key[`quarkus.langchain4j.watsonx."model-name".api-key`]## @@ -1027,7 +1027,7 @@ Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++` endif::add-copy-button-to-env-var[] -- |string -|`dummy` +| a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout[`quarkus.langchain4j.watsonx."model-name".timeout`]##