From fea477c50cdb84ef3d611c37fbf4dde32475dd39 Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Mon, 28 Oct 2024 17:51:57 +0100 Subject: [PATCH] Switch config doc generation to the new plugin introduced in 3.14 Fixes #1016 --- .../quarkus-langchain4j-anthropic.adoc | 280 +-- ...chain4j-anthropic_quarkus.langchain4j.adoc | 611 ++++++ .../quarkus-langchain4j-azure-openai.adoc | 1688 +++++++++++++++ ...in4j-azure-openai_quarkus.langchain4j.adoc | 1688 +++++++++++++++ .../includes/quarkus-langchain4j-chroma.adoc | 121 +- ...angchain4j-chroma_quarkus.langchain4j.adoc | 230 ++ .../includes/quarkus-langchain4j-cohere.adoc | 252 ++- ...angchain4j-cohere_quarkus.langchain4j.adoc | 327 +++ .../includes/quarkus-langchain4j-core.adoc | 403 ++++ ...-langchain4j-core_quarkus.langchain4j.adoc | 403 ++++ .../quarkus-langchain4j-easy-rag.adoc | 83 +- ...gchain4j-easy-rag_quarkus.langchain4j.adoc | 169 ++ .../quarkus-langchain4j-hugging-face.adoc | 717 +++++++ ...in4j-hugging-face_quarkus.langchain4j.adoc | 717 +++++++ .../quarkus-langchain4j-infinispan.adoc | 42 +- ...hain4j-infinispan_quarkus.langchain4j.adoc | 82 + ...uarkus-langchain4j-memory-store-redis.adoc | 31 + ...emory-store-redis_quarkus.langchain4j.adoc | 31 + .../includes/quarkus-langchain4j-milvus.adoc | 390 ++++ ...angchain4j-milvus_quarkus.langchain4j.adoc | 390 ++++ .../quarkus-langchain4j-mistral-ai.adoc | 662 ++++++ ...hain4j-mistral-ai_quarkus.langchain4j.adoc | 662 ++++++ .../includes/quarkus-langchain4j-neo4j.adoc | 82 +- ...langchain4j-neo4j_quarkus.langchain4j.adoc | 173 ++ ...-langchain4j-oidc-model-auth-provider.adoc | 31 + ...del-auth-provider_quarkus.langchain4j.adoc | 31 + ...uarkus-langchain4j-ollama-devservices.adoc | 65 + ...llama-devservices_quarkus.langchain4j.adoc | 65 + .../includes/quarkus-langchain4j-ollama.adoc | 426 ++-- ...angchain4j-ollama_quarkus.langchain4j.adoc | 900 ++++++++ .../includes/quarkus-langchain4j-openai.adoc | 698 +++--- ...angchain4j-openai_quarkus.langchain4j.adoc | 1502 +++++++++++++ .../quarkus-langchain4j-openshift-ai.adoc | 327 +++ ...in4j-openshift-ai_quarkus.langchain4j.adoc | 327 +++ .../quarkus-langchain4j-pgvector.adoc | 99 +- ...gchain4j-pgvector_quarkus.langchain4j.adoc | 221 ++ .../quarkus-langchain4j-pinecone.adoc | 92 +- ...gchain4j-pinecone_quarkus.langchain4j.adoc | 203 ++ .../includes/quarkus-langchain4j-qdrant.adoc | 235 ++ ...angchain4j-qdrant_quarkus.langchain4j.adoc | 235 ++ .../includes/quarkus-langchain4j-redis.adoc | 92 +- ...langchain4j-redis_quarkus.langchain4j.adoc | 186 ++ .../includes/quarkus-langchain4j-tavily.adoc | 100 +- ...angchain4j-tavily_quarkus.langchain4j.adoc | 220 ++ .../quarkus-langchain4j-vertex-ai-gemini.adoc | 651 ++++++ ...-vertex-ai-gemini_quarkus.langchain4j.adoc | 651 ++++++ .../quarkus-langchain4j-vertex-ai.adoc | 528 +++++ ...chain4j-vertex-ai_quarkus.langchain4j.adoc | 528 +++++ .../includes/quarkus-langchain4j-watsonx.adoc | 1577 ++++++++++---- ...ngchain4j-watsonx_quarkus.langchain4j.adoc | 1905 +++++++++++++++++ docs/pom.xml | 29 +- pom.xml | 5 + 52 files changed, 20649 insertions(+), 1514 deletions(-) create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-core.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-core_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai_quarkus.langchain4j.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc index ffaaf397b..462cd19fa 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic.adoc @@ -1,171 +1,167 @@ - -:summaryTableId: quarkus-langchain4j-anthropic +:summaryTableId: quarkus-langchain4j-anthropic_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-anthropic_configuration]]link:#quarkus-langchain4j-anthropic_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled[quarkus.langchain4j.anthropic.chat-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled[`quarkus.langchain4j.anthropic.chat-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_ANTHROPIC_CHAT_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url[quarkus.langchain4j.anthropic.base-url]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url[`quarkus.langchain4j.anthropic.base-url`]## [.description] -- Base URL of the Anthropic API + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://api.anthropic.com/v1/` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key[quarkus.langchain4j.anthropic.api-key]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key[`quarkus.langchain4j.anthropic.api-key`]## [.description] -- Anthropic API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version[quarkus.langchain4j.anthropic.version]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version[`quarkus.langchain4j.anthropic.version`]## [.description] -- The Anthropic version + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_VERSION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`2023-06-01` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout[quarkus.langchain4j.anthropic.timeout]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout[`quarkus.langchain4j.anthropic.timeout`]## [.description] -- Timeout for Anthropic calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_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-anthropic_quarkus-langchain4j-anthropic-log-requests]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-requests[quarkus.langchain4j.anthropic.log-requests]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-requests[`quarkus.langchain4j.anthropic.log-requests`]## [.description] -- Whether the Anthropic client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses[quarkus.langchain4j.anthropic.log-responses]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses[`quarkus.langchain4j.anthropic.log-responses`]## [.description] -- Whether the Anthropic client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration[quarkus.langchain4j.anthropic.enable-integration]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration[`quarkus.langchain4j.anthropic.enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name[quarkus.langchain4j.anthropic.chat-model.model-name]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name[`quarkus.langchain4j.anthropic.chat-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`claude-3-haiku-20240307` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature[quarkus.langchain4j.anthropic.chat-model.temperature]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature[`quarkus.langchain4j.anthropic.chat-model.temperature`]## [.description] -- @@ -173,18 +169,18 @@ What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 wi 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_ANTHROPIC_CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.7` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens[quarkus.langchain4j.anthropic.chat-model.max-tokens]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens[`quarkus.langchain4j.anthropic.chat-model.max-tokens`]## [.description] -- @@ -192,18 +188,18 @@ 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_ANTHROPIC_CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1024` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p[quarkus.langchain4j.anthropic.chat-model.top-p]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p[`quarkus.langchain4j.anthropic.chat-model.top-p`]## [.description] -- @@ -211,245 +207,243 @@ Double (0.0-1.0). Nucleus sampling, where the model considers the results of the It is generally recommended to set this or the `temperature` property but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k[quarkus.langchain4j.anthropic.chat-model.top-k]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k[`quarkus.langchain4j.anthropic.chat-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries[quarkus.langchain4j.anthropic.chat-model.max-retries]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries[`quarkus.langchain4j.anthropic.chat-model.max-retries`]## [.description] -- The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences[quarkus.langchain4j.anthropic.chat-model.stop-sequences]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences[`quarkus.langchain4j.anthropic.chat-model.stop-sequences`]## [.description] -- The custom text sequences that will cause the model to stop generating + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_STOP_SEQUENCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_STOP_SEQUENCES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests[quarkus.langchain4j.anthropic.chat-model.log-requests]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests[`quarkus.langchain4j.anthropic.chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses[quarkus.langchain4j.anthropic.chat-model.log-responses]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses[`quarkus.langchain4j.anthropic.chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -h|[[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-named-config-named-model-config]]link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-named-config-named-model-config[Named model config] - +h|[[quarkus-langchain4j-anthropic_section_quarkus-langchain4j-anthropic]] [.section-name.section-level0]##link:#quarkus-langchain4j-anthropic_section_quarkus-langchain4j-anthropic[Named model config]## h|Type h|Default -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url[quarkus.langchain4j.anthropic."model-name".base-url]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url[`quarkus.langchain4j.anthropic."model-name".base-url`]## [.description] -- Base URL of the Anthropic API + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://api.anthropic.com/v1/` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key[quarkus.langchain4j.anthropic."model-name".api-key]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key[`quarkus.langchain4j.anthropic."model-name".api-key`]## [.description] -- Anthropic API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version[quarkus.langchain4j.anthropic."model-name".version]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version[`quarkus.langchain4j.anthropic."model-name".version`]## [.description] -- The Anthropic version + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__VERSION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`2023-06-01` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout[quarkus.langchain4j.anthropic."model-name".timeout]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout[`quarkus.langchain4j.anthropic."model-name".timeout`]## [.description] -- Timeout for Anthropic calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__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-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests[quarkus.langchain4j.anthropic."model-name".log-requests]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests[`quarkus.langchain4j.anthropic."model-name".log-requests`]## [.description] -- Whether the Anthropic client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses[quarkus.langchain4j.anthropic."model-name".log-responses]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses[`quarkus.langchain4j.anthropic."model-name".log-responses`]## [.description] -- Whether the Anthropic client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration[quarkus.langchain4j.anthropic."model-name".enable-integration]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration[`quarkus.langchain4j.anthropic."model-name".enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name[quarkus.langchain4j.anthropic."model-name".chat-model.model-name]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name[`quarkus.langchain4j.anthropic."model-name".chat-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`claude-3-haiku-20240307` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature[quarkus.langchain4j.anthropic."model-name".chat-model.temperature]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature[`quarkus.langchain4j.anthropic."model-name".chat-model.temperature`]## [.description] -- @@ -457,18 +451,18 @@ What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 wi 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_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.7` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens[quarkus.langchain4j.anthropic."model-name".chat-model.max-tokens]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens[`quarkus.langchain4j.anthropic."model-name".chat-model.max-tokens`]## [.description] -- @@ -476,18 +470,18 @@ 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_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1024` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p[quarkus.langchain4j.anthropic."model-name".chat-model.top-p]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p[`quarkus.langchain4j.anthropic."model-name".chat-model.top-p`]## [.description] -- @@ -495,104 +489,108 @@ Double (0.0-1.0). Nucleus sampling, where the model considers the results of the It is generally recommended to set this or the `temperature` property but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k[quarkus.langchain4j.anthropic."model-name".chat-model.top-k]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k[`quarkus.langchain4j.anthropic."model-name".chat-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries[quarkus.langchain4j.anthropic."model-name".chat-model.max-retries]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries[`quarkus.langchain4j.anthropic."model-name".chat-model.max-retries`]## [.description] -- The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences[quarkus.langchain4j.anthropic."model-name".chat-model.stop-sequences]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences[`quarkus.langchain4j.anthropic."model-name".chat-model.stop-sequences`]## [.description] -- The custom text sequences that will cause the model to stop generating + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests[quarkus.langchain4j.anthropic."model-name".chat-model.log-requests]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests[`quarkus.langchain4j.anthropic."model-name".chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses]]`link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses[quarkus.langchain4j.anthropic."model-name".chat-model.log-responses]` - +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses[`quarkus.langchain4j.anthropic."model-name".chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_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-anthropic_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -609,3 +607,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-anthropic_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic_quarkus.langchain4j.adoc new file mode 100644 index 000000000..462cd19fa --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-anthropic_quarkus.langchain4j.adoc @@ -0,0 +1,611 @@ +:summaryTableId: quarkus-langchain4j-anthropic_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-enabled[`quarkus.langchain4j.anthropic.chat-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_ANTHROPIC_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-base-url[`quarkus.langchain4j.anthropic.base-url`]## + +[.description] +-- +Base URL of the Anthropic API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.anthropic.com/v1/` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-api-key[`quarkus.langchain4j.anthropic.api-key`]## + +[.description] +-- +Anthropic API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-version[`quarkus.langchain4j.anthropic.version`]## + +[.description] +-- +The Anthropic version + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-06-01` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-timeout[`quarkus.langchain4j.anthropic.timeout`]## + +[.description] +-- +Timeout for Anthropic calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_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]] +|`10s` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-requests[`quarkus.langchain4j.anthropic.log-requests`]## + +[.description] +-- +Whether the Anthropic client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-log-responses[`quarkus.langchain4j.anthropic.log-responses`]## + +[.description] +-- +Whether the Anthropic client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-enable-integration[`quarkus.langchain4j.anthropic.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-model-name[`quarkus.langchain4j.anthropic.chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`claude-3-haiku-20240307` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-temperature[`quarkus.langchain4j.anthropic.chat-model.temperature`]## + +[.description] +-- +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_ANTHROPIC_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-tokens[`quarkus.langchain4j.anthropic.chat-model.max-tokens`]## + +[.description] +-- +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_ANTHROPIC_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-p[`quarkus.langchain4j.anthropic.chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-top-k[`quarkus.langchain4j.anthropic.chat-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-max-retries[`quarkus.langchain4j.anthropic.chat-model.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-stop-sequences[`quarkus.langchain4j.anthropic.chat-model.stop-sequences`]## + +[.description] +-- +The custom text sequences that will cause the model to stop generating + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_STOP_SEQUENCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_STOP_SEQUENCES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-requests[`quarkus.langchain4j.anthropic.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-chat-model-log-responses[`quarkus.langchain4j.anthropic.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-anthropic_section_quarkus-langchain4j-anthropic]] [.section-name.section-level0]##link:#quarkus-langchain4j-anthropic_section_quarkus-langchain4j-anthropic[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-base-url[`quarkus.langchain4j.anthropic."model-name".base-url`]## + +[.description] +-- +Base URL of the Anthropic API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.anthropic.com/v1/` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-api-key[`quarkus.langchain4j.anthropic."model-name".api-key`]## + +[.description] +-- +Anthropic API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-version[`quarkus.langchain4j.anthropic."model-name".version`]## + +[.description] +-- +The Anthropic version + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-06-01` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-timeout[`quarkus.langchain4j.anthropic."model-name".timeout`]## + +[.description] +-- +Timeout for Anthropic calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-requests[`quarkus.langchain4j.anthropic."model-name".log-requests`]## + +[.description] +-- +Whether the Anthropic client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-log-responses[`quarkus.langchain4j.anthropic."model-name".log-responses`]## + +[.description] +-- +Whether the Anthropic client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-enable-integration[`quarkus.langchain4j.anthropic."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-model-name[`quarkus.langchain4j.anthropic."model-name".chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`claude-3-haiku-20240307` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-temperature[`quarkus.langchain4j.anthropic."model-name".chat-model.temperature`]## + +[.description] +-- +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_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-tokens[`quarkus.langchain4j.anthropic."model-name".chat-model.max-tokens`]## + +[.description] +-- +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_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-p[`quarkus.langchain4j.anthropic."model-name".chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-top-k[`quarkus.langchain4j.anthropic."model-name".chat-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-max-retries[`quarkus.langchain4j.anthropic."model-name".chat-model.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-stop-sequences[`quarkus.langchain4j.anthropic."model-name".chat-model.stop-sequences`]## + +[.description] +-- +The custom text sequences that will cause the model to stop generating + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-requests[`quarkus.langchain4j.anthropic."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-anthropic_quarkus-langchain4j-anthropic-model-name-chat-model-log-responses[`quarkus.langchain4j.anthropic."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_ANTHROPIC__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-anthropic_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-azure-openai.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai.adoc new file mode 100644 index 000000000..b33899acc --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai.adoc @@ -0,0 +1,1688 @@ +:summaryTableId: quarkus-langchain4j-azure-openai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-enabled[`quarkus.langchain4j.azure-openai.chat-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_AZURE_OPENAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-enabled[`quarkus.langchain4j.azure-openai.embedding-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_AZURE_OPENAI_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-moderation-model-enabled[`quarkus.langchain4j.azure-openai.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_AZURE_OPENAI_MODERATION_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MODERATION_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-enabled[`quarkus.langchain4j.azure-openai.image-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_AZURE_OPENAI_IMAGE_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-resource-name[`quarkus.langchain4j.azure-openai.resource-name`]## + +[.description] +-- +The name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.deployment-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-domain-name[`quarkus.langchain4j.azure-openai.domain-name`]## + +[.description] +-- +The domain name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.domain-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`openai.azure.com` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-deployment-name[`quarkus.langchain4j.azure-openai.deployment-name`]## + +[.description] +-- +The name of your model deployment. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.resource-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-endpoint[`quarkus.langchain4j.azure-openai.endpoint`]## + +[.description] +-- +The endpoint for the Azure OpenAI resource. + +If not specified, then `quarkus.langchain4j.azure-openai.resource-name`, `quarkus.langchain4j.azure-openai.domain-name` (defaults to "openai.azure.com") and `quarkus.langchain4j.azure-openai.deployment-name` are required. In this case the endpoint will be set to `https://$++{++quarkus.langchain4j.azure-openai.resource-name`.$++{++quarkus.langchain4j.azure-openai.domain-name++}++/openai/deployments/$++{++quarkus.langchain4j.azure-openai.deployment-name++}}++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-ad-token]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-ad-token[`quarkus.langchain4j.azure-openai.ad-token`]## + +[.description] +-- +The Azure AD token to use for this operation. If present, then the requests towards OpenAI will include this in the Authorization header. Note that this property overrides the functionality of `quarkus.langchain4j.azure-openai.api-key`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_AD_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_AD_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-version]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-version[`quarkus.langchain4j.azure-openai.api-version`]## + +[.description] +-- +The API version to use for this operation. This follows the YYYY-MM-DD format + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-05-15` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-key]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-key[`quarkus.langchain4j.azure-openai.api-key`]## + +[.description] +-- +Azure OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-timeout]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-timeout[`quarkus.langchain4j.azure-openai.timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_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]] +|`10s` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-max-retries]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-max-retries[`quarkus.langchain4j.azure-openai.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-requests[`quarkus.langchain4j.azure-openai.log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-responses[`quarkus.langchain4j.azure-openai.log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-enable-integration[`quarkus.langchain4j.azure-openai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-resource-name[`quarkus.langchain4j.azure-openai.chat-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-domain-name[`quarkus.langchain4j.azure-openai.chat-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-deployment-name[`quarkus.langchain4j.azure-openai.chat-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-endpoint[`quarkus.langchain4j.azure-openai.chat-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-temperature[`quarkus.langchain4j.azure-openai.chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-top-p[`quarkus.langchain4j.azure-openai.chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-max-tokens[`quarkus.langchain4j.azure-openai.chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-presence-penalty[`quarkus.langchain4j.azure-openai.chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-frequency-penalty[`quarkus.langchain4j.azure-openai.chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-requests[`quarkus.langchain4j.azure-openai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-responses[`quarkus.langchain4j.azure-openai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-response-format[`quarkus.langchain4j.azure-openai.chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-resource-name[`quarkus.langchain4j.azure-openai.embedding-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-domain-name[`quarkus.langchain4j.azure-openai.embedding-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-deployment-name[`quarkus.langchain4j.azure-openai.embedding-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-endpoint[`quarkus.langchain4j.azure-openai.embedding-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-requests[`quarkus.langchain4j.azure-openai.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-responses[`quarkus.langchain4j.azure-openai.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-resource-name[`quarkus.langchain4j.azure-openai.image-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-domain-name[`quarkus.langchain4j.azure-openai.image-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-deployment-name[`quarkus.langchain4j.azure-openai.image-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-endpoint[`quarkus.langchain4j.azure-openai.image-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-model-name[`quarkus.langchain4j.azure-openai.image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist[`quarkus.langchain4j.azure-openai.image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist-directory[`quarkus.langchain4j.azure-openai.image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-response-format[`quarkus.langchain4j.azure-openai.image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-size]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-size[`quarkus.langchain4j.azure-openai.image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-quality[`quarkus.langchain4j.azure-openai.image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-number]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-number[`quarkus.langchain4j.azure-openai.image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-style]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-style[`quarkus.langchain4j.azure-openai.image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-user]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-user[`quarkus.langchain4j.azure-openai.image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-requests[`quarkus.langchain4j.azure-openai.image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-responses[`quarkus.langchain4j.azure-openai.image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-azure-openai_section_quarkus-langchain4j-azure-openai]] [.section-name.section-level0]##link:#quarkus-langchain4j-azure-openai_section_quarkus-langchain4j-azure-openai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-resource-name[`quarkus.langchain4j.azure-openai."model-name".resource-name`]## + +[.description] +-- +The name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.deployment-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-domain-name[`quarkus.langchain4j.azure-openai."model-name".domain-name`]## + +[.description] +-- +The domain name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.domain-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`openai.azure.com` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-deployment-name[`quarkus.langchain4j.azure-openai."model-name".deployment-name`]## + +[.description] +-- +The name of your model deployment. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.resource-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-endpoint[`quarkus.langchain4j.azure-openai."model-name".endpoint`]## + +[.description] +-- +The endpoint for the Azure OpenAI resource. + +If not specified, then `quarkus.langchain4j.azure-openai.resource-name`, `quarkus.langchain4j.azure-openai.domain-name` (defaults to "openai.azure.com") and `quarkus.langchain4j.azure-openai.deployment-name` are required. In this case the endpoint will be set to `https://$++{++quarkus.langchain4j.azure-openai.resource-name`.$++{++quarkus.langchain4j.azure-openai.domain-name++}++/openai/deployments/$++{++quarkus.langchain4j.azure-openai.deployment-name++}}++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-ad-token]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-ad-token[`quarkus.langchain4j.azure-openai."model-name".ad-token`]## + +[.description] +-- +The Azure AD token to use for this operation. If present, then the requests towards OpenAI will include this in the Authorization header. Note that this property overrides the functionality of `quarkus.langchain4j.azure-openai.api-key`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__AD_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__AD_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-version]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-version[`quarkus.langchain4j.azure-openai."model-name".api-version`]## + +[.description] +-- +The API version to use for this operation. This follows the YYYY-MM-DD format + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-05-15` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-key[`quarkus.langchain4j.azure-openai."model-name".api-key`]## + +[.description] +-- +Azure OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-timeout[`quarkus.langchain4j.azure-openai."model-name".timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-max-retries]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-max-retries[`quarkus.langchain4j.azure-openai."model-name".max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-requests[`quarkus.langchain4j.azure-openai."model-name".log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-responses[`quarkus.langchain4j.azure-openai."model-name".log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-enable-integration[`quarkus.langchain4j.azure-openai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".chat-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-temperature[`quarkus.langchain4j.azure-openai."model-name".chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-top-p[`quarkus.langchain4j.azure-openai."model-name".chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-max-tokens[`quarkus.langchain4j.azure-openai."model-name".chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-presence-penalty[`quarkus.langchain4j.azure-openai."model-name".chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.azure-openai."model-name".chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-response-format[`quarkus.langchain4j.azure-openai."model-name".chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".embedding-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".image-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".image-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".image-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".image-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-model-name[`quarkus.langchain4j.azure-openai."model-name".image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist[`quarkus.langchain4j.azure-openai."model-name".image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist-directory[`quarkus.langchain4j.azure-openai."model-name".image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-response-format[`quarkus.langchain4j.azure-openai."model-name".image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-size]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-size[`quarkus.langchain4j.azure-openai."model-name".image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-quality[`quarkus.langchain4j.azure-openai."model-name".image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-number]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-number[`quarkus.langchain4j.azure-openai."model-name".image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-style]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-style[`quarkus.langchain4j.azure-openai."model-name".image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-user]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-user[`quarkus.langchain4j.azure-openai."model-name".image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-azure-openai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-azure-openai_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai_quarkus.langchain4j.adoc new file mode 100644 index 000000000..b33899acc --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-azure-openai_quarkus.langchain4j.adoc @@ -0,0 +1,1688 @@ +:summaryTableId: quarkus-langchain4j-azure-openai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-enabled[`quarkus.langchain4j.azure-openai.chat-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_AZURE_OPENAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-enabled[`quarkus.langchain4j.azure-openai.embedding-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_AZURE_OPENAI_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-moderation-model-enabled[`quarkus.langchain4j.azure-openai.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_AZURE_OPENAI_MODERATION_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MODERATION_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-enabled]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-enabled[`quarkus.langchain4j.azure-openai.image-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_AZURE_OPENAI_IMAGE_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-resource-name[`quarkus.langchain4j.azure-openai.resource-name`]## + +[.description] +-- +The name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.deployment-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-domain-name[`quarkus.langchain4j.azure-openai.domain-name`]## + +[.description] +-- +The domain name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.domain-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`openai.azure.com` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-deployment-name[`quarkus.langchain4j.azure-openai.deployment-name`]## + +[.description] +-- +The name of your model deployment. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.resource-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-endpoint[`quarkus.langchain4j.azure-openai.endpoint`]## + +[.description] +-- +The endpoint for the Azure OpenAI resource. + +If not specified, then `quarkus.langchain4j.azure-openai.resource-name`, `quarkus.langchain4j.azure-openai.domain-name` (defaults to "openai.azure.com") and `quarkus.langchain4j.azure-openai.deployment-name` are required. In this case the endpoint will be set to `https://$++{++quarkus.langchain4j.azure-openai.resource-name`.$++{++quarkus.langchain4j.azure-openai.domain-name++}++/openai/deployments/$++{++quarkus.langchain4j.azure-openai.deployment-name++}}++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-ad-token]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-ad-token[`quarkus.langchain4j.azure-openai.ad-token`]## + +[.description] +-- +The Azure AD token to use for this operation. If present, then the requests towards OpenAI will include this in the Authorization header. Note that this property overrides the functionality of `quarkus.langchain4j.azure-openai.api-key`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_AD_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_AD_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-version]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-version[`quarkus.langchain4j.azure-openai.api-version`]## + +[.description] +-- +The API version to use for this operation. This follows the YYYY-MM-DD format + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-05-15` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-key]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-api-key[`quarkus.langchain4j.azure-openai.api-key`]## + +[.description] +-- +Azure OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-timeout]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-timeout[`quarkus.langchain4j.azure-openai.timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_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]] +|`10s` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-max-retries]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-max-retries[`quarkus.langchain4j.azure-openai.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-requests[`quarkus.langchain4j.azure-openai.log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-log-responses[`quarkus.langchain4j.azure-openai.log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-enable-integration[`quarkus.langchain4j.azure-openai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-resource-name[`quarkus.langchain4j.azure-openai.chat-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-domain-name[`quarkus.langchain4j.azure-openai.chat-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-deployment-name[`quarkus.langchain4j.azure-openai.chat-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-endpoint[`quarkus.langchain4j.azure-openai.chat-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-temperature[`quarkus.langchain4j.azure-openai.chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-top-p[`quarkus.langchain4j.azure-openai.chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-max-tokens[`quarkus.langchain4j.azure-openai.chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-presence-penalty[`quarkus.langchain4j.azure-openai.chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-frequency-penalty[`quarkus.langchain4j.azure-openai.chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-requests[`quarkus.langchain4j.azure-openai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-log-responses[`quarkus.langchain4j.azure-openai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-chat-model-response-format[`quarkus.langchain4j.azure-openai.chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-resource-name[`quarkus.langchain4j.azure-openai.embedding-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-domain-name[`quarkus.langchain4j.azure-openai.embedding-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-deployment-name[`quarkus.langchain4j.azure-openai.embedding-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-endpoint[`quarkus.langchain4j.azure-openai.embedding-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-requests[`quarkus.langchain4j.azure-openai.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-embedding-model-log-responses[`quarkus.langchain4j.azure-openai.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-resource-name[`quarkus.langchain4j.azure-openai.image-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-domain-name[`quarkus.langchain4j.azure-openai.image-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-deployment-name[`quarkus.langchain4j.azure-openai.image-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-endpoint[`quarkus.langchain4j.azure-openai.image-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-model-name[`quarkus.langchain4j.azure-openai.image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist[`quarkus.langchain4j.azure-openai.image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-persist-directory[`quarkus.langchain4j.azure-openai.image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-response-format[`quarkus.langchain4j.azure-openai.image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-size]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-size[`quarkus.langchain4j.azure-openai.image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-quality[`quarkus.langchain4j.azure-openai.image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-number]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-number[`quarkus.langchain4j.azure-openai.image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-style]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-style[`quarkus.langchain4j.azure-openai.image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-user]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-user[`quarkus.langchain4j.azure-openai.image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-requests[`quarkus.langchain4j.azure-openai.image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-image-model-log-responses[`quarkus.langchain4j.azure-openai.image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-azure-openai_section_quarkus-langchain4j-azure-openai]] [.section-name.section-level0]##link:#quarkus-langchain4j-azure-openai_section_quarkus-langchain4j-azure-openai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-resource-name[`quarkus.langchain4j.azure-openai."model-name".resource-name`]## + +[.description] +-- +The name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.deployment-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-domain-name[`quarkus.langchain4j.azure-openai."model-name".domain-name`]## + +[.description] +-- +The domain name of your Azure OpenAI Resource. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.domain-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`openai.azure.com` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-deployment-name[`quarkus.langchain4j.azure-openai."model-name".deployment-name`]## + +[.description] +-- +The name of your model deployment. You're required to first deploy a model before you can make calls. + +This and `quarkus.langchain4j.azure-openai.resource-name` are required if `quarkus.langchain4j.azure-openai.endpoint` is not set. If `quarkus.langchain4j.azure-openai.endpoint` is set then this is never read. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-endpoint[`quarkus.langchain4j.azure-openai."model-name".endpoint`]## + +[.description] +-- +The endpoint for the Azure OpenAI resource. + +If not specified, then `quarkus.langchain4j.azure-openai.resource-name`, `quarkus.langchain4j.azure-openai.domain-name` (defaults to "openai.azure.com") and `quarkus.langchain4j.azure-openai.deployment-name` are required. In this case the endpoint will be set to `https://$++{++quarkus.langchain4j.azure-openai.resource-name`.$++{++quarkus.langchain4j.azure-openai.domain-name++}++/openai/deployments/$++{++quarkus.langchain4j.azure-openai.deployment-name++}}++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-ad-token]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-ad-token[`quarkus.langchain4j.azure-openai."model-name".ad-token`]## + +[.description] +-- +The Azure AD token to use for this operation. If present, then the requests towards OpenAI will include this in the Authorization header. Note that this property overrides the functionality of `quarkus.langchain4j.azure-openai.api-key`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__AD_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__AD_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-version]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-version[`quarkus.langchain4j.azure-openai."model-name".api-version`]## + +[.description] +-- +The API version to use for this operation. This follows the YYYY-MM-DD format + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2023-05-15` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-api-key[`quarkus.langchain4j.azure-openai."model-name".api-key`]## + +[.description] +-- +Azure OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-timeout[`quarkus.langchain4j.azure-openai."model-name".timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-max-retries]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-max-retries[`quarkus.langchain4j.azure-openai."model-name".max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-requests[`quarkus.langchain4j.azure-openai."model-name".log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-log-responses[`quarkus.langchain4j.azure-openai."model-name".log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-enable-integration[`quarkus.langchain4j.azure-openai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".chat-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".chat-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for chat models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-temperature[`quarkus.langchain4j.azure-openai."model-name".chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-top-p[`quarkus.langchain4j.azure-openai."model-name".chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-max-tokens[`quarkus.langchain4j.azure-openai."model-name".chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-presence-penalty[`quarkus.langchain4j.azure-openai."model-name".chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.azure-openai."model-name".chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-chat-model-response-format[`quarkus.langchain4j.azure-openai."model-name".chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".embedding-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".embedding-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for embedding models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-embedding-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-resource-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-resource-name[`quarkus.langchain4j.azure-openai."model-name".image-model.resource-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.resource-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESOURCE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESOURCE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-domain-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-domain-name[`quarkus.langchain4j.azure-openai."model-name".image-model.domain-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.domain-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DOMAIN_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DOMAIN_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-deployment-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-deployment-name[`quarkus.langchain4j.azure-openai."model-name".image-model.deployment-name`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.deployment-name` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DEPLOYMENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_DEPLOYMENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-endpoint]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-endpoint[`quarkus.langchain4j.azure-openai."model-name".image-model.endpoint`]## + +[.description] +-- +This property will override the `quarkus.langchain4j.azure-openai.endpoint` specifically for image models if it is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-model-name[`quarkus.langchain4j.azure-openai."model-name".image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist[`quarkus.langchain4j.azure-openai."model-name".image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-persist-directory[`quarkus.langchain4j.azure-openai."model-name".image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-response-format[`quarkus.langchain4j.azure-openai."model-name".image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-size]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-size[`quarkus.langchain4j.azure-openai."model-name".image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-quality[`quarkus.langchain4j.azure-openai."model-name".image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-number]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-number[`quarkus.langchain4j.azure-openai."model-name".image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-style]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-style[`quarkus.langchain4j.azure-openai."model-name".image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-user]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-user[`quarkus.langchain4j.azure-openai."model-name".image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-requests[`quarkus.langchain4j.azure-openai."model-name".image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-azure-openai_quarkus-langchain4j-azure-openai-model-name-image-model-log-responses[`quarkus.langchain4j.azure-openai."model-name".image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_AZURE_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-azure-openai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-chroma.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma.adoc index 7627c1bb1..d4d8a065a 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-langchain4j-chroma +:summaryTableId: quarkus-langchain4j-chroma_quarkus-langchain4j [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-langchain4j-chroma_configuration]]link:#quarkus-langchain4j-chroma_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled[quarkus.langchain4j.chroma.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled[`quarkus.langchain4j.chroma.devservices.enabled`]## [.description] -- @@ -19,35 +16,35 @@ If DevServices has been explicitly enabled or disabled. DevServices is generally When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name[quarkus.langchain4j.chroma.devservices.image-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name[`quarkus.langchain4j.chroma.devservices.image-name`]## [.description] -- The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack:latest`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ghcr.io/chroma-core/chroma:0.4.15` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port[quarkus.langchain4j.chroma.devservices.port]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port[`quarkus.langchain4j.chroma.devservices.port`]## [.description] -- @@ -55,18 +52,18 @@ Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared[quarkus.langchain4j.chroma.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared[`quarkus.langchain4j.chroma.devservices.shared`]## [.description] -- @@ -76,18 +73,18 @@ The discovery uses the `quarkus-dev-service-chroma` label. The value is configur Container sharing is only used in dev mode. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name[quarkus.langchain4j.chroma.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name[`quarkus.langchain4j.chroma.devservices.service-name`]## [.description] -- @@ -95,122 +92,124 @@ The value of the `quarkus-dev-service-chroma` label attached to the started cont This property is used when you need multiple shared Chroma servers. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`chroma` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env[`quarkus.langchain4j.chroma.devservices.container-env."container-env"`]## + +[.description] +-- +Environment variables that are passed to the container. + -a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[quarkus.langchain4j.chroma.url]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[`quarkus.langchain4j.chroma.url`]## [.description] -- URL where the Chroma database is listening for requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[quarkus.langchain4j.chroma.collection-name]` - +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[`quarkus.langchain4j.chroma.collection-name`]## [.description] -- The collection name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`default` - -a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[quarkus.langchain4j.chroma.timeout]` - +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[`quarkus.langchain4j.chroma.timeout`]## [.description] -- The timeout duration for the Chroma client. If not specified, 5 seconds will be used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[quarkus.langchain4j.chroma.log-requests]` - +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[`quarkus.langchain4j.chroma.log-requests`]## [.description] -- Whether requests to Chroma should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[quarkus.langchain4j.chroma.log-responses]` - +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[`quarkus.langchain4j.chroma.log-responses`]## [.description] -- Whether responses from Chroma should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env]]`link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env[quarkus.langchain4j.chroma.devservices.container-env]` - - -[.description] -- -Environment variables that are passed to the container. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| +|boolean +|`false` |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-chroma_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -227,3 +226,5 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma_quarkus.langchain4j.adoc new file mode 100644 index 000000000..d4d8a065a --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-chroma_quarkus.langchain4j.adoc @@ -0,0 +1,230 @@ +:summaryTableId: quarkus-langchain4j-chroma_quarkus-langchain4j +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-enabled[`quarkus.langchain4j.chroma.devservices.enabled`]## + +[.description] +-- +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-image-name[`quarkus.langchain4j.chroma.devservices.image-name`]## + +[.description] +-- +The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: `redis/redis-stack:latest`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ghcr.io/chroma-core/chroma:0.4.15` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-port[`quarkus.langchain4j.chroma.devservices.port`]## + +[.description] +-- +Optional fixed port the dev service will listen to. + +If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-shared[`quarkus.langchain4j.chroma.devservices.shared`]## + +[.description] +-- +Indicates if the Redis server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Redis starts a new container. + +The discovery uses the `quarkus-dev-service-chroma` label. The value is configured using the `service-name` property. + +Container sharing is only used in dev mode. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-service-name[`quarkus.langchain4j.chroma.devservices.service-name`]## + +[.description] +-- +The value of the `quarkus-dev-service-chroma` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Redis looks for a container with the `quarkus-dev-service-chroma` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-chroma` label set to the specified value. + +This property is used when you need multiple shared Chroma servers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chroma` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-devservices-container-env-container-env[`quarkus.langchain4j.chroma.devservices.container-env."container-env"`]## + +[.description] +-- +Environment variables that are passed to the container. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_DEVSERVICES_CONTAINER_ENV__CONTAINER_ENV_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-url[`quarkus.langchain4j.chroma.url`]## + +[.description] +-- +URL where the Chroma database is listening for requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-collection-name[`quarkus.langchain4j.chroma.collection-name`]## + +[.description] +-- +The collection name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_COLLECTION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`default` + +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-timeout[`quarkus.langchain4j.chroma.timeout`]## + +[.description] +-- +The timeout duration for the Chroma client. If not specified, 5 seconds will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-requests[`quarkus.langchain4j.chroma.log-requests`]## + +[.description] +-- +Whether requests to Chroma should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses]] [.property-path]##link:#quarkus-langchain4j-chroma_quarkus-langchain4j-chroma-log-responses[`quarkus.langchain4j.chroma.log-responses`]## + +[.description] +-- +Whether responses from Chroma should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHROMA_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-chroma_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-cohere.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere.adoc index d16e4eaf2..a7f3e2be6 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere.adoc @@ -1,104 +1,312 @@ - -:summaryTableId: quarkus-langchain4j-cohere +:summaryTableId: quarkus-langchain4j-cohere_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-cohere_configuration]]link:#quarkus-langchain4j-cohere_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url]]`link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url[quarkus.langchain4j.cohere.base-url]` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-enabled]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-enabled[`quarkus.langchain4j.cohere.scoring-model.enabled`]## + +[.description] +-- +Whether the scoring model should be enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url[`quarkus.langchain4j.cohere.base-url`]## [.description] -- Base URL of the Cohere API. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://api.cohere.ai/` - -a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key]]`link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key[quarkus.langchain4j.cohere.api-key]` - +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key[`quarkus.langchain4j.cohere.api-key`]## [.description] -- Cohere API key. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string -|required icon:exclamation-circle[title=Configuration property is required] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-timeout[`quarkus.langchain4j.cohere.timeout`]## + +[.description] +-- +Timeout for Cohere calls. -a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name]]`link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name[quarkus.langchain4j.cohere.scoring-model.model-name]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_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]] +|`30s` +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name[`quarkus.langchain4j.cohere.scoring-model.model-name`]## [.description] -- Reranking model to use. The current list of supported models can be found in the link:https://docs.cohere.com/docs/models[Cohere docs] + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`rerank-multilingual-v2.0` - -a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout]]`link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout[quarkus.langchain4j.cohere.scoring-model.timeout]` - +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout[`quarkus.langchain4j.cohere.scoring-model.timeout`]## [.description] -- Timeout for Cohere calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_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]] |`30S` +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-requests[`quarkus.langchain4j.cohere.scoring-model.log-requests`]## -a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries]]`link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries[quarkus.langchain4j.cohere.scoring-model.max-retries]` +[.description] +-- +Whether embedding model requests should be logged. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-responses[`quarkus.langchain4j.cohere.scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries[`quarkus.langchain4j.cohere.scoring-model.max-retries`]## + [.description] -- The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int +|`1` + +h|[[quarkus-langchain4j-cohere_section_quarkus-langchain4j-cohere]] [.section-name.section-level0]##link:#quarkus-langchain4j-cohere_section_quarkus-langchain4j-cohere[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-base-url[`quarkus.langchain4j.cohere."model-name".base-url`]## + +[.description] +-- +Base URL of the Cohere API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.cohere.ai/` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-api-key[`quarkus.langchain4j.cohere."model-name".api-key`]## + +[.description] +-- +Cohere API key. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-timeout[`quarkus.langchain4j.cohere."model-name".timeout`]## + +[.description] +-- +Timeout for Cohere calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__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]] +|`30s` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-model-name]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-model-name[`quarkus.langchain4j.cohere."model-name".scoring-model.model-name`]## + +[.description] +-- +Reranking model to use. The current list of supported models can be found in the link:https://docs.cohere.com/docs/models[Cohere docs] + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`rerank-multilingual-v2.0` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-timeout[`quarkus.langchain4j.cohere."model-name".scoring-model.timeout`]## + +[.description] +-- +Timeout for Cohere calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_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]] +|`30S` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-requests[`quarkus.langchain4j.cohere."model-name".scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-responses[`quarkus.langchain4j.cohere."model-name".scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-max-retries[`quarkus.langchain4j.cohere."model-name".scoring-model.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int |`1` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-cohere_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -115,3 +323,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-cohere_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere_quarkus.langchain4j.adoc new file mode 100644 index 000000000..a7f3e2be6 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-cohere_quarkus.langchain4j.adoc @@ -0,0 +1,327 @@ +:summaryTableId: quarkus-langchain4j-cohere_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-enabled]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-enabled[`quarkus.langchain4j.cohere.scoring-model.enabled`]## + +[.description] +-- +Whether the scoring model should be enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-base-url[`quarkus.langchain4j.cohere.base-url`]## + +[.description] +-- +Base URL of the Cohere API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.cohere.ai/` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-api-key[`quarkus.langchain4j.cohere.api-key`]## + +[.description] +-- +Cohere API key. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-timeout[`quarkus.langchain4j.cohere.timeout`]## + +[.description] +-- +Timeout for Cohere calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_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]] +|`30s` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-model-name[`quarkus.langchain4j.cohere.scoring-model.model-name`]## + +[.description] +-- +Reranking model to use. The current list of supported models can be found in the link:https://docs.cohere.com/docs/models[Cohere docs] + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`rerank-multilingual-v2.0` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-timeout[`quarkus.langchain4j.cohere.scoring-model.timeout`]## + +[.description] +-- +Timeout for Cohere calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_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]] +|`30S` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-requests[`quarkus.langchain4j.cohere.scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-log-responses[`quarkus.langchain4j.cohere.scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-scoring-model-max-retries[`quarkus.langchain4j.cohere.scoring-model.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE_SCORING_MODEL_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +h|[[quarkus-langchain4j-cohere_section_quarkus-langchain4j-cohere]] [.section-name.section-level0]##link:#quarkus-langchain4j-cohere_section_quarkus-langchain4j-cohere[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-base-url[`quarkus.langchain4j.cohere."model-name".base-url`]## + +[.description] +-- +Base URL of the Cohere API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.cohere.ai/` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-api-key[`quarkus.langchain4j.cohere."model-name".api-key`]## + +[.description] +-- +Cohere API key. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-timeout[`quarkus.langchain4j.cohere."model-name".timeout`]## + +[.description] +-- +Timeout for Cohere calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__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]] +|`30s` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-model-name]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-model-name[`quarkus.langchain4j.cohere."model-name".scoring-model.model-name`]## + +[.description] +-- +Reranking model to use. The current list of supported models can be found in the link:https://docs.cohere.com/docs/models[Cohere docs] + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`rerank-multilingual-v2.0` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-timeout]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-timeout[`quarkus.langchain4j.cohere."model-name".scoring-model.timeout`]## + +[.description] +-- +Timeout for Cohere calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_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]] +|`30S` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-requests[`quarkus.langchain4j.cohere."model-name".scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-log-responses[`quarkus.langchain4j.cohere."model-name".scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-max-retries]] [.property-path]##link:#quarkus-langchain4j-cohere_quarkus-langchain4j-cohere-model-name-scoring-model-max-retries[`quarkus.langchain4j.cohere."model-name".scoring-model.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_COHERE__MODEL_NAME__SCORING_MODEL_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-cohere_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-core.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-core.adoc new file mode 100644 index 000000000..ec8cd6501 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-core.adoc @@ -0,0 +1,403 @@ +:summaryTableId: quarkus-langchain4j-core_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-type]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-type[`quarkus.langchain4j.chat-memory.type`]## + +[.description] +-- +Configure the type of `ChatMemory` that will be used by default by the default `ChatMemoryProvider` bean. + +The extension provides a default bean that configures `ChatMemoryProvider` for use with AI services registered with `RegisterAiService`. This bean depends uses the `quarkus.langchain4j.chat-memory` configuration to set things up while also depending on the presence of a bean of type `ChatMemoryStore` (for which the extension also provides a default in the form of `InMemoryChatMemoryStore`). + +If `token-window` is used, then the application must also provide a bean of type `Tokenizer`. + +Users can choose to provide their own `ChatMemoryStore` bean or even their own `ChatMemoryProvider` bean if full control over the details is needed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|Type +|`message-window` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled[`quarkus.langchain4j.devservices.enabled`]## + +[.description] +-- +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically serve a model if there are any matching ones. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-port]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-port[`quarkus.langchain4j.devservices.port`]## + +[.description] +-- +The default port where the inference server listens for requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`11434` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-preload]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-preload[`quarkus.langchain4j.devservices.preload`]## + +[.description] +-- +Instructs Ollama to preload a model in order to get faster response times + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PRELOAD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PRELOAD+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-response-schema]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-response-schema[`quarkus.langchain4j.response-schema`]## + +[.description] +-- +Configuration property to enable or disable the use of the ++{++response schema++}++ placeholder in the @SystemMessage/@UserMessage. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_RESPONSE_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_RESPONSE_SCHEMA+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-memory-window-max-messages]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-memory-window-max-messages[`quarkus.langchain4j.chat-memory.memory-window.max-messages`]## + +[.description] +-- +The maximum number of messages the configured `MessageWindowChatMemory` will hold + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_MEMORY_WINDOW_MAX_MESSAGES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_MEMORY_WINDOW_MAX_MESSAGES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-token-window-max-tokens]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-token-window-max-tokens[`quarkus.langchain4j.chat-memory.token-window.max-tokens`]## + +[.description] +-- +The maximum number of tokens the configured `TokenWindowChatMemory` will hold + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TOKEN_WINDOW_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TOKEN_WINDOW_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1000` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-log-requests]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-log-requests[`quarkus.langchain4j.log-requests`]## + +[.description] +-- +Whether clients should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-log-responses]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-log-responses[`quarkus.langchain4j.log-responses`]## + +[.description] +-- +Whether clients should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-timeout]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-timeout[`quarkus.langchain4j.timeout`]## + +[.description] +-- +Global timeout for requests to LLM APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_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]] +|`10s` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-guardrails-max-retries]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-guardrails-max-retries[`quarkus.langchain4j.guardrails.max-retries`]## + +[.description] +-- +Configures the maximum number of retries for the guardrail. Sets it to 0 to disable retries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_GUARDRAILS_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_GUARDRAILS_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +h|[[quarkus-langchain4j-core_section_quarkus-langchain4j]] [.section-name.section-level0]##link:#quarkus-langchain4j-core_section_quarkus-langchain4j[Default model config]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-chat-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-model-provider[`quarkus.langchain4j.chat-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-scoring-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-scoring-model-provider[`quarkus.langchain4j.scoring-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_SCORING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_SCORING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-embedding-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-embedding-model-provider[`quarkus.langchain4j.embedding-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EMBEDDING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EMBEDDING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-moderation-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-moderation-model-provider[`quarkus.langchain4j.moderation-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MODERATION_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MODERATION_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-image-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-image-model-provider[`quarkus.langchain4j.image-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_IMAGE_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_IMAGE_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-chat-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-chat-model-provider[`quarkus.langchain4j."model-name".chat-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__CHAT_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__CHAT_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-scoring-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-scoring-model-provider[`quarkus.langchain4j."model-name".scoring-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__SCORING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__SCORING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-embedding-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-embedding-model-provider[`quarkus.langchain4j."model-name".embedding-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__EMBEDDING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__EMBEDDING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-moderation-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-moderation-model-provider[`quarkus.langchain4j."model-name".moderation-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__MODERATION_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__MODERATION_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-image-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-image-model-provider[`quarkus.langchain4j."model-name".image-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__IMAGE_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__IMAGE_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-core_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-core_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-core_quarkus.langchain4j.adoc new file mode 100644 index 000000000..ec8cd6501 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-core_quarkus.langchain4j.adoc @@ -0,0 +1,403 @@ +:summaryTableId: quarkus-langchain4j-core_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-type]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-type[`quarkus.langchain4j.chat-memory.type`]## + +[.description] +-- +Configure the type of `ChatMemory` that will be used by default by the default `ChatMemoryProvider` bean. + +The extension provides a default bean that configures `ChatMemoryProvider` for use with AI services registered with `RegisterAiService`. This bean depends uses the `quarkus.langchain4j.chat-memory` configuration to set things up while also depending on the presence of a bean of type `ChatMemoryStore` (for which the extension also provides a default in the form of `InMemoryChatMemoryStore`). + +If `token-window` is used, then the application must also provide a bean of type `Tokenizer`. + +Users can choose to provide their own `ChatMemoryStore` bean or even their own `ChatMemoryProvider` bean if full control over the details is needed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|Type +|`message-window` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-enabled[`quarkus.langchain4j.devservices.enabled`]## + +[.description] +-- +If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. + +When DevServices is enabled Quarkus will attempt to automatically serve a model if there are any matching ones. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-port]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-port[`quarkus.langchain4j.devservices.port`]## + +[.description] +-- +The default port where the inference server listens for requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`11434` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-devservices-preload]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-devservices-preload[`quarkus.langchain4j.devservices.preload`]## + +[.description] +-- +Instructs Ollama to preload a model in order to get faster response times + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PRELOAD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_DEVSERVICES_PRELOAD+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-response-schema]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-response-schema[`quarkus.langchain4j.response-schema`]## + +[.description] +-- +Configuration property to enable or disable the use of the ++{++response schema++}++ placeholder in the @SystemMessage/@UserMessage. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_RESPONSE_SCHEMA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_RESPONSE_SCHEMA+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-memory-window-max-messages]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-memory-window-max-messages[`quarkus.langchain4j.chat-memory.memory-window.max-messages`]## + +[.description] +-- +The maximum number of messages the configured `MessageWindowChatMemory` will hold + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_MEMORY_WINDOW_MAX_MESSAGES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_MEMORY_WINDOW_MAX_MESSAGES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-token-window-max-tokens]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-memory-token-window-max-tokens[`quarkus.langchain4j.chat-memory.token-window.max-tokens`]## + +[.description] +-- +The maximum number of tokens the configured `TokenWindowChatMemory` will hold + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TOKEN_WINDOW_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MEMORY_TOKEN_WINDOW_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1000` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-log-requests]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-log-requests[`quarkus.langchain4j.log-requests`]## + +[.description] +-- +Whether clients should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-log-responses]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-log-responses[`quarkus.langchain4j.log-responses`]## + +[.description] +-- +Whether clients should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-timeout]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-timeout[`quarkus.langchain4j.timeout`]## + +[.description] +-- +Global timeout for requests to LLM APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_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]] +|`10s` + +a| [[quarkus-langchain4j-core_quarkus-langchain4j-guardrails-max-retries]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-guardrails-max-retries[`quarkus.langchain4j.guardrails.max-retries`]## + +[.description] +-- +Configures the maximum number of retries for the guardrail. Sets it to 0 to disable retries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_GUARDRAILS_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_GUARDRAILS_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +h|[[quarkus-langchain4j-core_section_quarkus-langchain4j]] [.section-name.section-level0]##link:#quarkus-langchain4j-core_section_quarkus-langchain4j[Default model config]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-chat-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-chat-model-provider[`quarkus.langchain4j.chat-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_CHAT_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_CHAT_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-scoring-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-scoring-model-provider[`quarkus.langchain4j.scoring-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_SCORING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_SCORING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-embedding-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-embedding-model-provider[`quarkus.langchain4j.embedding-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EMBEDDING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EMBEDDING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-moderation-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-moderation-model-provider[`quarkus.langchain4j.moderation-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MODERATION_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MODERATION_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-image-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-image-model-provider[`quarkus.langchain4j.image-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_IMAGE_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_IMAGE_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-chat-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-chat-model-provider[`quarkus.langchain4j."model-name".chat-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__CHAT_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__CHAT_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-scoring-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-scoring-model-provider[`quarkus.langchain4j."model-name".scoring-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__SCORING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__SCORING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-embedding-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-embedding-model-provider[`quarkus.langchain4j."model-name".embedding-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__EMBEDDING_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__EMBEDDING_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-moderation-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-moderation-model-provider[`quarkus.langchain4j."model-name".moderation-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__MODERATION_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__MODERATION_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-core_quarkus-langchain4j-model-name-image-model-provider]] [.property-path]##link:#quarkus-langchain4j-core_quarkus-langchain4j-model-name-image-model-provider[`quarkus.langchain4j."model-name".image-model.provider`]## + +[.description] +-- +The model provider to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J__MODEL_NAME__IMAGE_MODEL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J__MODEL_NAME__IMAGE_MODEL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-core_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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 b3dd34c97..1d95c1ec4 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag.adoc @@ -1,154 +1,150 @@ - -:summaryTableId: quarkus-langchain4j-easy-rag +:summaryTableId: quarkus-langchain4j-easy-rag_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-easy-rag_configuration]]link:#quarkus-langchain4j-easy-rag_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path[quarkus.langchain4j.easy-rag.path]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path[`quarkus.langchain4j.easy-rag.path`]## [.description] -- Path to the directory containing the documents to be ingested. This is either an absolute or relative path in the filesystem. A relative path is resolved against the current working directory at runtime. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher[quarkus.langchain4j.easy-rag.path-matcher]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher[`quarkus.langchain4j.easy-rag.path-matcher`]## [.description] -- Matcher used for filtering which files from the directory should be ingested. This uses the `java.nio.file.FileSystem` path matcher syntax. Example: `glob:++**++.txt` to recursively match all files with the `.txt` extension. The default is `glob:++**++`, recursively matching all files. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH_MATCHER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH_MATCHER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`glob:**` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive[quarkus.langchain4j.easy-rag.recursive]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive[`quarkus.langchain4j.easy-rag.recursive`]## [.description] -- Whether to recursively ingest documents from subdirectories. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_RECURSIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_RECURSIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size[quarkus.langchain4j.easy-rag.max-segment-size]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size[`quarkus.langchain4j.easy-rag.max-segment-size`]## [.description] -- Maximum segment size when splitting documents, in tokens. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_SEGMENT_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_SEGMENT_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`300` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size[quarkus.langchain4j.easy-rag.max-overlap-size]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size[`quarkus.langchain4j.easy-rag.max-overlap-size`]## [.description] -- Maximum overlap (in tokens) when splitting documents. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_OVERLAP_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_OVERLAP_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`30` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results[quarkus.langchain4j.easy-rag.max-results]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results[`quarkus.langchain4j.easy-rag.max-results`]## [.description] -- Maximum number of 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_MAX_RESULTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_RESULTS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`5` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-ingestion-strategy[quarkus.langchain4j.easy-rag.ingestion-strategy]` - +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] -- The strategy to decide whether document ingestion into the store should happen at startup or not. The default is ON. Changing to OFF generally only makes sense if running against a persistent embedding store that was already populated. When set to MANUAL, it is expected that the application will inject and call the `io.quarkiverse.langchain4j.easyrag.EasyRagManualIngestion` bean to trigger the ingestion when desired. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++` endif::add-copy-button-to-env-var[] --- a| -`on`, `off`, `manual` +-- +a|IngestionStrategy |`on` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled[quarkus.langchain4j.easy-rag.reuse-embeddings.enabled]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled[`quarkus.langchain4j.easy-rag.reuse-embeddings.enabled`]## [.description] -- Whether or not to reuse embeddings. Defaults to `false`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file]]`link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file[quarkus.langchain4j.easy-rag.reuse-embeddings.file]` - +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file[`quarkus.langchain4j.easy-rag.reuse-embeddings.file`]## [.description] -- @@ -156,13 +152,18 @@ The file path to load/save embeddings, assuming `quarkus.langchain4j.easy-rag.re Defaults to `easy-rag-embeddings.json` in the current directory. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_FILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_FILE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`easy-rag-embeddings.json` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file 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 new file mode 100644 index 000000000..1d95c1ec4 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-easy-rag_quarkus.langchain4j.adoc @@ -0,0 +1,169 @@ +:summaryTableId: quarkus-langchain4j-easy-rag_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|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path[`quarkus.langchain4j.easy-rag.path`]## + +[.description] +-- +Path to the directory containing the documents to be ingested. This is either an absolute or relative path in the filesystem. A relative path is resolved against the current working directory at runtime. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-path-matcher[`quarkus.langchain4j.easy-rag.path-matcher`]## + +[.description] +-- +Matcher used for filtering which files from the directory should be ingested. This uses the `java.nio.file.FileSystem` path matcher syntax. Example: `glob:++**++.txt` to recursively match all files with the `.txt` extension. The default is `glob:++**++`, recursively matching all files. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH_MATCHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_PATH_MATCHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`glob:**` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-recursive[`quarkus.langchain4j.easy-rag.recursive`]## + +[.description] +-- +Whether to recursively ingest documents from subdirectories. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_RECURSIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_RECURSIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-segment-size[`quarkus.langchain4j.easy-rag.max-segment-size`]## + +[.description] +-- +Maximum segment size when splitting documents, in tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_SEGMENT_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_SEGMENT_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`300` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-overlap-size[`quarkus.langchain4j.easy-rag.max-overlap-size`]## + +[.description] +-- +Maximum overlap (in tokens) when splitting documents. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_OVERLAP_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_OVERLAP_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`30` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-max-results[`quarkus.langchain4j.easy-rag.max-results`]## + +[.description] +-- +Maximum number of 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_MAX_RESULTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_MAX_RESULTS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`5` + +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] +-- +The strategy to decide whether document ingestion into the store should happen at startup or not. The default is ON. Changing to OFF generally only makes sense if running against a persistent embedding store that was already populated. When set to MANUAL, it is expected that the application will inject and call the `io.quarkiverse.langchain4j.easyrag.EasyRagManualIngestion` bean to trigger the ingestion when desired. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_INGESTION_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +a|IngestionStrategy +|`on` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-enabled[`quarkus.langchain4j.easy-rag.reuse-embeddings.enabled`]## + +[.description] +-- +Whether or not to reuse embeddings. Defaults to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file]] [.property-path]##link:#quarkus-langchain4j-easy-rag_quarkus-langchain4j-easy-rag-reuse-embeddings-file[`quarkus.langchain4j.easy-rag.reuse-embeddings.file`]## + +[.description] +-- +The file path to load/save embeddings, assuming `quarkus.langchain4j.easy-rag.reuse-embeddings.enabled == true`. + +Defaults to `easy-rag-embeddings.json` in the current directory. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_EASY_RAG_REUSE_EMBEDDINGS_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`easy-rag-embeddings.json` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face.adoc new file mode 100644 index 000000000..55dcbb5d8 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face.adoc @@ -0,0 +1,717 @@ +:summaryTableId: quarkus-langchain4j-hugging-face_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-enabled[`quarkus.langchain4j.huggingface.chat-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_HUGGINGFACE_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-enabled[`quarkus.langchain4j.huggingface.embedding-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_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-moderation-model-enabled[`quarkus.langchain4j.huggingface.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_HUGGINGFACE_MODERATION_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_MODERATION_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-api-key]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-api-key[`quarkus.langchain4j.huggingface.api-key`]## + +[.description] +-- +HuggingFace API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-timeout]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-timeout[`quarkus.langchain4j.huggingface.timeout`]## + +[.description] +-- +Timeout for HuggingFace calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_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]] +|`10s` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-inference-endpoint-url[`quarkus.langchain4j.huggingface.chat-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the chat model. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/models/`, for example `https://api-inference.huggingface.co/models/google/flan-t5-small`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/models/tiiuae/falcon-7b-instruct` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-temperature[`quarkus.langchain4j.huggingface.chat-model.temperature`]## + +[.description] +-- +Float (0.0-100.0). The temperature of the sampling operation. 1 means regular sampling, 0 means always take the highest score, 100.0 is getting closer to uniform probability + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-max-new-tokens[`quarkus.langchain4j.huggingface.chat-model.max-new-tokens`]## + +[.description] +-- +Int (0-250). The amount of new tokens to be generated, this does not include the input length it is a estimate of the size of generated text you want. Each new tokens slows down the request, so look for balance between response times and length of text generated + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_MAX_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-return-full-text]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-return-full-text[`quarkus.langchain4j.huggingface.chat-model.return-full-text`]## + +[.description] +-- +If set to `false`, the return results will not contain the original query making it easier for prompting + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_RETURN_FULL_TEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_RETURN_FULL_TEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-wait-for-model[`quarkus.langchain4j.huggingface.chat-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-do-sample]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-do-sample[`quarkus.langchain4j.huggingface.chat-model.do-sample`]## + +[.description] +-- +Whether or not to use sampling ; use greedy decoding otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-k[`quarkus.langchain4j.huggingface.chat-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-p[`quarkus.langchain4j.huggingface.chat-model.top-p`]## + +[.description] +-- +If set to less than `1`, only the most probable tokens with probabilities that add up to `top_p` or higher are kept for generation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-repetition-penalty[`quarkus.langchain4j.huggingface.chat-model.repetition-penalty`]## + +[.description] +-- +The parameter for repetition penalty. 1.0 means no penalty. See link:https://arxiv.org/pdf/1909.05858.pdf[this paper] for more details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-requests[`quarkus.langchain4j.huggingface.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-responses[`quarkus.langchain4j.huggingface.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-inference-endpoint-url[`quarkus.langchain4j.huggingface.embedding-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the embedding. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/pipeline/feature-extraction/`, for example `https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-mpnet-base-v2`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-MiniLM-L6-v2` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-wait-for-model[`quarkus.langchain4j.huggingface.embedding-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-requests[`quarkus.langchain4j.huggingface.log-requests`]## + +[.description] +-- +Whether the HuggingFace client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-responses[`quarkus.langchain4j.huggingface.log-responses`]## + +[.description] +-- +Whether the HuggingFace client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-enable-integration]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-enable-integration[`quarkus.langchain4j.huggingface.enable-integration`]## + +[.description] +-- +Whether or not to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +h|[[quarkus-langchain4j-hugging-face_section_quarkus-langchain4j-huggingface]] [.section-name.section-level0]##link:#quarkus-langchain4j-hugging-face_section_quarkus-langchain4j-huggingface[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-api-key[`quarkus.langchain4j.huggingface."model-name".api-key`]## + +[.description] +-- +HuggingFace API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-timeout[`quarkus.langchain4j.huggingface."model-name".timeout`]## + +[.description] +-- +Timeout for HuggingFace calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-inference-endpoint-url[`quarkus.langchain4j.huggingface."model-name".chat-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the chat model. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/models/`, for example `https://api-inference.huggingface.co/models/google/flan-t5-small`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/models/tiiuae/falcon-7b-instruct` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-temperature[`quarkus.langchain4j.huggingface."model-name".chat-model.temperature`]## + +[.description] +-- +Float (0.0-100.0). The temperature of the sampling operation. 1 means regular sampling, 0 means always take the highest score, 100.0 is getting closer to uniform probability + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-max-new-tokens[`quarkus.langchain4j.huggingface."model-name".chat-model.max-new-tokens`]## + +[.description] +-- +Int (0-250). The amount of new tokens to be generated, this does not include the input length it is a estimate of the size of generated text you want. Each new tokens slows down the request, so look for balance between response times and length of text generated + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__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_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-return-full-text]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-return-full-text[`quarkus.langchain4j.huggingface."model-name".chat-model.return-full-text`]## + +[.description] +-- +If set to `false`, the return results will not contain the original query making it easier for prompting + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_RETURN_FULL_TEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_RETURN_FULL_TEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-wait-for-model[`quarkus.langchain4j.huggingface."model-name".chat-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-do-sample]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-do-sample[`quarkus.langchain4j.huggingface."model-name".chat-model.do-sample`]## + +[.description] +-- +Whether or not to use sampling ; use greedy decoding otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_DO_SAMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_DO_SAMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-k[`quarkus.langchain4j.huggingface."model-name".chat-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-p[`quarkus.langchain4j.huggingface."model-name".chat-model.top-p`]## + +[.description] +-- +If set to less than `1`, only the most probable tokens with probabilities that add up to `top_p` or higher are kept for generation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-repetition-penalty[`quarkus.langchain4j.huggingface."model-name".chat-model.repetition-penalty`]## + +[.description] +-- +The parameter for repetition penalty. 1.0 means no penalty. See link:https://arxiv.org/pdf/1909.05858.pdf[this paper] for more details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-requests[`quarkus.langchain4j.huggingface."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-responses[`quarkus.langchain4j.huggingface."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-inference-endpoint-url[`quarkus.langchain4j.huggingface."model-name".embedding-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the embedding. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/pipeline/feature-extraction/`, for example `https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-mpnet-base-v2`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-MiniLM-L6-v2` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-wait-for-model[`quarkus.langchain4j.huggingface."model-name".embedding-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-requests[`quarkus.langchain4j.huggingface."model-name".log-requests`]## + +[.description] +-- +Whether the HuggingFace client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-responses[`quarkus.langchain4j.huggingface."model-name".log-responses`]## + +[.description] +-- +Whether the HuggingFace client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-enable-integration[`quarkus.langchain4j.huggingface."model-name".enable-integration`]## + +[.description] +-- +Whether or not to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-hugging-face_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-hugging-face_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face_quarkus.langchain4j.adoc new file mode 100644 index 000000000..55dcbb5d8 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-hugging-face_quarkus.langchain4j.adoc @@ -0,0 +1,717 @@ +:summaryTableId: quarkus-langchain4j-hugging-face_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-enabled[`quarkus.langchain4j.huggingface.chat-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_HUGGINGFACE_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-enabled[`quarkus.langchain4j.huggingface.embedding-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_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-moderation-model-enabled[`quarkus.langchain4j.huggingface.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_HUGGINGFACE_MODERATION_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_MODERATION_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-api-key]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-api-key[`quarkus.langchain4j.huggingface.api-key`]## + +[.description] +-- +HuggingFace API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-timeout]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-timeout[`quarkus.langchain4j.huggingface.timeout`]## + +[.description] +-- +Timeout for HuggingFace calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_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]] +|`10s` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-inference-endpoint-url[`quarkus.langchain4j.huggingface.chat-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the chat model. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/models/`, for example `https://api-inference.huggingface.co/models/google/flan-t5-small`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/models/tiiuae/falcon-7b-instruct` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-temperature[`quarkus.langchain4j.huggingface.chat-model.temperature`]## + +[.description] +-- +Float (0.0-100.0). The temperature of the sampling operation. 1 means regular sampling, 0 means always take the highest score, 100.0 is getting closer to uniform probability + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-max-new-tokens[`quarkus.langchain4j.huggingface.chat-model.max-new-tokens`]## + +[.description] +-- +Int (0-250). The amount of new tokens to be generated, this does not include the input length it is a estimate of the size of generated text you want. Each new tokens slows down the request, so look for balance between response times and length of text generated + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_MAX_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-return-full-text]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-return-full-text[`quarkus.langchain4j.huggingface.chat-model.return-full-text`]## + +[.description] +-- +If set to `false`, the return results will not contain the original query making it easier for prompting + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_RETURN_FULL_TEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_RETURN_FULL_TEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-wait-for-model[`quarkus.langchain4j.huggingface.chat-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-do-sample]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-do-sample[`quarkus.langchain4j.huggingface.chat-model.do-sample`]## + +[.description] +-- +Whether or not to use sampling ; use greedy decoding otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_DO_SAMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-k[`quarkus.langchain4j.huggingface.chat-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-top-p[`quarkus.langchain4j.huggingface.chat-model.top-p`]## + +[.description] +-- +If set to less than `1`, only the most probable tokens with probabilities that add up to `top_p` or higher are kept for generation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-repetition-penalty[`quarkus.langchain4j.huggingface.chat-model.repetition-penalty`]## + +[.description] +-- +The parameter for repetition penalty. 1.0 means no penalty. See link:https://arxiv.org/pdf/1909.05858.pdf[this paper] for more details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-requests[`quarkus.langchain4j.huggingface.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-chat-model-log-responses[`quarkus.langchain4j.huggingface.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-inference-endpoint-url[`quarkus.langchain4j.huggingface.embedding-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the embedding. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/pipeline/feature-extraction/`, for example `https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-mpnet-base-v2`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-MiniLM-L6-v2` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-embedding-model-wait-for-model[`quarkus.langchain4j.huggingface.embedding-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_EMBEDDING_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-requests[`quarkus.langchain4j.huggingface.log-requests`]## + +[.description] +-- +Whether the HuggingFace client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-log-responses[`quarkus.langchain4j.huggingface.log-responses`]## + +[.description] +-- +Whether the HuggingFace client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-enable-integration]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-enable-integration[`quarkus.langchain4j.huggingface.enable-integration`]## + +[.description] +-- +Whether or not to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +h|[[quarkus-langchain4j-hugging-face_section_quarkus-langchain4j-huggingface]] [.section-name.section-level0]##link:#quarkus-langchain4j-hugging-face_section_quarkus-langchain4j-huggingface[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-api-key[`quarkus.langchain4j.huggingface."model-name".api-key`]## + +[.description] +-- +HuggingFace API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-timeout[`quarkus.langchain4j.huggingface."model-name".timeout`]## + +[.description] +-- +Timeout for HuggingFace calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-inference-endpoint-url[`quarkus.langchain4j.huggingface."model-name".chat-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the chat model. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/models/`, for example `https://api-inference.huggingface.co/models/google/flan-t5-small`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/models/tiiuae/falcon-7b-instruct` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-temperature[`quarkus.langchain4j.huggingface."model-name".chat-model.temperature`]## + +[.description] +-- +Float (0.0-100.0). The temperature of the sampling operation. 1 means regular sampling, 0 means always take the highest score, 100.0 is getting closer to uniform probability + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-max-new-tokens[`quarkus.langchain4j.huggingface."model-name".chat-model.max-new-tokens`]## + +[.description] +-- +Int (0-250). The amount of new tokens to be generated, this does not include the input length it is a estimate of the size of generated text you want. Each new tokens slows down the request, so look for balance between response times and length of text generated + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__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_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-return-full-text]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-return-full-text[`quarkus.langchain4j.huggingface."model-name".chat-model.return-full-text`]## + +[.description] +-- +If set to `false`, the return results will not contain the original query making it easier for prompting + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_RETURN_FULL_TEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_RETURN_FULL_TEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-wait-for-model[`quarkus.langchain4j.huggingface."model-name".chat-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-do-sample]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-do-sample[`quarkus.langchain4j.huggingface."model-name".chat-model.do-sample`]## + +[.description] +-- +Whether or not to use sampling ; use greedy decoding otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_DO_SAMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_DO_SAMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-k[`quarkus.langchain4j.huggingface."model-name".chat-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-top-p[`quarkus.langchain4j.huggingface."model-name".chat-model.top-p`]## + +[.description] +-- +If set to less than `1`, only the most probable tokens with probabilities that add up to `top_p` or higher are kept for generation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-repetition-penalty[`quarkus.langchain4j.huggingface."model-name".chat-model.repetition-penalty`]## + +[.description] +-- +The parameter for repetition penalty. 1.0 means no penalty. See link:https://arxiv.org/pdf/1909.05858.pdf[this paper] for more details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-requests[`quarkus.langchain4j.huggingface."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-chat-model-log-responses[`quarkus.langchain4j.huggingface."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-inference-endpoint-url]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-inference-endpoint-url[`quarkus.langchain4j.huggingface."model-name".embedding-model.inference-endpoint-url`]## + +[.description] +-- +The URL of the inference endpoint for the embedding. + +When using Hugging Face with the inference API, the URL is `https://api-inference.huggingface.co/pipeline/feature-extraction/`, for example `https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-mpnet-base-v2`. + +When using a deployed inference endpoint, the URL is the URL of the endpoint. When using a local hugging face model, the URL is the URL of the local model. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_INFERENCE_ENDPOINT_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://api-inference.huggingface.co/pipeline/feature-extraction/sentence-transformers/all-MiniLM-L6-v2` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-wait-for-model]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-embedding-model-wait-for-model[`quarkus.langchain4j.huggingface."model-name".embedding-model.wait-for-model`]## + +[.description] +-- +If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_WAIT_FOR_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__EMBEDDING_MODEL_WAIT_FOR_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-requests[`quarkus.langchain4j.huggingface."model-name".log-requests`]## + +[.description] +-- +Whether the HuggingFace client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-log-responses[`quarkus.langchain4j.huggingface."model-name".log-responses`]## + +[.description] +-- +Whether the HuggingFace client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-hugging-face_quarkus-langchain4j-huggingface-model-name-enable-integration[`quarkus.langchain4j.huggingface."model-name".enable-integration`]## + +[.description] +-- +Whether or not to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_HUGGINGFACE__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-hugging-face_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-infinispan.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan.adoc index 890ea469f..ebe1f9e9c 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan.adoc @@ -1,80 +1,82 @@ - -:summaryTableId: quarkus-langchain4j-infinispan +:summaryTableId: quarkus-langchain4j-infinispan_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-infinispan_configuration]]link:#quarkus-langchain4j-infinispan_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name]]`link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name[quarkus.langchain4j.infinispan.client-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name[`quarkus.langchain4j.infinispan.client-name`]## [.description] -- The name of the Infinispan client to use. These clients are configured by means of the `infinispan-client` extension. If unspecified, it will use the default Infinispan client. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension]]`link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension[quarkus.langchain4j.infinispan.dimension]` - +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension[`quarkus.langchain4j.infinispan.dimension`]## [.description] -- The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_DIMENSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_DIMENSION+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name]]`link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name[quarkus.langchain4j.infinispan.cache-name]` - +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name[`quarkus.langchain4j.infinispan.cache-name`]## [.description] -- Name of the cache that will be used in Infinispan when searching for related embeddings. If this cache doesn't exist, it will be created. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_CACHE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_CACHE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`embeddings-cache` - -a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance]]`link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance[quarkus.langchain4j.infinispan.distance]` - +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance[`quarkus.langchain4j.infinispan.distance`]## [.description] -- The maximum distance. The most distance between vectors is how close or far apart two embeddings are. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_DISTANCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_DISTANCE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`3` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan_quarkus.langchain4j.adoc new file mode 100644 index 000000000..ebe1f9e9c --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-infinispan_quarkus.langchain4j.adoc @@ -0,0 +1,82 @@ +:summaryTableId: quarkus-langchain4j-infinispan_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-client-name[`quarkus.langchain4j.infinispan.client-name`]## + +[.description] +-- +The name of the Infinispan client to use. These clients are configured by means of the `infinispan-client` extension. If unspecified, it will use the default Infinispan client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-dimension[`quarkus.langchain4j.infinispan.dimension`]## + +[.description] +-- +The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|long +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-cache-name[`quarkus.langchain4j.infinispan.cache-name`]## + +[.description] +-- +Name of the cache that will be used in Infinispan when searching for related embeddings. If this cache doesn't exist, it will be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_CACHE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_CACHE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embeddings-cache` + +a| [[quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance]] [.property-path]##link:#quarkus-langchain4j-infinispan_quarkus-langchain4j-infinispan-distance[`quarkus.langchain4j.infinispan.distance`]## + +[.description] +-- +The maximum distance. The most distance between vectors is how close or far apart two embeddings are. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_INFINISPAN_DISTANCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_INFINISPAN_DISTANCE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis.adoc new file mode 100644 index 000000000..68304e366 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-langchain4j-memory-store-redis_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-memory-store-redis_quarkus-langchain4j-memorystore-redis-client-name]] [.property-path]##link:#quarkus-langchain4j-memory-store-redis_quarkus-langchain4j-memorystore-redis-client-name[`quarkus.langchain4j.memorystore.redis.client-name`]## + +[.description] +-- +The name of the Redis client to use. These clients are configured by means of the `redis-client` extension. If unspecified, it will use the default Redis client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MEMORYSTORE_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MEMORYSTORE_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis_quarkus.langchain4j.adoc new file mode 100644 index 000000000..68304e366 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-memory-store-redis_quarkus.langchain4j.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-langchain4j-memory-store-redis_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-memory-store-redis_quarkus-langchain4j-memorystore-redis-client-name]] [.property-path]##link:#quarkus-langchain4j-memory-store-redis_quarkus-langchain4j-memorystore-redis-client-name[`quarkus.langchain4j.memorystore.redis.client-name`]## + +[.description] +-- +The name of the Redis client to use. These clients are configured by means of the `redis-client` extension. If unspecified, it will use the default Redis client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MEMORYSTORE_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MEMORYSTORE_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus.adoc new file mode 100644 index 000000000..eac778335 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus.adoc @@ -0,0 +1,390 @@ +:summaryTableId: quarkus-langchain4j-milvus_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-enabled[`quarkus.langchain4j.milvus.devservices.enabled`]## + +[.description] +-- +Whether Dev Services for Milvus are enabled or not. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-milvus-image-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-milvus-image-name[`quarkus.langchain4j.milvus.devservices.milvus-image-name`]## + +[.description] +-- +Container image for Milvus. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_MILVUS_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_MILVUS_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`docker.io/milvusdb/milvus:v2.3.16` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-port]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-port[`quarkus.langchain4j.milvus.devservices.port`]## + +[.description] +-- +Optional fixed port the Milvus dev service will listen to. If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-shared[`quarkus.langchain4j.milvus.devservices.shared`]## + +[.description] +-- +Indicates if the Dev Service containers managed by Quarkus for Milvus are shared. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-service-name[`quarkus.langchain4j.milvus.devservices.service-name`]## + +[.description] +-- +Service label to apply to created Dev Services containers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`milvus` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-host]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-host[`quarkus.langchain4j.milvus.host`]## + +[.description] +-- +The URL of the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-port]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-port[`quarkus.langchain4j.milvus.port`]## + +[.description] +-- +The port of the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-token]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-token[`quarkus.langchain4j.milvus.token`]## + +[.description] +-- +The authentication token for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-username]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-username[`quarkus.langchain4j.milvus.username`]## + +[.description] +-- +The username for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-password]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-password[`quarkus.langchain4j.milvus.password`]## + +[.description] +-- +The password for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-timeout]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-timeout[`quarkus.langchain4j.milvus.timeout`]## + +[.description] +-- +The timeout duration for the Milvus client. If not specified, 5 seconds will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_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]] +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-db-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-db-name[`quarkus.langchain4j.milvus.db-name`]## + +[.description] +-- +Name of the database. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DB_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DB_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`default` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-create-collection]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-create-collection[`quarkus.langchain4j.milvus.create-collection`]## + +[.description] +-- +Create the collection if it does not exist yet. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_CREATE_COLLECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CREATE_COLLECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-collection-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-collection-name[`quarkus.langchain4j.milvus.collection-name`]## + +[.description] +-- +Name of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_COLLECTION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_COLLECTION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embeddings` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-dimension]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-dimension[`quarkus.langchain4j.milvus.dimension`]## + +[.description] +-- +Dimension of the vectors. Only applicable when the collection yet has to be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-primary-field]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-primary-field[`quarkus.langchain4j.milvus.primary-field`]## + +[.description] +-- +TODO + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PRIMARY_FIELD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PRIMARY_FIELD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`id` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-vector-field]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-vector-field[`quarkus.langchain4j.milvus.vector-field`]## + +[.description] +-- +Name of the field to store the vector in. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_VECTOR_FIELD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_VECTOR_FIELD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vector` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-description]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-description[`quarkus.langchain4j.milvus.description`]## + +[.description] +-- +Description of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DESCRIPTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DESCRIPTION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-index-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-index-type[`quarkus.langchain4j.milvus.index-type`]## + +[.description] +-- +The index type to use for the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|IndexType +|`flat` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type[`quarkus.langchain4j.milvus.metric-type`]## + +[.description] +-- +The metric type to use for searching. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|MetricType +|`cosine` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level[`quarkus.langchain4j.milvus.consistency-level`]## + +[.description] +-- +The consistency level. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++` +endif::add-copy-button-to-env-var[] +-- +a|ConsistencyLevelEnum +|`eventually` + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-milvus_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-milvus_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus_quarkus.langchain4j.adoc new file mode 100644 index 000000000..eac778335 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-milvus_quarkus.langchain4j.adoc @@ -0,0 +1,390 @@ +:summaryTableId: quarkus-langchain4j-milvus_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-enabled[`quarkus.langchain4j.milvus.devservices.enabled`]## + +[.description] +-- +Whether Dev Services for Milvus are enabled or not. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-milvus-image-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-milvus-image-name[`quarkus.langchain4j.milvus.devservices.milvus-image-name`]## + +[.description] +-- +Container image for Milvus. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_MILVUS_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_MILVUS_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`docker.io/milvusdb/milvus:v2.3.16` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-port]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-port[`quarkus.langchain4j.milvus.devservices.port`]## + +[.description] +-- +Optional fixed port the Milvus dev service will listen to. If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-shared[`quarkus.langchain4j.milvus.devservices.shared`]## + +[.description] +-- +Indicates if the Dev Service containers managed by Quarkus for Milvus are shared. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-devservices-service-name[`quarkus.langchain4j.milvus.devservices.service-name`]## + +[.description] +-- +Service label to apply to created Dev Services containers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`milvus` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-host]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-host[`quarkus.langchain4j.milvus.host`]## + +[.description] +-- +The URL of the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-port]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-port[`quarkus.langchain4j.milvus.port`]## + +[.description] +-- +The port of the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-token]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-token[`quarkus.langchain4j.milvus.token`]## + +[.description] +-- +The authentication token for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-username]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-username[`quarkus.langchain4j.milvus.username`]## + +[.description] +-- +The username for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-password]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-password[`quarkus.langchain4j.milvus.password`]## + +[.description] +-- +The password for the Milvus server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-timeout]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-timeout[`quarkus.langchain4j.milvus.timeout`]## + +[.description] +-- +The timeout duration for the Milvus client. If not specified, 5 seconds will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_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]] +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-db-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-db-name[`quarkus.langchain4j.milvus.db-name`]## + +[.description] +-- +Name of the database. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DB_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DB_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`default` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-create-collection]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-create-collection[`quarkus.langchain4j.milvus.create-collection`]## + +[.description] +-- +Create the collection if it does not exist yet. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_CREATE_COLLECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CREATE_COLLECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-collection-name]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-collection-name[`quarkus.langchain4j.milvus.collection-name`]## + +[.description] +-- +Name of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_COLLECTION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_COLLECTION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embeddings` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-dimension]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-dimension[`quarkus.langchain4j.milvus.dimension`]## + +[.description] +-- +Dimension of the vectors. Only applicable when the collection yet has to be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-primary-field]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-primary-field[`quarkus.langchain4j.milvus.primary-field`]## + +[.description] +-- +TODO + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_PRIMARY_FIELD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_PRIMARY_FIELD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`id` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-vector-field]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-vector-field[`quarkus.langchain4j.milvus.vector-field`]## + +[.description] +-- +Name of the field to store the vector in. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_VECTOR_FIELD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_VECTOR_FIELD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vector` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-description]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-description[`quarkus.langchain4j.milvus.description`]## + +[.description] +-- +Description of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_DESCRIPTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_DESCRIPTION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-index-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-index-type[`quarkus.langchain4j.milvus.index-type`]## + +[.description] +-- +The index type to use for the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_INDEX_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|IndexType +|`flat` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-metric-type[`quarkus.langchain4j.milvus.metric-type`]## + +[.description] +-- +The metric type to use for searching. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_METRIC_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|MetricType +|`cosine` + +a| [[quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level]] [.property-path]##link:#quarkus-langchain4j-milvus_quarkus-langchain4j-milvus-consistency-level[`quarkus.langchain4j.milvus.consistency-level`]## + +[.description] +-- +The consistency level. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MILVUS_CONSISTENCY_LEVEL+++` +endif::add-copy-button-to-env-var[] +-- +a|ConsistencyLevelEnum +|`eventually` + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-milvus_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-mistral-ai.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai.adoc new file mode 100644 index 000000000..e45d66a69 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai.adoc @@ -0,0 +1,662 @@ +:summaryTableId: quarkus-langchain4j-mistral-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-enabled[`quarkus.langchain4j.mistralai.chat-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_MISTRALAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-enabled[`quarkus.langchain4j.mistralai.embedding-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_MISTRALAI_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-base-url]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-base-url[`quarkus.langchain4j.mistralai.base-url`]## + +[.description] +-- +Base URL of Mistral API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.mistral.ai/v1/` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-api-key]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-api-key[`quarkus.langchain4j.mistralai.api-key`]## + +[.description] +-- +Mistral API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-timeout]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-timeout[`quarkus.langchain4j.mistralai.timeout`]## + +[.description] +-- +Timeout for Mistral calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_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]] +|`10s` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-model-name[`quarkus.langchain4j.mistralai.chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-tiny` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-temperature[`quarkus.langchain4j.mistralai.chat-model.temperature`]## + +[.description] +-- +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_MISTRALAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-max-tokens[`quarkus.langchain4j.mistralai.chat-model.max-tokens`]## + +[.description] +-- +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_MISTRALAI_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-top-p[`quarkus.langchain4j.mistralai.chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-safe-prompt]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-safe-prompt[`quarkus.langchain4j.mistralai.chat-model.safe-prompt`]## + +[.description] +-- +Whether to inject a safety prompt before all conversations + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_SAFE_PROMPT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_SAFE_PROMPT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-random-seed[`quarkus.langchain4j.mistralai.chat-model.random-seed`]## + +[.description] +-- +The seed to use for random sampling. If set, different calls will generate deterministic results. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-requests[`quarkus.langchain4j.mistralai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-responses[`quarkus.langchain4j.mistralai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-model-name[`quarkus.langchain4j.mistralai.embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-embed` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-requests[`quarkus.langchain4j.mistralai.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-responses[`quarkus.langchain4j.mistralai.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-requests[`quarkus.langchain4j.mistralai.log-requests`]## + +[.description] +-- +Whether the Mistral client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-responses[`quarkus.langchain4j.mistralai.log-responses`]## + +[.description] +-- +Whether the Mistral client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-enable-integration[`quarkus.langchain4j.mistralai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Mistral AI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +h|[[quarkus-langchain4j-mistral-ai_section_quarkus-langchain4j-mistralai]] [.section-name.section-level0]##link:#quarkus-langchain4j-mistral-ai_section_quarkus-langchain4j-mistralai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-base-url[`quarkus.langchain4j.mistralai."model-name".base-url`]## + +[.description] +-- +Base URL of Mistral API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.mistral.ai/v1/` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-api-key[`quarkus.langchain4j.mistralai."model-name".api-key`]## + +[.description] +-- +Mistral API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-timeout[`quarkus.langchain4j.mistralai."model-name".timeout`]## + +[.description] +-- +Timeout for Mistral calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-model-name[`quarkus.langchain4j.mistralai."model-name".chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-tiny` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-temperature[`quarkus.langchain4j.mistralai."model-name".chat-model.temperature`]## + +[.description] +-- +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_MISTRALAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-max-tokens[`quarkus.langchain4j.mistralai."model-name".chat-model.max-tokens`]## + +[.description] +-- +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_MISTRALAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-top-p[`quarkus.langchain4j.mistralai."model-name".chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-safe-prompt]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-safe-prompt[`quarkus.langchain4j.mistralai."model-name".chat-model.safe-prompt`]## + +[.description] +-- +Whether to inject a safety prompt before all conversations + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_SAFE_PROMPT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_SAFE_PROMPT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-random-seed[`quarkus.langchain4j.mistralai."model-name".chat-model.random-seed`]## + +[.description] +-- +The seed to use for random sampling. If set, different calls will generate deterministic results. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-requests[`quarkus.langchain4j.mistralai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-responses[`quarkus.langchain4j.mistralai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-model-name[`quarkus.langchain4j.mistralai."model-name".embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-embed` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-requests[`quarkus.langchain4j.mistralai."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-responses[`quarkus.langchain4j.mistralai."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-requests[`quarkus.langchain4j.mistralai."model-name".log-requests`]## + +[.description] +-- +Whether the Mistral client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-responses[`quarkus.langchain4j.mistralai."model-name".log-responses`]## + +[.description] +-- +Whether the Mistral client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-enable-integration[`quarkus.langchain4j.mistralai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Mistral AI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-mistral-ai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-mistral-ai_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai_quarkus.langchain4j.adoc new file mode 100644 index 000000000..e45d66a69 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-mistral-ai_quarkus.langchain4j.adoc @@ -0,0 +1,662 @@ +:summaryTableId: quarkus-langchain4j-mistral-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-enabled[`quarkus.langchain4j.mistralai.chat-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_MISTRALAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-enabled[`quarkus.langchain4j.mistralai.embedding-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_MISTRALAI_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-base-url]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-base-url[`quarkus.langchain4j.mistralai.base-url`]## + +[.description] +-- +Base URL of Mistral API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.mistral.ai/v1/` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-api-key]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-api-key[`quarkus.langchain4j.mistralai.api-key`]## + +[.description] +-- +Mistral API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-timeout]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-timeout[`quarkus.langchain4j.mistralai.timeout`]## + +[.description] +-- +Timeout for Mistral calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_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]] +|`10s` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-model-name[`quarkus.langchain4j.mistralai.chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-tiny` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-temperature[`quarkus.langchain4j.mistralai.chat-model.temperature`]## + +[.description] +-- +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_MISTRALAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-max-tokens[`quarkus.langchain4j.mistralai.chat-model.max-tokens`]## + +[.description] +-- +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_MISTRALAI_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-top-p[`quarkus.langchain4j.mistralai.chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-safe-prompt]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-safe-prompt[`quarkus.langchain4j.mistralai.chat-model.safe-prompt`]## + +[.description] +-- +Whether to inject a safety prompt before all conversations + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_SAFE_PROMPT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_SAFE_PROMPT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-random-seed[`quarkus.langchain4j.mistralai.chat-model.random-seed`]## + +[.description] +-- +The seed to use for random sampling. If set, different calls will generate deterministic results. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-requests[`quarkus.langchain4j.mistralai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-chat-model-log-responses[`quarkus.langchain4j.mistralai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-model-name[`quarkus.langchain4j.mistralai.embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-embed` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-requests[`quarkus.langchain4j.mistralai.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-embedding-model-log-responses[`quarkus.langchain4j.mistralai.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-requests[`quarkus.langchain4j.mistralai.log-requests`]## + +[.description] +-- +Whether the Mistral client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-log-responses[`quarkus.langchain4j.mistralai.log-responses`]## + +[.description] +-- +Whether the Mistral client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-enable-integration[`quarkus.langchain4j.mistralai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Mistral AI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +h|[[quarkus-langchain4j-mistral-ai_section_quarkus-langchain4j-mistralai]] [.section-name.section-level0]##link:#quarkus-langchain4j-mistral-ai_section_quarkus-langchain4j-mistralai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-base-url[`quarkus.langchain4j.mistralai."model-name".base-url`]## + +[.description] +-- +Base URL of Mistral API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.mistral.ai/v1/` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-api-key[`quarkus.langchain4j.mistralai."model-name".api-key`]## + +[.description] +-- +Mistral API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-timeout[`quarkus.langchain4j.mistralai."model-name".timeout`]## + +[.description] +-- +Timeout for Mistral calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-model-name[`quarkus.langchain4j.mistralai."model-name".chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-tiny` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-temperature[`quarkus.langchain4j.mistralai."model-name".chat-model.temperature`]## + +[.description] +-- +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_MISTRALAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.7` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-max-tokens[`quarkus.langchain4j.mistralai."model-name".chat-model.max-tokens`]## + +[.description] +-- +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_MISTRALAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-top-p[`quarkus.langchain4j.mistralai."model-name".chat-model.top-p`]## + +[.description] +-- +Double (0.0-1.0). Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + +It is generally recommended to set this or the `temperature` property but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-safe-prompt]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-safe-prompt[`quarkus.langchain4j.mistralai."model-name".chat-model.safe-prompt`]## + +[.description] +-- +Whether to inject a safety prompt before all conversations + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_SAFE_PROMPT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_SAFE_PROMPT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-random-seed[`quarkus.langchain4j.mistralai."model-name".chat-model.random-seed`]## + +[.description] +-- +The seed to use for random sampling. If set, different calls will generate deterministic results. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-requests[`quarkus.langchain4j.mistralai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-chat-model-log-responses[`quarkus.langchain4j.mistralai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-model-name[`quarkus.langchain4j.mistralai."model-name".embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistral-embed` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-requests[`quarkus.langchain4j.mistralai."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-embedding-model-log-responses[`quarkus.langchain4j.mistralai."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-requests[`quarkus.langchain4j.mistralai."model-name".log-requests`]## + +[.description] +-- +Whether the Mistral client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-log-responses[`quarkus.langchain4j.mistralai."model-name".log-responses`]## + +[.description] +-- +Whether the Mistral client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-mistral-ai_quarkus-langchain4j-mistralai-model-name-enable-integration[`quarkus.langchain4j.mistralai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Mistral AI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_MISTRALAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-mistral-ai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-neo4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j.adoc index 8f6bb7974..72d870d5d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j.adoc @@ -1,153 +1,150 @@ - -:summaryTableId: quarkus-langchain4j-neo4j +:summaryTableId: quarkus-langchain4j-neo4j_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-neo4j_configuration]]link:#quarkus-langchain4j-neo4j_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension[quarkus.langchain4j.neo4j.dimension]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension[`quarkus.langchain4j.neo4j.dimension`]## [.description] -- Dimension of the embeddings that will be stored in the Neo4j store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_DIMENSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_DIMENSION+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label[quarkus.langchain4j.neo4j.label]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label[`quarkus.langchain4j.neo4j.label`]## [.description] -- Label for the created nodes. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_LABEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_LABEL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`Document` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property[quarkus.langchain4j.neo4j.embedding-property]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property[`quarkus.langchain4j.neo4j.embedding-property`]## [.description] -- Name of the property to store the embedding vectors. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_EMBEDDING_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_EMBEDDING_PROPERTY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`embedding` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property[quarkus.langchain4j.neo4j.id-property]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property[`quarkus.langchain4j.neo4j.id-property`]## [.description] -- Name of the property to store embedding IDs. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_ID_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_ID_PROPERTY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`id` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix[quarkus.langchain4j.neo4j.metadata-prefix]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix[`quarkus.langchain4j.neo4j.metadata-prefix`]## [.description] -- Prefix to be added to the metadata keys. By default, no prefix is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_METADATA_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_METADATA_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property[quarkus.langchain4j.neo4j.text-property]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property[`quarkus.langchain4j.neo4j.text-property`]## [.description] -- Name of the property to store the embedding text. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_TEXT_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_TEXT_PROPERTY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name[quarkus.langchain4j.neo4j.index-name]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name[`quarkus.langchain4j.neo4j.index-name`]## [.description] -- Name of the index to be created for vector search. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_INDEX_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_INDEX_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`vector` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name[quarkus.langchain4j.neo4j.database-name]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name[`quarkus.langchain4j.neo4j.database-name`]## [.description] -- Name of the database to connect to. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_DATABASE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_DATABASE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`neo4j` - -a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query]]`link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query[quarkus.langchain4j.neo4j.retrieval-query]` - +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query[`quarkus.langchain4j.neo4j.retrieval-query`]## [.description] -- @@ -159,13 +156,18 @@ The query to use when retrieving embeddings. This query has to return the follow - column of the same name as the 'text-property' value - column of the same name as the 'embedding-property' value + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_RETRIEVAL_QUERY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_RETRIEVAL_QUERY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`RETURN properties(node) AS metadata, node.${quarkus.langchain4j.neo4j.id-property} AS ${quarkus.langchain4j.neo4j.id-property}, node.${quarkus.langchain4j.neo4j.text-property} AS ${quarkus.langchain4j.neo4j.text-property}, node.${quarkus.langchain4j.neo4j.embedding-property} AS ${quarkus.langchain4j.neo4j.embedding-property}, score` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j_quarkus.langchain4j.adoc new file mode 100644 index 000000000..72d870d5d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-neo4j_quarkus.langchain4j.adoc @@ -0,0 +1,173 @@ +:summaryTableId: quarkus-langchain4j-neo4j_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|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-dimension[`quarkus.langchain4j.neo4j.dimension`]## + +[.description] +-- +Dimension of the embeddings that will be stored in the Neo4j store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|int +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-label[`quarkus.langchain4j.neo4j.label`]## + +[.description] +-- +Label for the created nodes. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_LABEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_LABEL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`Document` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-embedding-property[`quarkus.langchain4j.neo4j.embedding-property`]## + +[.description] +-- +Name of the property to store the embedding vectors. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_EMBEDDING_PROPERTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_EMBEDDING_PROPERTY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embedding` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-id-property[`quarkus.langchain4j.neo4j.id-property`]## + +[.description] +-- +Name of the property to store embedding IDs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_ID_PROPERTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_ID_PROPERTY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`id` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-metadata-prefix[`quarkus.langchain4j.neo4j.metadata-prefix`]## + +[.description] +-- +Prefix to be added to the metadata keys. By default, no prefix is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_METADATA_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_METADATA_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-text-property[`quarkus.langchain4j.neo4j.text-property`]## + +[.description] +-- +Name of the property to store the embedding text. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_TEXT_PROPERTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_TEXT_PROPERTY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-index-name[`quarkus.langchain4j.neo4j.index-name`]## + +[.description] +-- +Name of the index to be created for vector search. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_INDEX_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_INDEX_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vector` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-database-name[`quarkus.langchain4j.neo4j.database-name`]## + +[.description] +-- +Name of the database to connect to. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_DATABASE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_DATABASE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`neo4j` + +a| [[quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query]] [.property-path]##link:#quarkus-langchain4j-neo4j_quarkus-langchain4j-neo4j-retrieval-query[`quarkus.langchain4j.neo4j.retrieval-query`]## + +[.description] +-- +The query to use when retrieving embeddings. This query has to return the following columns: + + - metadata + - score + - column of the same name as the 'id-property' value + - column of the same name as the 'text-property' value + - column of the same name as the 'embedding-property' value + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_NEO4J_RETRIEVAL_QUERY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_NEO4J_RETRIEVAL_QUERY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`RETURN properties(node) AS metadata, node.${quarkus.langchain4j.neo4j.id-property} AS ${quarkus.langchain4j.neo4j.id-property}, node.${quarkus.langchain4j.neo4j.text-property} AS ${quarkus.langchain4j.neo4j.text-property}, node.${quarkus.langchain4j.neo4j.embedding-property} AS ${quarkus.langchain4j.neo4j.embedding-property}, score` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider.adoc new file mode 100644 index 000000000..3eb24e09f --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-langchain4j-oidc-model-auth-provider_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-oidc-model-auth-provider_quarkus-langchain4j-oidc-model-auth-provider-enabled]] [.property-path]##link:#quarkus-langchain4j-oidc-model-auth-provider_quarkus-langchain4j-oidc-model-auth-provider-enabled[`quarkus.langchain4j.oidc-model-auth-provider.enabled`]## + +[.description] +-- +Whether the OIDC ModelAuthProvider should be enabled + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OIDC_MODEL_AUTH_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OIDC_MODEL_AUTH_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider_quarkus.langchain4j.adoc new file mode 100644 index 000000000..3eb24e09f --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-oidc-model-auth-provider_quarkus.langchain4j.adoc @@ -0,0 +1,31 @@ +:summaryTableId: quarkus-langchain4j-oidc-model-auth-provider_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-oidc-model-auth-provider_quarkus-langchain4j-oidc-model-auth-provider-enabled]] [.property-path]##link:#quarkus-langchain4j-oidc-model-auth-provider_quarkus-langchain4j-oidc-model-auth-provider-enabled[`quarkus.langchain4j.oidc-model-auth-provider.enabled`]## + +[.description] +-- +Whether the OIDC ModelAuthProvider should be enabled + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OIDC_MODEL_AUTH_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OIDC_MODEL_AUTH_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices.adoc new file mode 100644 index 000000000..ad0df49ae --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices.adoc @@ -0,0 +1,65 @@ +:summaryTableId: quarkus-langchain4j-ollama-devservices_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-enabled[`quarkus.langchain4j.ollama.devservices.enabled`]## + +[.description] +-- +If Dev Services for OLlama has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-image-name[`quarkus.langchain4j.ollama.devservices.image-name`]## + +[.description] +-- +The OLlama container image to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ollama/ollama:latest` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-model]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-model[`quarkus.langchain4j.ollama.devservices.model`]## + +[.description] +-- +Model to install. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`orca-mini` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices_quarkus.langchain4j.adoc new file mode 100644 index 000000000..ad0df49ae --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama-devservices_quarkus.langchain4j.adoc @@ -0,0 +1,65 @@ +:summaryTableId: quarkus-langchain4j-ollama-devservices_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-enabled[`quarkus.langchain4j.ollama.devservices.enabled`]## + +[.description] +-- +If Dev Services for OLlama has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-image-name]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-image-name[`quarkus.langchain4j.ollama.devservices.image-name`]## + +[.description] +-- +The OLlama container image to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ollama/ollama:latest` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-model]] [.property-path]##link:#quarkus-langchain4j-ollama-devservices_quarkus-langchain4j-ollama-devservices-model[`quarkus.langchain4j.ollama.devservices.model`]## + +[.description] +-- +Model to install. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_MODEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_DEVSERVICES_MODEL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`orca-mini` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama.adoc index 7b82a996e..736d39089 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama.adoc @@ -1,256 +1,269 @@ - -:summaryTableId: quarkus-langchain4j-ollama +:summaryTableId: quarkus-langchain4j-ollama_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-ollama_configuration]]link:#quarkus-langchain4j-ollama_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled[quarkus.langchain4j.ollama.chat-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled[`quarkus.langchain4j.ollama.chat-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_OLLAMA_CHAT_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled[quarkus.langchain4j.ollama.embedding-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled[`quarkus.langchain4j.ollama.embedding-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_OLLAMA_EMBEDDING_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id[quarkus.langchain4j.ollama.chat-model.model-id]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id[`quarkus.langchain4j.ollama.chat-model.model-id`]## [.description] -- Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `llama3` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`llama3.1` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id[quarkus.langchain4j.ollama.embedding-model.model-id]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id[`quarkus.langchain4j.ollama.embedding-model.model-id`]## [.description] -- Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `nomic-embed-text` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`nomic-embed-text` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url[quarkus.langchain4j.ollama.base-url]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url[`quarkus.langchain4j.ollama.base-url`]## [.description] -- Base URL where the Ollama serving is running + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-tls-configuration-name[`quarkus.langchain4j.ollama.tls-configuration-name`]## -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout[quarkus.langchain4j.ollama.timeout]` +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout[`quarkus.langchain4j.ollama.timeout`]## [.description] -- Timeout for Ollama calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_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-ollama_quarkus-langchain4j-ollama-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-requests[quarkus.langchain4j.ollama.log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-requests[`quarkus.langchain4j.ollama.log-requests`]## [.description] -- Whether the Ollama client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses[quarkus.langchain4j.ollama.log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses[`quarkus.langchain4j.ollama.log-responses`]## [.description] -- Whether the Ollama client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration[quarkus.langchain4j.ollama.enable-integration]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration[`quarkus.langchain4j.ollama.enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature[quarkus.langchain4j.ollama.chat-model.temperature]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature[`quarkus.langchain4j.ollama.chat-model.temperature`]## [.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.8` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict[quarkus.langchain4j.ollama.chat-model.num-predict]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict[`quarkus.langchain4j.ollama.chat-model.num-predict`]## [.description] -- Maximum number of tokens to predict when generating text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_NUM_PREDICT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_NUM_PREDICT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop[quarkus.langchain4j.ollama.chat-model.stop]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop[`quarkus.langchain4j.ollama.chat-model.stop`]## [.description] -- Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p[quarkus.langchain4j.ollama.chat-model.top-p]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p[`quarkus.langchain4j.ollama.chat-model.top-p`]## [.description] -- Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.9` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k[quarkus.langchain4j.ollama.chat-model.top-k]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k[`quarkus.langchain4j.ollama.chat-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed[quarkus.langchain4j.ollama.chat-model.seed]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed[`quarkus.langchain4j.ollama.chat-model.seed`]## [.description] -- @@ -262,398 +275,413 @@ With a static number the result is always the same. With a random number the res `Random random = new Random(); int x = random.nextInt(Integer.MAX_VALUE);` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_SEED+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format[quarkus.langchain4j.ollama.chat-model.format]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format[`quarkus.langchain4j.ollama.chat-model.format`]## [.description] -- the format to return a response in. Currently, the only accepted value is `json` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests[quarkus.langchain4j.ollama.chat-model.log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests[`quarkus.langchain4j.ollama.chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses[quarkus.langchain4j.ollama.chat-model.log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses[`quarkus.langchain4j.ollama.chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature[quarkus.langchain4j.ollama.embedding-model.temperature]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature[`quarkus.langchain4j.ollama.embedding-model.temperature`]## [.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.8` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict[quarkus.langchain4j.ollama.embedding-model.num-predict]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict[`quarkus.langchain4j.ollama.embedding-model.num-predict`]## [.description] -- Maximum number of tokens to predict when generating text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_NUM_PREDICT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_NUM_PREDICT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`128` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop[quarkus.langchain4j.ollama.embedding-model.stop]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop[`quarkus.langchain4j.ollama.embedding-model.stop`]## [.description] -- Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p[quarkus.langchain4j.ollama.embedding-model.top-p]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p[`quarkus.langchain4j.ollama.embedding-model.top-p`]## [.description] -- Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.9` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k[quarkus.langchain4j.ollama.embedding-model.top-k]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k[`quarkus.langchain4j.ollama.embedding-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests[quarkus.langchain4j.ollama.embedding-model.log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests[`quarkus.langchain4j.ollama.embedding-model.log-requests`]## [.description] -- Whether embedding model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses[quarkus.langchain4j.ollama.embedding-model.log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses[`quarkus.langchain4j.ollama.embedding-model.log-responses`]## [.description] -- Whether embedding model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -h|[[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-named-config-named-model-config]]link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-named-config-named-model-config[Named model config] - +h|[[quarkus-langchain4j-ollama_section_quarkus-langchain4j-ollama]] [.section-name.section-level0]##link:#quarkus-langchain4j-ollama_section_quarkus-langchain4j-ollama[Named model config]## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id[quarkus.langchain4j.ollama."model-name".chat-model.model-id]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id[`quarkus.langchain4j.ollama."model-name".chat-model.model-id`]## [.description] -- Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `llama3` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`llama3.1` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id[quarkus.langchain4j.ollama."model-name".embedding-model.model-id]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id[`quarkus.langchain4j.ollama."model-name".embedding-model.model-id`]## [.description] -- Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `nomic-embed-text` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`nomic-embed-text` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url[quarkus.langchain4j.ollama."model-name".base-url]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url[`quarkus.langchain4j.ollama."model-name".base-url`]## [.description] -- Base URL where the Ollama serving is running + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-tls-configuration-name[`quarkus.langchain4j.ollama."model-name".tls-configuration-name`]## -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout[quarkus.langchain4j.ollama."model-name".timeout]` +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout[`quarkus.langchain4j.ollama."model-name".timeout`]## + [.description] -- Timeout for Ollama calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__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-ollama_quarkus-langchain4j-ollama-model-name-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-requests[quarkus.langchain4j.ollama."model-name".log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-requests[`quarkus.langchain4j.ollama."model-name".log-requests`]## [.description] -- Whether the Ollama client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses[quarkus.langchain4j.ollama."model-name".log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses[`quarkus.langchain4j.ollama."model-name".log-responses`]## [.description] -- Whether the Ollama client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration[quarkus.langchain4j.ollama."model-name".enable-integration]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration[`quarkus.langchain4j.ollama."model-name".enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature[quarkus.langchain4j.ollama."model-name".chat-model.temperature]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature[`quarkus.langchain4j.ollama."model-name".chat-model.temperature`]## [.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.8` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict[quarkus.langchain4j.ollama."model-name".chat-model.num-predict]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict[`quarkus.langchain4j.ollama."model-name".chat-model.num-predict`]## [.description] -- Maximum number of tokens to predict when generating text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_NUM_PREDICT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_NUM_PREDICT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop[quarkus.langchain4j.ollama."model-name".chat-model.stop]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop[`quarkus.langchain4j.ollama."model-name".chat-model.stop`]## [.description] -- Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p[quarkus.langchain4j.ollama."model-name".chat-model.top-p]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p[`quarkus.langchain4j.ollama."model-name".chat-model.top-p`]## [.description] -- Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.9` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k[quarkus.langchain4j.ollama."model-name".chat-model.top-k]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k[`quarkus.langchain4j.ollama."model-name".chat-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed[quarkus.langchain4j.ollama."model-name".chat-model.seed]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed[`quarkus.langchain4j.ollama."model-name".chat-model.seed`]## [.description] -- @@ -665,189 +693,193 @@ With a static number the result is always the same. With a random number the res `Random random = new Random(); int x = random.nextInt(Integer.MAX_VALUE);` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_SEED+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format[quarkus.langchain4j.ollama."model-name".chat-model.format]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format[`quarkus.langchain4j.ollama."model-name".chat-model.format`]## [.description] -- the format to return a response in. Currently, the only accepted value is `json` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests[quarkus.langchain4j.ollama."model-name".chat-model.log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests[`quarkus.langchain4j.ollama."model-name".chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses[quarkus.langchain4j.ollama."model-name".chat-model.log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses[`quarkus.langchain4j.ollama."model-name".chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature[quarkus.langchain4j.ollama."model-name".embedding-model.temperature]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature[`quarkus.langchain4j.ollama."model-name".embedding-model.temperature`]## [.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.8` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict[quarkus.langchain4j.ollama."model-name".embedding-model.num-predict]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict[`quarkus.langchain4j.ollama."model-name".embedding-model.num-predict`]## [.description] -- Maximum number of tokens to predict when generating text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_NUM_PREDICT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_NUM_PREDICT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`128` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop[quarkus.langchain4j.ollama."model-name".embedding-model.stop]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop[`quarkus.langchain4j.ollama."model-name".embedding-model.stop`]## [.description] -- Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p[quarkus.langchain4j.ollama."model-name".embedding-model.top-p]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p[`quarkus.langchain4j.ollama."model-name".embedding-model.top-p`]## [.description] -- Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0.9` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k[quarkus.langchain4j.ollama."model-name".embedding-model.top-k]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k[`quarkus.langchain4j.ollama."model-name".embedding-model.top-k`]## [.description] -- Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`40` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests[quarkus.langchain4j.ollama."model-name".embedding-model.log-requests]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests[`quarkus.langchain4j.ollama."model-name".embedding-model.log-requests`]## [.description] -- Whether embedding model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses]]`link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses[quarkus.langchain4j.ollama."model-name".embedding-model.log-responses]` - +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses[`quarkus.langchain4j.ollama."model-name".embedding-model.log-responses`]## [.description] -- Whether embedding model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_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-ollama_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -864,3 +896,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-ollama_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama_quarkus.langchain4j.adoc new file mode 100644 index 000000000..736d39089 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-ollama_quarkus.langchain4j.adoc @@ -0,0 +1,900 @@ +:summaryTableId: quarkus-langchain4j-ollama_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-enabled[`quarkus.langchain4j.ollama.chat-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_OLLAMA_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-enabled[`quarkus.langchain4j.ollama.embedding-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_OLLAMA_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-model-id[`quarkus.langchain4j.ollama.chat-model.model-id`]## + +[.description] +-- +Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `llama3` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`llama3.1` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-model-id[`quarkus.langchain4j.ollama.embedding-model.model-id`]## + +[.description] +-- +Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `nomic-embed-text` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`nomic-embed-text` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-base-url[`quarkus.langchain4j.ollama.base-url`]## + +[.description] +-- +Base URL where the Ollama serving is running + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-tls-configuration-name[`quarkus.langchain4j.ollama.tls-configuration-name`]## + +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-timeout[`quarkus.langchain4j.ollama.timeout`]## + +[.description] +-- +Timeout for Ollama calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_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]] +|`10s` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-requests[`quarkus.langchain4j.ollama.log-requests`]## + +[.description] +-- +Whether the Ollama client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-log-responses[`quarkus.langchain4j.ollama.log-responses`]## + +[.description] +-- +Whether the Ollama client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-enable-integration[`quarkus.langchain4j.ollama.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-temperature[`quarkus.langchain4j.ollama.chat-model.temperature`]## + +[.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.8` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-num-predict[`quarkus.langchain4j.ollama.chat-model.num-predict`]## + +[.description] +-- +Maximum number of tokens to predict when generating text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_NUM_PREDICT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_NUM_PREDICT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-stop[`quarkus.langchain4j.ollama.chat-model.stop`]## + +[.description] +-- +Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-p[`quarkus.langchain4j.ollama.chat-model.top-p`]## + +[.description] +-- +Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.9` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-top-k[`quarkus.langchain4j.ollama.chat-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-seed[`quarkus.langchain4j.ollama.chat-model.seed`]## + +[.description] +-- +With a static number the result is always the same. With a random number the result varies Example: + +``` +``` + +`Random random = new Random(); +int x = random.nextInt(Integer.MAX_VALUE);` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-format[`quarkus.langchain4j.ollama.chat-model.format`]## + +[.description] +-- +the format to return a response in. Currently, the only accepted value is `json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-requests[`quarkus.langchain4j.ollama.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-chat-model-log-responses[`quarkus.langchain4j.ollama.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-temperature[`quarkus.langchain4j.ollama.embedding-model.temperature`]## + +[.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.8` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-num-predict[`quarkus.langchain4j.ollama.embedding-model.num-predict`]## + +[.description] +-- +Maximum number of tokens to predict when generating text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_NUM_PREDICT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_NUM_PREDICT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`128` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-stop[`quarkus.langchain4j.ollama.embedding-model.stop`]## + +[.description] +-- +Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-p[`quarkus.langchain4j.ollama.embedding-model.top-p`]## + +[.description] +-- +Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.9` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-top-k[`quarkus.langchain4j.ollama.embedding-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-requests[`quarkus.langchain4j.ollama.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-embedding-model-log-responses[`quarkus.langchain4j.ollama.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-ollama_section_quarkus-langchain4j-ollama]] [.section-name.section-level0]##link:#quarkus-langchain4j-ollama_section_quarkus-langchain4j-ollama[Named model config]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-model-id[`quarkus.langchain4j.ollama."model-name".chat-model.model-id`]## + +[.description] +-- +Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `llama3` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`llama3.1` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-model-id[`quarkus.langchain4j.ollama."model-name".embedding-model.model-id`]## + +[.description] +-- +Model to use. According to link:https://github.com/jmorganca/ollama/blob/main/docs/api.md#model-names[Ollama docs], the default value is `nomic-embed-text` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`nomic-embed-text` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-base-url[`quarkus.langchain4j.ollama."model-name".base-url`]## + +[.description] +-- +Base URL where the Ollama serving is running + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-tls-configuration-name[`quarkus.langchain4j.ollama."model-name".tls-configuration-name`]## + +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-timeout[`quarkus.langchain4j.ollama."model-name".timeout`]## + +[.description] +-- +Timeout for Ollama calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-requests[`quarkus.langchain4j.ollama."model-name".log-requests`]## + +[.description] +-- +Whether the Ollama client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-log-responses[`quarkus.langchain4j.ollama."model-name".log-responses`]## + +[.description] +-- +Whether the Ollama client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-enable-integration[`quarkus.langchain4j.ollama."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-temperature[`quarkus.langchain4j.ollama."model-name".chat-model.temperature`]## + +[.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.8` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-num-predict[`quarkus.langchain4j.ollama."model-name".chat-model.num-predict`]## + +[.description] +-- +Maximum number of tokens to predict when generating text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_NUM_PREDICT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_NUM_PREDICT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-stop[`quarkus.langchain4j.ollama."model-name".chat-model.stop`]## + +[.description] +-- +Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-p[`quarkus.langchain4j.ollama."model-name".chat-model.top-p`]## + +[.description] +-- +Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.9` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-top-k[`quarkus.langchain4j.ollama."model-name".chat-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-seed[`quarkus.langchain4j.ollama."model-name".chat-model.seed`]## + +[.description] +-- +With a static number the result is always the same. With a random number the result varies Example: + +``` +``` + +`Random random = new Random(); +int x = random.nextInt(Integer.MAX_VALUE);` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-format[`quarkus.langchain4j.ollama."model-name".chat-model.format`]## + +[.description] +-- +the format to return a response in. Currently, the only accepted value is `json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-requests[`quarkus.langchain4j.ollama."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-chat-model-log-responses[`quarkus.langchain4j.ollama."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-temperature[`quarkus.langchain4j.ollama."model-name".embedding-model.temperature`]## + +[.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.8` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-num-predict[`quarkus.langchain4j.ollama."model-name".embedding-model.num-predict`]## + +[.description] +-- +Maximum number of tokens to predict when generating text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_NUM_PREDICT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_NUM_PREDICT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`128` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-stop[`quarkus.langchain4j.ollama."model-name".embedding-model.stop`]## + +[.description] +-- +Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-p[`quarkus.langchain4j.ollama."model-name".embedding-model.top-p`]## + +[.description] +-- +Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.9` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-top-k[`quarkus.langchain4j.ollama."model-name".embedding-model.top-k`]## + +[.description] +-- +Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-requests[`quarkus.langchain4j.ollama."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-ollama_quarkus-langchain4j-ollama-model-name-embedding-model-log-responses[`quarkus.langchain4j.ollama."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OLLAMA__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-ollama_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-openai.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai.adoc index f1d75b9cd..b70634da0 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai.adoc @@ -1,613 +1,626 @@ - -:summaryTableId: quarkus-langchain4j-openai +:summaryTableId: quarkus-langchain4j-openai_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-openai_configuration]]link:#quarkus-langchain4j-openai_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled[quarkus.langchain4j.openai.chat-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled[`quarkus.langchain4j.openai.chat-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_OPENAI_CHAT_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled[quarkus.langchain4j.openai.embedding-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled[`quarkus.langchain4j.openai.embedding-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_OPENAI_EMBEDDING_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled[quarkus.langchain4j.openai.moderation-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled[`quarkus.langchain4j.openai.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_OPENAI_MODERATION_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled[quarkus.langchain4j.openai.image-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled[`quarkus.langchain4j.openai.image-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_OPENAI_IMAGE_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url[quarkus.langchain4j.openai.base-url]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url[`quarkus.langchain4j.openai.base-url`]## [.description] -- Base URL of OpenAI API + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://api.openai.com/v1/` +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-tls-configuration-name[`quarkus.langchain4j.openai.tls-configuration-name`]## + +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key[quarkus.langchain4j.openai.api-key]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key[`quarkus.langchain4j.openai.api-key`]## [.description] -- OpenAI API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id[quarkus.langchain4j.openai.organization-id]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id[`quarkus.langchain4j.openai.organization-id`]## [.description] -- OpenAI Organization ID (https://platform.openai.com/docs/api-reference/organization-optional) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_ORGANIZATION_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_ORGANIZATION_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout[quarkus.langchain4j.openai.timeout]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout[`quarkus.langchain4j.openai.timeout`]## [.description] -- Timeout for OpenAI calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_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-openai_quarkus-langchain4j-openai-max-retries]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-max-retries[quarkus.langchain4j.openai.max-retries]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-max-retries]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-max-retries[`quarkus.langchain4j.openai.max-retries`]## [.description] -- The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests[quarkus.langchain4j.openai.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests[`quarkus.langchain4j.openai.log-requests`]## [.description] -- Whether the OpenAI client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses[quarkus.langchain4j.openai.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses[`quarkus.langchain4j.openai.log-responses`]## [.description] -- Whether the OpenAI client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration[quarkus.langchain4j.openai.enable-integration]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration[`quarkus.langchain4j.openai.enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type[quarkus.langchain4j.openai.proxy-type]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type[`quarkus.langchain4j.openai.proxy-type`]## [.description] -- The Proxy type + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`HTTP` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host[quarkus.langchain4j.openai.proxy-host]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host[`quarkus.langchain4j.openai.proxy-host`]## [.description] -- The Proxy host + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_HOST+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port[quarkus.langchain4j.openai.proxy-port]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port[`quarkus.langchain4j.openai.proxy-port`]## [.description] -- The Proxy port + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`3128` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name[quarkus.langchain4j.openai.chat-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name[`quarkus.langchain4j.openai.chat-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`gpt-4o-mini` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature[quarkus.langchain4j.openai.chat-model.temperature]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature[`quarkus.langchain4j.openai.chat-model.temperature`]## [.description] -- What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p[quarkus.langchain4j.openai.chat-model.top-p]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p[`quarkus.langchain4j.openai.chat-model.top-p`]## [.description] -- An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens[quarkus.langchain4j.openai.chat-model.max-tokens]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens[`quarkus.langchain4j.openai.chat-model.max-tokens`]## [.description] -- The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty[quarkus.langchain4j.openai.chat-model.presence-penalty]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty[`quarkus.langchain4j.openai.chat-model.presence-penalty`]## [.description] -- Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty[quarkus.langchain4j.openai.chat-model.frequency-penalty]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty[`quarkus.langchain4j.openai.chat-model.frequency-penalty`]## [.description] -- Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests[quarkus.langchain4j.openai.chat-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests[`quarkus.langchain4j.openai.chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses[quarkus.langchain4j.openai.chat-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses[`quarkus.langchain4j.openai.chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format[quarkus.langchain4j.openai.chat-model.response-format]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format[`quarkus.langchain4j.openai.chat-model.response-format`]## [.description] -- The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop[quarkus.langchain4j.openai.chat-model.stop]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop[`quarkus.langchain4j.openai.chat-model.stop`]## [.description] -- The list of stop words to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name[quarkus.langchain4j.openai.embedding-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name[`quarkus.langchain4j.openai.embedding-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text-embedding-ada-002` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests[quarkus.langchain4j.openai.embedding-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests[`quarkus.langchain4j.openai.embedding-model.log-requests`]## [.description] -- Whether embedding model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses[quarkus.langchain4j.openai.embedding-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses[`quarkus.langchain4j.openai.embedding-model.log-responses`]## [.description] -- Whether embedding model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user[quarkus.langchain4j.openai.embedding-model.user]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user[`quarkus.langchain4j.openai.embedding-model.user`]## [.description] -- A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_USER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name[quarkus.langchain4j.openai.moderation-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name[`quarkus.langchain4j.openai.moderation-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text-moderation-latest` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests[quarkus.langchain4j.openai.moderation-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests[`quarkus.langchain4j.openai.moderation-model.log-requests`]## [.description] -- Whether moderation model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses[quarkus.langchain4j.openai.moderation-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses[`quarkus.langchain4j.openai.moderation-model.log-responses`]## [.description] -- Whether moderation model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name[quarkus.langchain4j.openai.image-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name[`quarkus.langchain4j.openai.image-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dall-e-3` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist[quarkus.langchain4j.openai.image-model.persist]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist[`quarkus.langchain4j.openai.image-model.persist`]## [.description] -- Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory[quarkus.langchain4j.openai.image-model.persist-directory]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory[`quarkus.langchain4j.openai.image-model.persist-directory`]## [.description] -- The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path |`${java.io.tmpdir}/dall-e-images` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format[quarkus.langchain4j.openai.image-model.response-format]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format[`quarkus.langchain4j.openai.image-model.response-format`]## [.description] -- @@ -615,18 +628,18 @@ The format in which the generated images are returned. Must be one of `url` or `b64_json` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`url` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size[quarkus.langchain4j.openai.image-model.size]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size[`quarkus.langchain4j.openai.image-model.size`]## [.description] -- @@ -636,18 +649,18 @@ Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall- Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_SIZE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`1024x1024` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality[quarkus.langchain4j.openai.image-model.quality]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality[`quarkus.langchain4j.openai.image-model.quality`]## [.description] -- @@ -657,18 +670,18 @@ The quality of the image that will be generated. This param is only supported for when the model is `dall-e-3`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_QUALITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_QUALITY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`standard` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number[quarkus.langchain4j.openai.image-model.number]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number[`quarkus.langchain4j.openai.image-model.number`]## [.description] -- @@ -678,18 +691,18 @@ Must be between 1 and 10. When the model is dall-e-3, only n=1 is supported. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_NUMBER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_NUMBER+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style[quarkus.langchain4j.openai.image-model.style]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style[`quarkus.langchain4j.openai.image-model.style`]## [.description] -- @@ -699,602 +712,617 @@ Must be one of `vivid` or `natural`. Vivid causes the model to lean towards gene This param is only supported for when the model is `dall-e-3`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_STYLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_STYLE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`vivid` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user[quarkus.langchain4j.openai.image-model.user]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user[`quarkus.langchain4j.openai.image-model.user`]## [.description] -- A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_USER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests[quarkus.langchain4j.openai.image-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests[`quarkus.langchain4j.openai.image-model.log-requests`]## [.description] -- Whether image model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses[quarkus.langchain4j.openai.image-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses[`quarkus.langchain4j.openai.image-model.log-responses`]## [.description] -- Whether image model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -h|[[quarkus-langchain4j-openai_quarkus-langchain4j-openai-named-config-named-model-config]]link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-named-config-named-model-config[Named model config] - +h|[[quarkus-langchain4j-openai_section_quarkus-langchain4j-openai]] [.section-name.section-level0]##link:#quarkus-langchain4j-openai_section_quarkus-langchain4j-openai[Named model config]## h|Type h|Default -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url[quarkus.langchain4j.openai."model-name".base-url]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url[`quarkus.langchain4j.openai."model-name".base-url`]## [.description] -- Base URL of OpenAI API + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://api.openai.com/v1/` +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-tls-configuration-name[`quarkus.langchain4j.openai."model-name".tls-configuration-name`]## -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key[quarkus.langchain4j.openai."model-name".api-key]` +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key[`quarkus.langchain4j.openai."model-name".api-key`]## + [.description] -- OpenAI API key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id[quarkus.langchain4j.openai."model-name".organization-id]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id[`quarkus.langchain4j.openai."model-name".organization-id`]## [.description] -- OpenAI Organization ID (https://platform.openai.com/docs/api-reference/organization-optional) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ORGANIZATION_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ORGANIZATION_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout[quarkus.langchain4j.openai."model-name".timeout]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout[`quarkus.langchain4j.openai."model-name".timeout`]## [.description] -- Timeout for OpenAI calls + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__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-openai_quarkus-langchain4j-openai-model-name-max-retries]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-max-retries[quarkus.langchain4j.openai."model-name".max-retries]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-max-retries]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-max-retries[`quarkus.langchain4j.openai."model-name".max-retries`]## [.description] -- The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MAX_RETRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MAX_RETRIES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests[quarkus.langchain4j.openai."model-name".log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests[`quarkus.langchain4j.openai."model-name".log-requests`]## [.description] -- Whether the OpenAI client should log requests + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses[quarkus.langchain4j.openai."model-name".log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses[`quarkus.langchain4j.openai."model-name".log-responses`]## [.description] -- Whether the OpenAI client should log responses + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration[quarkus.langchain4j.openai."model-name".enable-integration]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration[`quarkus.langchain4j.openai."model-name".enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type[quarkus.langchain4j.openai."model-name".proxy-type]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type[`quarkus.langchain4j.openai."model-name".proxy-type`]## [.description] -- The Proxy type + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`HTTP` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host[quarkus.langchain4j.openai."model-name".proxy-host]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host[`quarkus.langchain4j.openai."model-name".proxy-host`]## [.description] -- The Proxy host + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_HOST+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port[quarkus.langchain4j.openai."model-name".proxy-port]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port[`quarkus.langchain4j.openai."model-name".proxy-port`]## [.description] -- The Proxy port + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`3128` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name[quarkus.langchain4j.openai."model-name".chat-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name[`quarkus.langchain4j.openai."model-name".chat-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`gpt-4o-mini` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature[quarkus.langchain4j.openai."model-name".chat-model.temperature]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature[`quarkus.langchain4j.openai."model-name".chat-model.temperature`]## [.description] -- What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p[quarkus.langchain4j.openai."model-name".chat-model.top-p]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p[`quarkus.langchain4j.openai."model-name".chat-model.top-p`]## [.description] -- An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens[quarkus.langchain4j.openai."model-name".chat-model.max-tokens]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens[`quarkus.langchain4j.openai."model-name".chat-model.max-tokens`]## [.description] -- The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty[quarkus.langchain4j.openai."model-name".chat-model.presence-penalty]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty[`quarkus.langchain4j.openai."model-name".chat-model.presence-penalty`]## [.description] -- Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty[quarkus.langchain4j.openai."model-name".chat-model.frequency-penalty]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.openai."model-name".chat-model.frequency-penalty`]## [.description] -- Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`0` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests[quarkus.langchain4j.openai."model-name".chat-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests[`quarkus.langchain4j.openai."model-name".chat-model.log-requests`]## [.description] -- Whether chat model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses[quarkus.langchain4j.openai."model-name".chat-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses[`quarkus.langchain4j.openai."model-name".chat-model.log-responses`]## [.description] -- Whether chat model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format[quarkus.langchain4j.openai."model-name".chat-model.response-format]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format[`quarkus.langchain4j.openai."model-name".chat-model.response-format`]## [.description] -- The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop[quarkus.langchain4j.openai."model-name".chat-model.stop]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop[`quarkus.langchain4j.openai."model-name".chat-model.stop`]## [.description] -- The list of stop words to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_STOP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_STOP+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name[quarkus.langchain4j.openai."model-name".embedding-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name[`quarkus.langchain4j.openai."model-name".embedding-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text-embedding-ada-002` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests[quarkus.langchain4j.openai."model-name".embedding-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests[`quarkus.langchain4j.openai."model-name".embedding-model.log-requests`]## [.description] -- Whether embedding model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses[quarkus.langchain4j.openai."model-name".embedding-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses[`quarkus.langchain4j.openai."model-name".embedding-model.log-responses`]## [.description] -- Whether embedding model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user[quarkus.langchain4j.openai."model-name".embedding-model.user]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user[`quarkus.langchain4j.openai."model-name".embedding-model.user`]## [.description] -- A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_USER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name[quarkus.langchain4j.openai."model-name".moderation-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name[`quarkus.langchain4j.openai."model-name".moderation-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text-moderation-latest` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests[quarkus.langchain4j.openai."model-name".moderation-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests[`quarkus.langchain4j.openai."model-name".moderation-model.log-requests`]## [.description] -- Whether moderation model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses[quarkus.langchain4j.openai."model-name".moderation-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses[`quarkus.langchain4j.openai."model-name".moderation-model.log-responses`]## [.description] -- Whether moderation model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name[quarkus.langchain4j.openai."model-name".image-model.model-name]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name[`quarkus.langchain4j.openai."model-name".image-model.model-name`]## [.description] -- Model name to use + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dall-e-3` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist[quarkus.langchain4j.openai."model-name".image-model.persist]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist[`quarkus.langchain4j.openai."model-name".image-model.persist`]## [.description] -- Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory[quarkus.langchain4j.openai."model-name".image-model.persist-directory]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory[`quarkus.langchain4j.openai."model-name".image-model.persist-directory`]## [.description] -- The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path |`${java.io.tmpdir}/dall-e-images` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format[quarkus.langchain4j.openai."model-name".image-model.response-format]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format[`quarkus.langchain4j.openai."model-name".image-model.response-format`]## [.description] -- @@ -1302,18 +1330,18 @@ The format in which the generated images are returned. Must be one of `url` or `b64_json` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`url` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size[quarkus.langchain4j.openai."model-name".image-model.size]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size[`quarkus.langchain4j.openai."model-name".image-model.size`]## [.description] -- @@ -1323,18 +1351,18 @@ Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall- Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`1024x1024` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality[quarkus.langchain4j.openai."model-name".image-model.quality]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality[`quarkus.langchain4j.openai."model-name".image-model.quality`]## [.description] -- @@ -1344,18 +1372,18 @@ The quality of the image that will be generated. This param is only supported for when the model is `dall-e-3`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`standard` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number[quarkus.langchain4j.openai."model-name".image-model.number]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number[`quarkus.langchain4j.openai."model-name".image-model.number`]## [.description] -- @@ -1365,18 +1393,18 @@ Must be between 1 and 10. When the model is dall-e-3, only n=1 is supported. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style[quarkus.langchain4j.openai."model-name".image-model.style]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style[`quarkus.langchain4j.openai."model-name".image-model.style`]## [.description] -- @@ -1386,70 +1414,74 @@ Must be one of `vivid` or `natural`. Vivid causes the model to lean towards gene This param is only supported for when the model is `dall-e-3`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`vivid` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user[quarkus.langchain4j.openai."model-name".image-model.user]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user[`quarkus.langchain4j.openai."model-name".image-model.user`]## [.description] -- A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests[quarkus.langchain4j.openai."model-name".image-model.log-requests]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests[`quarkus.langchain4j.openai."model-name".image-model.log-requests`]## [.description] -- Whether image model requests should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses]]`link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses[quarkus.langchain4j.openai."model-name".image-model.log-responses]` - +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses[`quarkus.langchain4j.openai."model-name".image-model.log-responses`]## [.description] -- Whether image model responses should be logged + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_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-openai_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1466,3 +1498,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-openai_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai_quarkus.langchain4j.adoc new file mode 100644 index 000000000..b70634da0 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openai_quarkus.langchain4j.adoc @@ -0,0 +1,1502 @@ +:summaryTableId: quarkus-langchain4j-openai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-enabled[`quarkus.langchain4j.openai.chat-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_OPENAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-enabled[`quarkus.langchain4j.openai.embedding-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_OPENAI_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-enabled[`quarkus.langchain4j.openai.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_OPENAI_MODERATION_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-enabled[`quarkus.langchain4j.openai.image-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_OPENAI_IMAGE_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-base-url[`quarkus.langchain4j.openai.base-url`]## + +[.description] +-- +Base URL of OpenAI API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.openai.com/v1/` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-tls-configuration-name[`quarkus.langchain4j.openai.tls-configuration-name`]## + +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-api-key[`quarkus.langchain4j.openai.api-key`]## + +[.description] +-- +OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-organization-id[`quarkus.langchain4j.openai.organization-id`]## + +[.description] +-- +OpenAI Organization ID (https://platform.openai.com/docs/api-reference/organization-optional) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_ORGANIZATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_ORGANIZATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-timeout[`quarkus.langchain4j.openai.timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_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]] +|`10s` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-max-retries]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-max-retries[`quarkus.langchain4j.openai.max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-requests[`quarkus.langchain4j.openai.log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-log-responses[`quarkus.langchain4j.openai.log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-enable-integration[`quarkus.langchain4j.openai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-type[`quarkus.langchain4j.openai.proxy-type`]## + +[.description] +-- +The Proxy type + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`HTTP` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-host[`quarkus.langchain4j.openai.proxy-host`]## + +[.description] +-- +The Proxy host + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-proxy-port[`quarkus.langchain4j.openai.proxy-port`]## + +[.description] +-- +The Proxy port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3128` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-model-name[`quarkus.langchain4j.openai.chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gpt-4o-mini` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-temperature[`quarkus.langchain4j.openai.chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-top-p[`quarkus.langchain4j.openai.chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-max-tokens[`quarkus.langchain4j.openai.chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-presence-penalty[`quarkus.langchain4j.openai.chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-frequency-penalty[`quarkus.langchain4j.openai.chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-requests[`quarkus.langchain4j.openai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-log-responses[`quarkus.langchain4j.openai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-response-format[`quarkus.langchain4j.openai.chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-chat-model-stop[`quarkus.langchain4j.openai.chat-model.stop`]## + +[.description] +-- +The list of stop words to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_CHAT_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-model-name[`quarkus.langchain4j.openai.embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text-embedding-ada-002` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-requests[`quarkus.langchain4j.openai.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-log-responses[`quarkus.langchain4j.openai.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-embedding-model-user[`quarkus.langchain4j.openai.embedding-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_EMBEDDING_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-model-name[`quarkus.langchain4j.openai.moderation-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text-moderation-latest` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-requests[`quarkus.langchain4j.openai.moderation-model.log-requests`]## + +[.description] +-- +Whether moderation model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-moderation-model-log-responses[`quarkus.langchain4j.openai.moderation-model.log-responses`]## + +[.description] +-- +Whether moderation model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_MODERATION_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-model-name[`quarkus.langchain4j.openai.image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist[`quarkus.langchain4j.openai.image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-persist-directory[`quarkus.langchain4j.openai.image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-response-format[`quarkus.langchain4j.openai.image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-size[`quarkus.langchain4j.openai.image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-quality[`quarkus.langchain4j.openai.image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-number[`quarkus.langchain4j.openai.image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-style[`quarkus.langchain4j.openai.image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-user[`quarkus.langchain4j.openai.image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-requests[`quarkus.langchain4j.openai.image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-image-model-log-responses[`quarkus.langchain4j.openai.image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI_IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-openai_section_quarkus-langchain4j-openai]] [.section-name.section-level0]##link:#quarkus-langchain4j-openai_section_quarkus-langchain4j-openai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-base-url[`quarkus.langchain4j.openai."model-name".base-url`]## + +[.description] +-- +Base URL of OpenAI API + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`https://api.openai.com/v1/` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-tls-configuration-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-tls-configuration-name[`quarkus.langchain4j.openai."model-name".tls-configuration-name`]## + +[.description] +-- +If set, the named TLS configuration with the configured name will be applied to the REST Client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-api-key[`quarkus.langchain4j.openai."model-name".api-key`]## + +[.description] +-- +OpenAI API key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-organization-id[`quarkus.langchain4j.openai."model-name".organization-id`]## + +[.description] +-- +OpenAI Organization ID (https://platform.openai.com/docs/api-reference/organization-optional) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ORGANIZATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ORGANIZATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-timeout[`quarkus.langchain4j.openai."model-name".timeout`]## + +[.description] +-- +Timeout for OpenAI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-max-retries]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-max-retries[`quarkus.langchain4j.openai."model-name".max-retries`]## + +[.description] +-- +The maximum number of times to retry. 1 means exactly one attempt, with retrying disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MAX_RETRIES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MAX_RETRIES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-requests[`quarkus.langchain4j.openai."model-name".log-requests`]## + +[.description] +-- +Whether the OpenAI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-log-responses[`quarkus.langchain4j.openai."model-name".log-responses`]## + +[.description] +-- +Whether the OpenAI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-enable-integration[`quarkus.langchain4j.openai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-type[`quarkus.langchain4j.openai."model-name".proxy-type`]## + +[.description] +-- +The Proxy type + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`HTTP` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-host[`quarkus.langchain4j.openai."model-name".proxy-host`]## + +[.description] +-- +The Proxy host + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-proxy-port[`quarkus.langchain4j.openai."model-name".proxy-port`]## + +[.description] +-- +The Proxy port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3128` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-model-name[`quarkus.langchain4j.openai."model-name".chat-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gpt-4o-mini` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-temperature[`quarkus.langchain4j.openai."model-name".chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use, with values between 0 and 2. Higher values means the model will take more risks. A value of 0.9 is good for more creative applications, while 0 (argmax sampling) is good for ones with a well-defined answer. It is recommended to alter this or topP, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-top-p[`quarkus.langchain4j.openai."model-name".chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with topP probability mass. 0.1 means only the tokens comprising the top 10% probability mass are considered. It is recommended to alter this or temperature, but not both. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-max-tokens[`quarkus.langchain4j.openai."model-name".chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens can't exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-presence-penalty[`quarkus.langchain4j.openai."model-name".chat-model.presence-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.openai."model-name".chat-model.frequency-penalty`]## + +[.description] +-- +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-requests[`quarkus.langchain4j.openai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-log-responses[`quarkus.langchain4j.openai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-response-format[`quarkus.langchain4j.openai."model-name".chat-model.response-format`]## + +[.description] +-- +The response format the model should use. Some models are not compatible with some response formats, make sure to review OpenAI documentation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-chat-model-stop[`quarkus.langchain4j.openai."model-name".chat-model.stop`]## + +[.description] +-- +The list of stop words to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_STOP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__CHAT_MODEL_STOP+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-model-name[`quarkus.langchain4j.openai."model-name".embedding-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text-embedding-ada-002` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-requests[`quarkus.langchain4j.openai."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-log-responses[`quarkus.langchain4j.openai."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-embedding-model-user[`quarkus.langchain4j.openai."model-name".embedding-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__EMBEDDING_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-model-name[`quarkus.langchain4j.openai."model-name".moderation-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text-moderation-latest` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-requests[`quarkus.langchain4j.openai."model-name".moderation-model.log-requests`]## + +[.description] +-- +Whether moderation model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-moderation-model-log-responses[`quarkus.langchain4j.openai."model-name".moderation-model.log-responses`]## + +[.description] +-- +Whether moderation model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__MODERATION_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-model-name[`quarkus.langchain4j.openai."model-name".image-model.model-name`]## + +[.description] +-- +Model name to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_MODEL_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dall-e-3` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist[`quarkus.langchain4j.openai."model-name".image-model.persist`]## + +[.description] +-- +Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when `quarkus.langchain4j.openai.image-mode.directory` is set and this property is not to `false` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-persist-directory[`quarkus.langchain4j.openai."model-name".image-model.persist-directory`]## + +[.description] +-- +The path where the generated images will be persisted to disk. This only applies of `quarkus.langchain4j.openai.image-mode.persist` is not set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_PERSIST_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|path +|`${java.io.tmpdir}/dall-e-images` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-response-format[`quarkus.langchain4j.openai."model-name".image-model.response-format`]## + +[.description] +-- +The format in which the generated images are returned. + +Must be one of `url` or `b64_json` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`url` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-size[`quarkus.langchain4j.openai."model-name".image-model.size`]## + +[.description] +-- +The size of the generated images. + +Must be one of `1024x1024`, `1792x1024`, or `1024x1792` when the model is `dall-e-3`. + +Must be one of `256x256`, `512x512`, or `1024x1024` when the model is `dall-e-2`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`1024x1024` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-quality[`quarkus.langchain4j.openai."model-name".image-model.quality`]## + +[.description] +-- +The quality of the image that will be generated. + +`hd` creates images with finer details and greater consistency across the image. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_QUALITY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`standard` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-number[`quarkus.langchain4j.openai."model-name".image-model.number`]## + +[.description] +-- +The number of images to generate. + +Must be between 1 and 10. + +When the model is dall-e-3, only n=1 is supported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_NUMBER+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-style[`quarkus.langchain4j.openai."model-name".image-model.style`]## + +[.description] +-- +The style of the generated images. + +Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. + +This param is only supported for when the model is `dall-e-3`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_STYLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vivid` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-user[`quarkus.langchain4j.openai."model-name".image-model.user`]## + +[.description] +-- +A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_USER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-requests[`quarkus.langchain4j.openai."model-name".image-model.log-requests`]## + +[.description] +-- +Whether image model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openai_quarkus-langchain4j-openai-model-name-image-model-log-responses[`quarkus.langchain4j.openai."model-name".image-model.log-responses`]## + +[.description] +-- +Whether image model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENAI__MODEL_NAME__IMAGE_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-openai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-openshift-ai.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai.adoc new file mode 100644 index 000000000..b47adcffa --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai.adoc @@ -0,0 +1,327 @@ +:summaryTableId: quarkus-langchain4j-openshift-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-enabled[`quarkus.langchain4j.openshift-ai.chat-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_OPENSHIFT_AI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-base-url]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-base-url[`quarkus.langchain4j.openshift-ai.base-url`]## + +[.description] +-- +Base URL where OpenShift AI serving is running, such as `https://flant5s-l-predictor-ch2023.apps.cluster-hj2qv.dynamic.redhatworkshops.io:443/api` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://dummy.ai/api` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-timeout]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-timeout[`quarkus.langchain4j.openshift-ai.timeout`]## + +[.description] +-- +Timeout for OpenShift AI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_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]] +|`10s` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-requests[`quarkus.langchain4j.openshift-ai.log-requests`]## + +[.description] +-- +Whether the OpenShift AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-responses[`quarkus.langchain4j.openshift-ai.log-responses`]## + +[.description] +-- +Whether the OpenShift AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-enable-integration[`quarkus.langchain4j.openshift-ai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-model-id[`quarkus.langchain4j.openshift-ai.chat-model.model-id`]## + +[.description] +-- +Model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-requests[`quarkus.langchain4j.openshift-ai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-responses[`quarkus.langchain4j.openshift-ai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-openshift-ai_section_quarkus-langchain4j-openshift-ai]] [.section-name.section-level0]##link:#quarkus-langchain4j-openshift-ai_section_quarkus-langchain4j-openshift-ai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-base-url[`quarkus.langchain4j.openshift-ai."model-name".base-url`]## + +[.description] +-- +Base URL where OpenShift AI serving is running, such as `https://flant5s-l-predictor-ch2023.apps.cluster-hj2qv.dynamic.redhatworkshops.io:443/api` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://dummy.ai/api` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-timeout[`quarkus.langchain4j.openshift-ai."model-name".timeout`]## + +[.description] +-- +Timeout for OpenShift AI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-requests[`quarkus.langchain4j.openshift-ai."model-name".log-requests`]## + +[.description] +-- +Whether the OpenShift AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-responses[`quarkus.langchain4j.openshift-ai."model-name".log-responses`]## + +[.description] +-- +Whether the OpenShift AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-enable-integration[`quarkus.langchain4j.openshift-ai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-model-id[`quarkus.langchain4j.openshift-ai."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_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-requests[`quarkus.langchain4j.openshift-ai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-responses[`quarkus.langchain4j.openshift-ai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-openshift-ai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-openshift-ai_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai_quarkus.langchain4j.adoc new file mode 100644 index 000000000..b47adcffa --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-openshift-ai_quarkus.langchain4j.adoc @@ -0,0 +1,327 @@ +:summaryTableId: quarkus-langchain4j-openshift-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-enabled[`quarkus.langchain4j.openshift-ai.chat-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_OPENSHIFT_AI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-base-url]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-base-url[`quarkus.langchain4j.openshift-ai.base-url`]## + +[.description] +-- +Base URL where OpenShift AI serving is running, such as `https://flant5s-l-predictor-ch2023.apps.cluster-hj2qv.dynamic.redhatworkshops.io:443/api` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://dummy.ai/api` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-timeout]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-timeout[`quarkus.langchain4j.openshift-ai.timeout`]## + +[.description] +-- +Timeout for OpenShift AI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_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]] +|`10s` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-requests[`quarkus.langchain4j.openshift-ai.log-requests`]## + +[.description] +-- +Whether the OpenShift AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-log-responses[`quarkus.langchain4j.openshift-ai.log-responses`]## + +[.description] +-- +Whether the OpenShift AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-enable-integration[`quarkus.langchain4j.openshift-ai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-model-id[`quarkus.langchain4j.openshift-ai.chat-model.model-id`]## + +[.description] +-- +Model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-requests[`quarkus.langchain4j.openshift-ai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-chat-model-log-responses[`quarkus.langchain4j.openshift-ai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-openshift-ai_section_quarkus-langchain4j-openshift-ai]] [.section-name.section-level0]##link:#quarkus-langchain4j-openshift-ai_section_quarkus-langchain4j-openshift-ai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-base-url[`quarkus.langchain4j.openshift-ai."model-name".base-url`]## + +[.description] +-- +Base URL where OpenShift AI serving is running, such as `https://flant5s-l-predictor-ch2023.apps.cluster-hj2qv.dynamic.redhatworkshops.io:443/api` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://dummy.ai/api` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-timeout[`quarkus.langchain4j.openshift-ai."model-name".timeout`]## + +[.description] +-- +Timeout for OpenShift AI calls + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-requests[`quarkus.langchain4j.openshift-ai."model-name".log-requests`]## + +[.description] +-- +Whether the OpenShift AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-log-responses[`quarkus.langchain4j.openshift-ai."model-name".log-responses`]## + +[.description] +-- +Whether the OpenShift AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-enable-integration[`quarkus.langchain4j.openshift-ai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the OpenAI provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-model-id[`quarkus.langchain4j.openshift-ai."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_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-requests[`quarkus.langchain4j.openshift-ai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-openshift-ai_quarkus-langchain4j-openshift-ai-model-name-chat-model-log-responses[`quarkus.langchain4j.openshift-ai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_OPENSHIFT_AI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-openshift-ai_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-pgvector.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc index ac57fb8a8..e45befbca 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc @@ -1,136 +1,133 @@ - -:summaryTableId: quarkus-langchain4j-pgvector +:summaryTableId: quarkus-langchain4j-pgvector_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-pgvector_configuration]]link:#quarkus-langchain4j-pgvector_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource[quarkus.langchain4j.pgvector.datasource]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource[`quarkus.langchain4j.pgvector.datasource`]## [.description] -- The name of the configured Postgres datasource to use for this store. If not set, the default datasource from the Agroal extension will be used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DATASOURCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DATASOURCE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table[quarkus.langchain4j.pgvector.table]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table[`quarkus.langchain4j.pgvector.table`]## [.description] -- The table name for storing embeddings + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`embeddings` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension[quarkus.langchain4j.pgvector.dimension]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension[`quarkus.langchain4j.pgvector.dimension`]## [.description] -- The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index[quarkus.langchain4j.pgvector.use-index]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index[`quarkus.langchain4j.pgvector.use-index`]## [.description] -- Use index or not + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size[quarkus.langchain4j.pgvector.index-list-size]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size[`quarkus.langchain4j.pgvector.index-list-size`]## [.description] -- index size + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`0` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table[quarkus.langchain4j.pgvector.create-table]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table[`quarkus.langchain4j.pgvector.create-table`]## [.description] -- Whether the table should be created if not already existing. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first[quarkus.langchain4j.pgvector.drop-table-first]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first[`quarkus.langchain4j.pgvector.drop-table-first`]## [.description] -- Whether the table should be dropped prior to being created. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode[quarkus.langchain4j.pgvector.metadata.storage-mode]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode[`quarkus.langchain4j.pgvector.metadata.storage-mode`]## [.description] -- @@ -142,19 +139,18 @@ Metadata type: Default value: COMBINED_JSON + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++` endif::add-copy-button-to-env-var[] --- a| -`column-per-key`, `combined-json`, `combined-jsonb` +-- +a|MetadataStorageMode |`combined-json` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions[quarkus.langchain4j.pgvector.metadata.column-definitions]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions[`quarkus.langchain4j.pgvector.metadata.column-definitions`]## [.description] -- @@ -164,18 +160,18 @@ If using JSONB metadata type, this should in most cases be set to `metadata JSON If using COLUMNS metadata type, this should be a list of columns, one column for each desired metadata field. Example: condominium_id uuid null, user uuid null + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_COLUMN_DEFINITIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_COLUMN_DEFINITIONS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string |`metadata JSON NULL` - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes[quarkus.langchain4j.pgvector.metadata.indexes]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes[`quarkus.langchain4j.pgvector.metadata.indexes`]## [.description] -- @@ -187,18 +183,18 @@ For instance: - JSONB: (metadata->'key'), (metadata->'name'), (metadata->'age') - COLUMNS: key, name, age + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEXES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEXES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type]]`link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type[quarkus.langchain4j.pgvector.metadata.index-type]` - +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type[`quarkus.langchain4j.pgvector.metadata.index-type`]## [.description] -- @@ -208,13 +204,18 @@ Index Type: - GIN - Other link:https://www.postgresql.org/docs/current/indexes-types.html[PostgreSQL index types] + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEX_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEX_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`BTREE` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector_quarkus.langchain4j.adoc new file mode 100644 index 000000000..e45befbca --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector_quarkus.langchain4j.adoc @@ -0,0 +1,221 @@ +:summaryTableId: quarkus-langchain4j-pgvector_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-datasource[`quarkus.langchain4j.pgvector.datasource`]## + +[.description] +-- +The name of the configured Postgres datasource to use for this store. If not set, the default datasource from the Agroal extension will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DATASOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DATASOURCE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-table[`quarkus.langchain4j.pgvector.table`]## + +[.description] +-- +The table name for storing embeddings + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embeddings` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-dimension[`quarkus.langchain4j.pgvector.dimension`]## + +[.description] +-- +The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|int +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-use-index[`quarkus.langchain4j.pgvector.use-index`]## + +[.description] +-- +Use index or not + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-index-list-size[`quarkus.langchain4j.pgvector.index-list-size`]## + +[.description] +-- +index size + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`0` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-create-table[`quarkus.langchain4j.pgvector.create-table`]## + +[.description] +-- +Whether the table should be created if not already existing. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-drop-table-first[`quarkus.langchain4j.pgvector.drop-table-first`]## + +[.description] +-- +Whether the table should be dropped prior to being created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-storage-mode[`quarkus.langchain4j.pgvector.metadata.storage-mode`]## + +[.description] +-- +Metadata type: + + - COLUMN_PER_KEY: for static metadata, when you know in advance the list of metadata fields. In this case, you should also override the `quarkus.langchain4j.pgvector.metadata.column-definitions` property to define the right columns. + - COMBINED_JSON: For dynamic metadata, when you don't know the list of metadata fields that will be used. + - COMBINED_JSONB: Same as JSON, but stored in a binary way. Optimized for query on large dataset. In this case, you should also override the `quarkus.langchain4j.pgvector.metadata.column-definitions` property to change the type of the `metadata` column to COMBINED_JSONB. + +Default value: COMBINED_JSON + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_STORAGE_MODE+++` +endif::add-copy-button-to-env-var[] +-- +a|MetadataStorageMode +|`combined-json` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-column-definitions[`quarkus.langchain4j.pgvector.metadata.column-definitions`]## + +[.description] +-- +Metadata Definition: SQL definition of metadata field(s). By default, "metadata JSON NULL" configured. This is only suitable if using the JSON metadata type. + +If using JSONB metadata type, this should in most cases be set to `metadata JSONB NULL`. + +If using COLUMNS metadata type, this should be a list of columns, one column for each desired metadata field. Example: condominium_id uuid null, user uuid null + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_COLUMN_DEFINITIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_COLUMN_DEFINITIONS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`metadata JSON NULL` + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-indexes[`quarkus.langchain4j.pgvector.metadata.indexes`]## + +[.description] +-- +Metadata Indexes, list of fields to use as index. + +For instance: + + - JSON: with JSON metadata, indexes are not allowed, so this property must be empty. To use indexes, switch to JSONB metadata. + - JSONB: (metadata->'key'), (metadata->'name'), (metadata->'age') + - COLUMNS: key, name, age + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEXES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEXES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type]] [.property-path]##link:#quarkus-langchain4j-pgvector_quarkus-langchain4j-pgvector-metadata-index-type[`quarkus.langchain4j.pgvector.metadata.index-type`]## + +[.description] +-- +Index Type: + + - BTREE (default) + - GIN + - Other link:https://www.postgresql.org/docs/current/indexes-types.html[PostgreSQL index types] + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEX_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_METADATA_INDEX_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`BTREE` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone.adoc index b263debf4..f5fdda99f 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone.adoc @@ -1,190 +1,188 @@ - -:summaryTableId: quarkus-langchain4j-pinecone +:summaryTableId: quarkus-langchain4j-pinecone_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-pinecone_configuration]]link:#quarkus-langchain4j-pinecone_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key[quarkus.langchain4j.pinecone.api-key]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key[`quarkus.langchain4j.pinecone.api-key`]## [.description] -- The API key to Pinecone. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment[quarkus.langchain4j.pinecone.environment]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment[`quarkus.langchain4j.pinecone.environment`]## [.description] -- Environment name, e.g. gcp-starter or northamerica-northeast1-gcp. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_ENVIRONMENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_ENVIRONMENT+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id[quarkus.langchain4j.pinecone.project-id]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id[`quarkus.langchain4j.pinecone.project-id`]## [.description] -- ID of the project. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_PROJECT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_PROJECT_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name[quarkus.langchain4j.pinecone.index-name]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name[`quarkus.langchain4j.pinecone.index-name`]## [.description] -- Name of the index within the project. If the index doesn't exist, it will be created. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension[quarkus.langchain4j.pinecone.dimension]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension[`quarkus.langchain4j.pinecone.dimension`]## [.description] -- Dimension of the embeddings in the index. This is required only in case that the index doesn't exist yet and needs to be created. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_DIMENSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_DIMENSION+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type[quarkus.langchain4j.pinecone.pod-type]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type[`quarkus.langchain4j.pinecone.pod-type`]## [.description] -- The type of the pod to use. This is only used if the index doesn't exist yet and needs to be created. The format: One of `s1`, `p1`, or `p2` appended with `.` and one of `x1`, `x2`, `x4`, or `x8`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_POD_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_POD_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`s1.x1` - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout[quarkus.langchain4j.pinecone.index-readiness-timeout]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout[`quarkus.langchain4j.pinecone.index-readiness-timeout`]## [.description] -- The timeout duration for the index to become ready. Only relevant if the index doesn't exist yet and needs to be created. If not specified, 1 minute will be used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_READINESS_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_READINESS_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace[quarkus.langchain4j.pinecone.namespace]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace[`quarkus.langchain4j.pinecone.namespace`]## [.description] -- The namespace. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_NAMESPACE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name[quarkus.langchain4j.pinecone.text-field-name]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name[`quarkus.langchain4j.pinecone.text-field-name`]## [.description] -- The name of the field that contains the text segment. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_TEXT_FIELD_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_TEXT_FIELD_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`text` - -a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout]]`link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout[quarkus.langchain4j.pinecone.timeout]` - +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout[`quarkus.langchain4j.pinecone.timeout`]## [.description] -- The timeout duration for the Pinecone client. If not specified, 5 seconds will be used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_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]] | |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-pinecone_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -201,3 +199,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-pinecone_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone_quarkus.langchain4j.adoc new file mode 100644 index 000000000..f5fdda99f --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pinecone_quarkus.langchain4j.adoc @@ -0,0 +1,203 @@ +:summaryTableId: quarkus-langchain4j-pinecone_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|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-api-key[`quarkus.langchain4j.pinecone.api-key`]## + +[.description] +-- +The API key to Pinecone. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-environment[`quarkus.langchain4j.pinecone.environment`]## + +[.description] +-- +Environment name, e.g. gcp-starter or northamerica-northeast1-gcp. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_ENVIRONMENT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_ENVIRONMENT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-project-id[`quarkus.langchain4j.pinecone.project-id`]## + +[.description] +-- +ID of the project. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-name[`quarkus.langchain4j.pinecone.index-name`]## + +[.description] +-- +Name of the index within the project. If the index doesn't exist, it will be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-dimension[`quarkus.langchain4j.pinecone.dimension`]## + +[.description] +-- +Dimension of the embeddings in the index. This is required only in case that the index doesn't exist yet and needs to be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-pod-type[`quarkus.langchain4j.pinecone.pod-type`]## + +[.description] +-- +The type of the pod to use. This is only used if the index doesn't exist yet and needs to be created. The format: One of `s1`, `p1`, or `p2` appended with `.` and one of `x1`, `x2`, `x4`, or `x8`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_POD_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_POD_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`s1.x1` + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-index-readiness-timeout[`quarkus.langchain4j.pinecone.index-readiness-timeout`]## + +[.description] +-- +The timeout duration for the index to become ready. Only relevant if the index doesn't exist yet and needs to be created. If not specified, 1 minute will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_READINESS_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_INDEX_READINESS_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]] +| + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-namespace[`quarkus.langchain4j.pinecone.namespace`]## + +[.description] +-- +The namespace. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_NAMESPACE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_NAMESPACE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-text-field-name[`quarkus.langchain4j.pinecone.text-field-name`]## + +[.description] +-- +The name of the field that contains the text segment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_TEXT_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_TEXT_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text` + +a| [[quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout]] [.property-path]##link:#quarkus-langchain4j-pinecone_quarkus-langchain4j-pinecone-timeout[`quarkus.langchain4j.pinecone.timeout`]## + +[.description] +-- +The timeout duration for the Pinecone client. If not specified, 5 seconds will be used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PINECONE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PINECONE_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]] +| + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-pinecone_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-qdrant.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant.adoc new file mode 100644 index 000000000..ecbb51216 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant.adoc @@ -0,0 +1,235 @@ +:summaryTableId: quarkus-langchain4j-qdrant_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-enabled[`quarkus.langchain4j.qdrant.devservices.enabled`]## + +[.description] +-- +Whether Dev Services for Qdrant are enabled or not. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-qdrant-image-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-qdrant-image-name[`quarkus.langchain4j.qdrant.devservices.qdrant-image-name`]## + +[.description] +-- +Container image for Qdrant. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_QDRANT_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_QDRANT_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`docker.io/qdrant/qdrant:v1.8.3-unprivileged` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-port]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-port[`quarkus.langchain4j.qdrant.devservices.port`]## + +[.description] +-- +Optional fixed port the Qdrant dev service will listen to. If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-shared[`quarkus.langchain4j.qdrant.devservices.shared`]## + +[.description] +-- +Indicates if the Dev Service containers managed by Quarkus for Qdrant are shared. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-service-name[`quarkus.langchain4j.qdrant.devservices.service-name`]## + +[.description] +-- +Service label to apply to created Dev Services containers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`qdrant` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-distance]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-distance[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.distance`]## + +[.description] +-- +Distance function used for comparing vectors + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++` +endif::add-copy-button-to-env-var[] +-- +a|Distance +|required icon:exclamation-circle[title=Configuration property is required] + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.size`]## + +[.description] +-- +Size of the vectors + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`0l` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-host]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-host[`quarkus.langchain4j.qdrant.host`]## + +[.description] +-- +The URL of the Qdrant server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-port]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-port[`quarkus.langchain4j.qdrant.port`]## + +[.description] +-- +The gRPC port of the Qdrant server. Defaults to 6334 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`6334` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-api-key]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-api-key[`quarkus.langchain4j.qdrant.api-key`]## + +[.description] +-- +The Qdrant API key to authenticate with. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-use-tls]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-use-tls[`quarkus.langchain4j.qdrant.use-tls`]## + +[.description] +-- +Whether to use TLS(HTTPS). Defaults to false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_USE_TLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_USE_TLS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-payload-text-key]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-payload-text-key[`quarkus.langchain4j.qdrant.payload-text-key`]## + +[.description] +-- +The field name of the text segment in the payload. Defaults to "text_segment" + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_PAYLOAD_TEXT_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_PAYLOAD_TEXT_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text_segment` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-collection-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-collection-name[`quarkus.langchain4j.qdrant.collection.name`]## + +[.description] +-- +The name of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_COLLECTION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_COLLECTION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant_quarkus.langchain4j.adoc new file mode 100644 index 000000000..ecbb51216 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-qdrant_quarkus.langchain4j.adoc @@ -0,0 +1,235 @@ +:summaryTableId: quarkus-langchain4j-qdrant_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-enabled]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-enabled[`quarkus.langchain4j.qdrant.devservices.enabled`]## + +[.description] +-- +Whether Dev Services for Qdrant are enabled or not. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-qdrant-image-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-qdrant-image-name[`quarkus.langchain4j.qdrant.devservices.qdrant-image-name`]## + +[.description] +-- +Container image for Qdrant. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_QDRANT_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_QDRANT_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`docker.io/qdrant/qdrant:v1.8.3-unprivileged` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-port]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-port[`quarkus.langchain4j.qdrant.devservices.port`]## + +[.description] +-- +Optional fixed port the Qdrant dev service will listen to. If not defined, the port will be chosen randomly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-shared]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-shared[`quarkus.langchain4j.qdrant.devservices.shared`]## + +[.description] +-- +Indicates if the Dev Service containers managed by Quarkus for Qdrant are shared. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-service-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-service-name[`quarkus.langchain4j.qdrant.devservices.service-name`]## + +[.description] +-- +Service label to apply to created Dev Services containers. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`qdrant` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-distance]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-distance[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.distance`]## + +[.description] +-- +Distance function used for comparing vectors + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_DISTANCE+++` +endif::add-copy-button-to-env-var[] +-- +a|Distance +|required icon:exclamation-circle[title=Configuration property is required] + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-devservices-collection-vector-params-size[`quarkus.langchain4j.qdrant.devservices.collection.vector-params.size`]## + +[.description] +-- +Size of the vectors + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_DEVSERVICES_COLLECTION_VECTOR_PARAMS_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`0l` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-host]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-host[`quarkus.langchain4j.qdrant.host`]## + +[.description] +-- +The URL of the Qdrant server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-port]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-port[`quarkus.langchain4j.qdrant.port`]## + +[.description] +-- +The gRPC port of the Qdrant server. Defaults to 6334 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`6334` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-api-key]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-api-key[`quarkus.langchain4j.qdrant.api-key`]## + +[.description] +-- +The Qdrant API key to authenticate with. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_API_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-use-tls]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-use-tls[`quarkus.langchain4j.qdrant.use-tls`]## + +[.description] +-- +Whether to use TLS(HTTPS). Defaults to false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_USE_TLS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_USE_TLS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-payload-text-key]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-payload-text-key[`quarkus.langchain4j.qdrant.payload-text-key`]## + +[.description] +-- +The field name of the text segment in the payload. Defaults to "text_segment" + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_PAYLOAD_TEXT_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_PAYLOAD_TEXT_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`text_segment` + +a| [[quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-collection-name]] [.property-path]##link:#quarkus-langchain4j-qdrant_quarkus-langchain4j-qdrant-collection-name[`quarkus.langchain4j.qdrant.collection.name`]## + +[.description] +-- +The name of the collection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_QDRANT_COLLECTION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_QDRANT_COLLECTION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis.adoc index b6b111854..8d9c61b1e 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis.adoc @@ -1,154 +1,150 @@ - -:summaryTableId: quarkus-langchain4j-redis +:summaryTableId: quarkus-langchain4j-redis_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-redis_configuration]]link:#quarkus-langchain4j-redis_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name[quarkus.langchain4j.redis.client-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name[`quarkus.langchain4j.redis.client-name`]## [.description] -- The name of the Redis client to use. These clients are configured by means of the `redis-client` extension. If unspecified, it will use the default Redis client. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension[quarkus.langchain4j.redis.dimension]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension[`quarkus.langchain4j.redis.dimension`]## [.description] -- The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_DIMENSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DIMENSION+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name[quarkus.langchain4j.redis.index-name]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name[`quarkus.langchain4j.redis.index-name`]## [.description] -- Name of the index that will be used in Redis when searching for related embeddings. If this index doesn't exist, it will be created. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_INDEX_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_INDEX_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`embedding-index` - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields[quarkus.langchain4j.redis.textual-metadata-fields]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields[`quarkus.langchain4j.redis.textual-metadata-fields`]## [.description] -- Names of fields that will store textual metadata associated with embeddings. NOTE: Filtering based on textual metadata fields is not supported at the moment. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_TEXTUAL_METADATA_FIELDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_TEXTUAL_METADATA_FIELDS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields[quarkus.langchain4j.redis.numeric-metadata-fields]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields[`quarkus.langchain4j.redis.numeric-metadata-fields`]## [.description] -- Names of fields that will store numeric metadata associated with embeddings. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_NUMERIC_METADATA_FIELDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_NUMERIC_METADATA_FIELDS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric[quarkus.langchain4j.redis.distance-metric]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric[`quarkus.langchain4j.redis.distance-metric`]## [.description] -- Metric used to compute the distance between two vectors. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++` endif::add-copy-button-to-env-var[] --- a| -`l2`, `ip`, `cosine` +-- +a|DistanceMetric |`cosine` - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name[quarkus.langchain4j.redis.vector-field-name]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name[`quarkus.langchain4j.redis.vector-field-name`]## [.description] -- Name of the key that will be used to store the embedding vector. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_FIELD_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_FIELD_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`vector` - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name[quarkus.langchain4j.redis.scalar-field-name]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name[`quarkus.langchain4j.redis.scalar-field-name`]## [.description] -- Name of the key that will be used to store the embedded text. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_SCALAR_FIELD_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_SCALAR_FIELD_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`scalar` - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix[quarkus.langchain4j.redis.prefix]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix[`quarkus.langchain4j.redis.prefix`]## [.description] -- @@ -156,31 +152,35 @@ Prefix to be applied to all keys by the embedding store. Embeddings are stored i If the configured prefix does not ends with `:`, it will be added automatically to follow the Redis convention. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`embedding:` - -a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm]]`link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm[quarkus.langchain4j.redis.vector-algorithm]` - +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm[`quarkus.langchain4j.redis.vector-algorithm`]## [.description] -- Algorithm used to index the embedding vectors. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++` endif::add-copy-button-to-env-var[] --- a| -`flat`, `hnsw` +-- +a|VectorAlgorithm |`hnsw` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis_quarkus.langchain4j.adoc new file mode 100644 index 000000000..8d9c61b1e --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-redis_quarkus.langchain4j.adoc @@ -0,0 +1,186 @@ +:summaryTableId: quarkus-langchain4j-redis_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-client-name[`quarkus.langchain4j.redis.client-name`]## + +[.description] +-- +The name of the Redis client to use. These clients are configured by means of the `redis-client` extension. If unspecified, it will use the default Redis client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-dimension[`quarkus.langchain4j.redis.dimension`]## + +[.description] +-- +The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DIMENSION+++` +endif::add-copy-button-to-env-var[] +-- +|long +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-index-name[`quarkus.langchain4j.redis.index-name`]## + +[.description] +-- +Name of the index that will be used in Redis when searching for related embeddings. If this index doesn't exist, it will be created. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_INDEX_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_INDEX_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embedding-index` + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-textual-metadata-fields[`quarkus.langchain4j.redis.textual-metadata-fields`]## + +[.description] +-- +Names of fields that will store textual metadata associated with embeddings. NOTE: Filtering based on textual metadata fields is not supported at the moment. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_TEXTUAL_METADATA_FIELDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_TEXTUAL_METADATA_FIELDS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-numeric-metadata-fields[`quarkus.langchain4j.redis.numeric-metadata-fields`]## + +[.description] +-- +Names of fields that will store numeric metadata associated with embeddings. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_NUMERIC_METADATA_FIELDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_NUMERIC_METADATA_FIELDS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-distance-metric[`quarkus.langchain4j.redis.distance-metric`]## + +[.description] +-- +Metric used to compute the distance between two vectors. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_DISTANCE_METRIC+++` +endif::add-copy-button-to-env-var[] +-- +a|DistanceMetric +|`cosine` + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-field-name[`quarkus.langchain4j.redis.vector-field-name`]## + +[.description] +-- +Name of the key that will be used to store the embedding vector. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`vector` + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-scalar-field-name[`quarkus.langchain4j.redis.scalar-field-name`]## + +[.description] +-- +Name of the key that will be used to store the embedded text. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_SCALAR_FIELD_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_SCALAR_FIELD_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`scalar` + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-prefix[`quarkus.langchain4j.redis.prefix`]## + +[.description] +-- +Prefix to be applied to all keys by the embedding store. Embeddings are stored in Redis under a key that is the concatenation of this prefix and the embedding ID. + +If the configured prefix does not ends with `:`, it will be added automatically to follow the Redis convention. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`embedding:` + +a| [[quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm]] [.property-path]##link:#quarkus-langchain4j-redis_quarkus-langchain4j-redis-vector-algorithm[`quarkus.langchain4j.redis.vector-algorithm`]## + +[.description] +-- +Algorithm used to index the embedding vectors. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_REDIS_VECTOR_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +a|VectorAlgorithm +|`hnsw` + +|=== + + +:!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 6744067e9..c5fe266be 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily.adoc @@ -1,207 +1,205 @@ - -:summaryTableId: quarkus-langchain4j-tavily +:summaryTableId: quarkus-langchain4j-tavily_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-tavily_configuration]]link:#quarkus-langchain4j-tavily_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-base-url]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-base-url[quarkus.langchain4j.tavily.base-url]` - +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 +-- +|string |`https://api.tavily.com` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-api-key]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-api-key[quarkus.langchain4j.tavily.api-key]` - +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 +-- +|string |required icon:exclamation-circle[title=Configuration property is required] - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-max-results]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-max-results[quarkus.langchain4j.tavily.max-results]` - +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 +-- +|int |`5` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-timeout]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-timeout[quarkus.langchain4j.tavily.timeout]` - +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/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]] |`60S` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-requests]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-requests[quarkus.langchain4j.tavily.log-requests]` - +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 +-- +|boolean |`false` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-responses]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-log-responses[quarkus.langchain4j.tavily.log-responses]` - +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 +-- +|boolean |`false` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-search-depth]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-search-depth[quarkus.langchain4j.tavily.search-depth]` - +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| -`basic`, `advanced` +-- +a|SearchDepth |`basic` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-answer[quarkus.langchain4j.tavily.include-answer]` - +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 +-- +|boolean |`false` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-raw-content]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-raw-content[quarkus.langchain4j.tavily.include-raw-content]` - +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 +-- +|boolean |`false` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-domains]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-include-domains[quarkus.langchain4j.tavily.include-domains]` - +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 +-- +|list of string |`[]` - -a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains]]`link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains[quarkus.langchain4j.tavily.exclude-domains]` - +a| [[quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains]] [.property-path]##link:#quarkus-langchain4j-tavily_quarkus-langchain4j-tavily-exclude-domains[`quarkus.langchain4j.tavily.exclude-domains`]## [.description] -- A list of domains to specifically exclude from the search results. Default is ++[]++, which doesn't exclude any domains. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_TAVILY_EXCLUDE_DOMAINS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_EXCLUDE_DOMAINS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string |`[]` |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-tavily_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -218,3 +216,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-tavily_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc new file mode 100644 index 000000000..c5fe266be --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-tavily_quarkus.langchain4j.adoc @@ -0,0 +1,220 @@ +:summaryTableId: quarkus-langchain4j-tavily_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|[.header-title]##Configuration property## +h|Type +h|Default + +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[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_TAVILY_EXCLUDE_DOMAINS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`[]` + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-tavily_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-vertex-ai-gemini.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini.adoc new file mode 100644 index 000000000..0ec763e78 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini.adoc @@ -0,0 +1,651 @@ +:summaryTableId: quarkus-langchain4j-vertex-ai-gemini_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-enabled[`quarkus.langchain4j.vertexai.gemini.chat-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_VERTEXAI_GEMINI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-project-id[`quarkus.langchain4j.vertexai.gemini.project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-location[`quarkus.langchain4j.vertexai.gemini.location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-publisher[`quarkus.langchain4j.vertexai.gemini.publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-base-url[`quarkus.langchain4j.vertexai.gemini.base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-enable-integration[`quarkus.langchain4j.vertexai.gemini.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Vertex AI Gemini provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-requests[`quarkus.langchain4j.vertexai.gemini.log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-responses[`quarkus.langchain4j.vertexai.gemini.log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-timeout[`quarkus.langchain4j.vertexai.gemini.timeout`]## + +[.description] +-- +Timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_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]] +|`${QUARKUS.LANGCHAIN4J.TIMEOUT}` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-model-id[`quarkus.langchain4j.vertexai.gemini.chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gemini-pro` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-temperature[`quarkus.langchain4j.vertexai.gemini.chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + +Range for gemini-1.0-pro-001 + +Range for gemini-1.0-pro-002, gemini-1.5-pro: 0.0 - 2.0 + +Default for gemini-1.5-pro and gemini-1.0-pro-002: 1.0 + +Default for gemini-1.0-pro-001: 0.9 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.gemini.chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8192` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-p[`quarkus.langchain4j.vertexai.gemini.chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 0.0 - 1.0 + +gemini-1.0-pro and gemini-1.5-pro don't support topK + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-k[`quarkus.langchain4j.vertexai.gemini.chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 1-40 + +Default for gemini-1.5-pro: 0.94 + +Default for gemini-1.0-pro: 1 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-requests[`quarkus.langchain4j.vertexai.gemini.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-responses[`quarkus.langchain4j.vertexai.gemini.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-timeout[`quarkus.langchain4j.vertexai.gemini.chat-model.timeout`]## + +[.description] +-- +Global timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_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]] +|`10s` + +h|[[quarkus-langchain4j-vertex-ai-gemini_section_quarkus-langchain4j-vertexai-gemini]] [.section-name.section-level0]##link:#quarkus-langchain4j-vertex-ai-gemini_section_quarkus-langchain4j-vertexai-gemini[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-project-id[`quarkus.langchain4j.vertexai.gemini."model-name".project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-location[`quarkus.langchain4j.vertexai.gemini."model-name".location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-publisher[`quarkus.langchain4j.vertexai.gemini."model-name".publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-base-url[`quarkus.langchain4j.vertexai.gemini."model-name".base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-enable-integration[`quarkus.langchain4j.vertexai.gemini."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Vertex AI Gemini provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-requests[`quarkus.langchain4j.vertexai.gemini."model-name".log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-responses[`quarkus.langchain4j.vertexai.gemini."model-name".log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-timeout[`quarkus.langchain4j.vertexai.gemini."model-name".timeout`]## + +[.description] +-- +Timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__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]] +|`${QUARKUS.LANGCHAIN4J.TIMEOUT}` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-model-id[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gemini-pro` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-temperature[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + +Range for gemini-1.0-pro-001 + +Range for gemini-1.0-pro-002, gemini-1.5-pro: 0.0 - 2.0 + +Default for gemini-1.5-pro and gemini-1.0-pro-002: 1.0 + +Default for gemini-1.0-pro-001: 0.9 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8192` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-p[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 0.0 - 1.0 + +gemini-1.0-pro and gemini-1.5-pro don't support topK + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-k[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 1-40 + +Default for gemini-1.5-pro: 0.94 + +Default for gemini-1.0-pro: 1 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-requests[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-responses[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-timeout[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.timeout`]## + +[.description] +-- +Global timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_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]] +|`10s` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-vertex-ai-gemini_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini_quarkus.langchain4j.adoc new file mode 100644 index 000000000..0ec763e78 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai-gemini_quarkus.langchain4j.adoc @@ -0,0 +1,651 @@ +:summaryTableId: quarkus-langchain4j-vertex-ai-gemini_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-enabled[`quarkus.langchain4j.vertexai.gemini.chat-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_VERTEXAI_GEMINI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-project-id[`quarkus.langchain4j.vertexai.gemini.project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-location[`quarkus.langchain4j.vertexai.gemini.location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-publisher[`quarkus.langchain4j.vertexai.gemini.publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-base-url[`quarkus.langchain4j.vertexai.gemini.base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-enable-integration[`quarkus.langchain4j.vertexai.gemini.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Vertex AI Gemini provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-requests[`quarkus.langchain4j.vertexai.gemini.log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-log-responses[`quarkus.langchain4j.vertexai.gemini.log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-timeout[`quarkus.langchain4j.vertexai.gemini.timeout`]## + +[.description] +-- +Timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_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]] +|`${QUARKUS.LANGCHAIN4J.TIMEOUT}` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-model-id[`quarkus.langchain4j.vertexai.gemini.chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gemini-pro` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-temperature[`quarkus.langchain4j.vertexai.gemini.chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + +Range for gemini-1.0-pro-001 + +Range for gemini-1.0-pro-002, gemini-1.5-pro: 0.0 - 2.0 + +Default for gemini-1.5-pro and gemini-1.0-pro-002: 1.0 + +Default for gemini-1.0-pro-001: 0.9 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.gemini.chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8192` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-p[`quarkus.langchain4j.vertexai.gemini.chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 0.0 - 1.0 + +gemini-1.0-pro and gemini-1.5-pro don't support topK + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-top-k[`quarkus.langchain4j.vertexai.gemini.chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 1-40 + +Default for gemini-1.5-pro: 0.94 + +Default for gemini-1.0-pro: 1 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-requests[`quarkus.langchain4j.vertexai.gemini.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-log-responses[`quarkus.langchain4j.vertexai.gemini.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-chat-model-timeout[`quarkus.langchain4j.vertexai.gemini.chat-model.timeout`]## + +[.description] +-- +Global timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI_CHAT_MODEL_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]] +|`10s` + +h|[[quarkus-langchain4j-vertex-ai-gemini_section_quarkus-langchain4j-vertexai-gemini]] [.section-name.section-level0]##link:#quarkus-langchain4j-vertex-ai-gemini_section_quarkus-langchain4j-vertexai-gemini[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-project-id[`quarkus.langchain4j.vertexai.gemini."model-name".project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-location[`quarkus.langchain4j.vertexai.gemini."model-name".location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-publisher[`quarkus.langchain4j.vertexai.gemini."model-name".publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-base-url[`quarkus.langchain4j.vertexai.gemini."model-name".base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-enable-integration[`quarkus.langchain4j.vertexai.gemini."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Vertex AI Gemini provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-requests[`quarkus.langchain4j.vertexai.gemini."model-name".log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-log-responses[`quarkus.langchain4j.vertexai.gemini."model-name".log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-timeout[`quarkus.langchain4j.vertexai.gemini."model-name".timeout`]## + +[.description] +-- +Timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__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]] +|`${QUARKUS.LANGCHAIN4J.TIMEOUT}` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-model-id[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`gemini-pro` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-temperature[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + +Range for gemini-1.0-pro-001 + +Range for gemini-1.0-pro-002, gemini-1.5-pro: 0.0 - 2.0 + +Default for gemini-1.5-pro and gemini-1.0-pro-002: 1.0 + +Default for gemini-1.0-pro-001: 0.9 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8192` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-p[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 0.0 - 1.0 + +gemini-1.0-pro and gemini-1.5-pro don't support topK + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-top-k[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + +Range: 1-40 + +Default for gemini-1.5-pro: 0.94 + +Default for gemini-1.0-pro: 1 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-requests[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-log-responses[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-timeout]] [.property-path]##link:#quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j-vertexai-gemini-model-name-chat-model-timeout[`quarkus.langchain4j.vertexai.gemini."model-name".chat-model.timeout`]## + +[.description] +-- +Global timeout for requests to gemini APIs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_GEMINI__MODEL_NAME__CHAT_MODEL_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]] +|`10s` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-vertex-ai-gemini_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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-vertex-ai.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai.adoc new file mode 100644 index 000000000..42595c6e2 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai.adoc @@ -0,0 +1,528 @@ +:summaryTableId: quarkus-langchain4j-vertex-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-enabled[`quarkus.langchain4j.vertexai.chat-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_VERTEXAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-project-id[`quarkus.langchain4j.vertexai.project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-location[`quarkus.langchain4j.vertexai.location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-publisher[`quarkus.langchain4j.vertexai.publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-base-url[`quarkus.langchain4j.vertexai.base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-enable-integration[`quarkus.langchain4j.vertexai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-requests[`quarkus.langchain4j.vertexai.log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-responses[`quarkus.langchain4j.vertexai.log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-model-id[`quarkus.langchain4j.vertexai.chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat-bison` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-temperature[`quarkus.langchain4j.vertexai.chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-p[`quarkus.langchain4j.vertexai.chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.95` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-k[`quarkus.langchain4j.vertexai.chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-requests[`quarkus.langchain4j.vertexai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-responses[`quarkus.langchain4j.vertexai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-vertex-ai_section_quarkus-langchain4j-vertexai]] [.section-name.section-level0]##link:#quarkus-langchain4j-vertex-ai_section_quarkus-langchain4j-vertexai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-project-id[`quarkus.langchain4j.vertexai."model-name".project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-location[`quarkus.langchain4j.vertexai."model-name".location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-publisher[`quarkus.langchain4j.vertexai."model-name".publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-base-url[`quarkus.langchain4j.vertexai."model-name".base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-enable-integration[`quarkus.langchain4j.vertexai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-requests[`quarkus.langchain4j.vertexai."model-name".log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-responses[`quarkus.langchain4j.vertexai."model-name".log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-model-id[`quarkus.langchain4j.vertexai."model-name".chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat-bison` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-temperature[`quarkus.langchain4j.vertexai."model-name".chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai."model-name".chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-p[`quarkus.langchain4j.vertexai."model-name".chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.95` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-k[`quarkus.langchain4j.vertexai."model-name".chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-requests[`quarkus.langchain4j.vertexai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-responses[`quarkus.langchain4j.vertexai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai_quarkus.langchain4j.adoc new file mode 100644 index 000000000..42595c6e2 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-vertex-ai_quarkus.langchain4j.adoc @@ -0,0 +1,528 @@ +:summaryTableId: quarkus-langchain4j-vertex-ai_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-enabled[`quarkus.langchain4j.vertexai.chat-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_VERTEXAI_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-project-id[`quarkus.langchain4j.vertexai.project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-location[`quarkus.langchain4j.vertexai.location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-publisher[`quarkus.langchain4j.vertexai.publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-base-url[`quarkus.langchain4j.vertexai.base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-enable-integration[`quarkus.langchain4j.vertexai.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-requests[`quarkus.langchain4j.vertexai.log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-log-responses[`quarkus.langchain4j.vertexai.log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-model-id[`quarkus.langchain4j.vertexai.chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat-bison` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-temperature[`quarkus.langchain4j.vertexai.chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai.chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-p[`quarkus.langchain4j.vertexai.chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.95` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-top-k[`quarkus.langchain4j.vertexai.chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-requests[`quarkus.langchain4j.vertexai.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-chat-model-log-responses[`quarkus.langchain4j.vertexai.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-vertex-ai_section_quarkus-langchain4j-vertexai]] [.section-name.section-level0]##link:#quarkus-langchain4j-vertex-ai_section_quarkus-langchain4j-vertexai[Named model config]## +h|Type +h|Default + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-project-id[`quarkus.langchain4j.vertexai."model-name".project-id`]## + +[.description] +-- +The unique identifier of the project + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-location]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-location[`quarkus.langchain4j.vertexai."model-name".location`]## + +[.description] +-- +GCP location + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`dummy` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-publisher]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-publisher[`quarkus.langchain4j.vertexai."model-name".publisher`]## + +[.description] +-- +Publisher of model + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PUBLISHER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__PUBLISHER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`google` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-base-url[`quarkus.langchain4j.vertexai."model-name".base-url`]## + +[.description] +-- +Meant to be used for testing only in order to override the base URL used by the client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-enable-integration[`quarkus.langchain4j.vertexai."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the Anthropic provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-requests[`quarkus.langchain4j.vertexai."model-name".log-requests`]## + +[.description] +-- +Whether the Vertex AI client should log requests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-log-responses[`quarkus.langchain4j.vertexai."model-name".log-responses`]## + +[.description] +-- +Whether the Vertex AI client should log responses + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-model-id[`quarkus.langchain4j.vertexai."model-name".chat-model.model-id`]## + +[.description] +-- +The id of the model to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat-bison` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-temperature[`quarkus.langchain4j.vertexai."model-name".chat-model.temperature`]## + +[.description] +-- +The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible. + +If the model returns a response that's too generic, too short, or the model gives a fallback response, try increasing the temperature. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.0` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-max-output-tokens]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-max-output-tokens[`quarkus.langchain4j.vertexai."model-name".chat-model.max-output-tokens`]## + +[.description] +-- +Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words. Specify a lower value for shorter responses and a higher value for potentially longer responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_MAX_OUTPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-p[`quarkus.langchain4j.vertexai."model-name".chat-model.top-p`]## + +[.description] +-- +Top-P changes how the model selects tokens for output. Tokens are selected from the most (see top-K) to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0.95` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-k]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-top-k[`quarkus.langchain4j.vertexai."model-name".chat-model.top-k`]## + +[.description] +-- +Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature. + +For each token selection step, the top-K tokens with the highest probabilities are sampled. Then tokens are further filtered based on top-P with the final token selected using temperature sampling. + +Specify a lower value for less random responses and a higher value for more random responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`40` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-requests[`quarkus.langchain4j.vertexai."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-vertex-ai_quarkus-langchain4j-vertexai-model-name-chat-model-log-responses[`quarkus.langchain4j.vertexai."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_VERTEXAI__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc index 56c726a29..23b44ed27 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc @@ -1,107 +1,104 @@ - -:summaryTableId: quarkus-langchain4j-watsonx +:summaryTableId: quarkus-langchain4j-watsonx_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-watsonx_configuration]]link:#quarkus-langchain4j-watsonx_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled[quarkus.langchain4j.watsonx.chat-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled[`quarkus.langchain4j.watsonx.chat-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_WATSONX_CHAT_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled[quarkus.langchain4j.watsonx.embedding-model.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled[`quarkus.langchain4j.watsonx.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_WATSONX_EMBEDDING_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id[quarkus.langchain4j.watsonx.chat-model.model-id]` - +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-enabled[`quarkus.langchain4j.watsonx.scoring-model.enabled`]## [.description] -- -Model id to use. +Whether the scoring model should be enabled. -To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_ENABLED+++` endif::add-copy-button-to-env-var[] ---|string -|`ibm/granite-13b-chat-v2` - - -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-prompt-formatter]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-prompt-formatter[quarkus.langchain4j.watsonx.chat-model.prompt-formatter]` +-- +|boolean +|`true` +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-mode]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-mode[`quarkus.langchain4j.watsonx.mode`]## [.description] -- -Configuration property that enables or disables the functionality of the prompt formatter. +Specifies the mode of interaction with the LLM model. + +This property allows you to choose between two modes of operation: + + - *chat*: prompts are automatically enriched with the specific tags defined by the model + - *generation*: prompts require manual specification of tags *Allowable values:* `++[++chat, generation++]++` - - `true`: When enabled, prompts are automatically enriched with the specific tags defined by the model. - - `false`: Prompts will not be enriched with the model's tags. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PROMPT_FORMATTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PROMPT_FORMATTER+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_MODE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url[quarkus.langchain4j.watsonx.base-url]` +-- +|string +|`chat` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url[`quarkus.langchain4j.watsonx.base-url`]## [.description] -- Base URL of the watsonx.ai API. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_BASE_URL+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`https://dummy.ai/api` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-api-key[quarkus.langchain4j.watsonx.api-key]` - +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`]## [.description] -- @@ -109,315 +106,326 @@ IBM Cloud API key. To create a new API key, follow this link:https://cloud.ibm.com/iam/apikeys[link]. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_API_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_API_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`dummy` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout[quarkus.langchain4j.watsonx.timeout]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-timeout[`quarkus.langchain4j.watsonx.timeout`]## [.description] -- Timeout for watsonx.ai calls. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_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-watsonx_quarkus-langchain4j-watsonx-version]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-version[quarkus.langchain4j.watsonx.version]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-version]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-version[`quarkus.langchain4j.watsonx.version`]## [.description] -- The version date for the API of the form YYYY-MM-DD. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_VERSION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`2024-03-14` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-space-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-space-id[`quarkus.langchain4j.watsonx.space-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or `project_id` has to be given. -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id[quarkus.langchain4j.watsonx.project-id]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SPACE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SPACE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id[`quarkus.langchain4j.watsonx.project-id`]## [.description] -- -The project that contains the watsonx.ai resource. +The space that contains the resource. Either `space_id` or project_id has to be given. To look up your project id, link:https://dataplatform.cloud.ibm.com/projects/?context=wx[click here]. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_PROJECT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_PROJECT_ID+++` endif::add-copy-button-to-env-var[] ---|string -|`dummy` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests[quarkus.langchain4j.watsonx.log-requests]` +-- +|string +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests[`quarkus.langchain4j.watsonx.log-requests`]## [.description] -- Whether the watsonx.ai client should log requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses[quarkus.langchain4j.watsonx.log-responses]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses[`quarkus.langchain4j.watsonx.log-responses`]## [.description] -- Whether the watsonx.ai client should log responses. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration[quarkus.langchain4j.watsonx.enable-integration]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration[`quarkus.langchain4j.watsonx.enable-integration`]## [.description] -- Whether to enable the integration. Defaults to `true`, which means requests are made to the watsonx.ai provider. Set to `false` to disable all requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_ENABLE_INTEGRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_ENABLE_INTEGRATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url[quarkus.langchain4j.watsonx.iam.base-url]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url[`quarkus.langchain4j.watsonx.iam.base-url`]## [.description] -- Base URL of the IAM Authentication API. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_BASE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_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://iam.cloud.ibm.com` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout[quarkus.langchain4j.watsonx.iam.timeout]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout[`quarkus.langchain4j.watsonx.iam.timeout`]## [.description] -- Timeout for IAM authentication calls. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_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-watsonx_quarkus-langchain4j-watsonx-iam-grant-type]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-grant-type[quarkus.langchain4j.watsonx.iam.grant-type]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-grant-type]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-grant-type[`quarkus.langchain4j.watsonx.iam.grant-type`]## [.description] -- Grant type for the IAM Authentication API. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_GRANT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_GRANT_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`urn:ibm:params:oauth:grant-type:apikey` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-decoding-method]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-decoding-method[quarkus.langchain4j.watsonx.chat-model.decoding-method]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id[`quarkus.langchain4j.watsonx.chat-model.model-id`]## [.description] -- -Represents the strategy used for picking the tokens during generation of the output text. 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. +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. -*Allowable values:* `++[++sample,greedy++]++` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_DECODING_METHOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_DECODING_METHOD+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string -|`greedy` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-length-penalty-decay-factor]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-length-penalty-decay-factor[quarkus.langchain4j.watsonx.chat-model.length-penalty.decay-factor]` +-- +|string +|`mistralai/mistral-large` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-frequency-penalty[`quarkus.langchain4j.watsonx.chat-model.frequency-penalty`]## [.description] -- -Represents the factor of exponential decay. Larger values correspond to more aggressive decay. +Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + +*Possible values:* `-2 < value < 2` -*Possible values:* `> 1` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_FREQUENCY_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_FREQUENCY_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-length-penalty-start-index]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-length-penalty-start-index[quarkus.langchain4j.watsonx.chat-model.length-penalty.start-index]` +-- +|double +|`0` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-logprobs[`quarkus.langchain4j.watsonx.chat-model.logprobs`]## [.description] -- -A number of generated tokens after which this should take effect. +Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. -*Possible values:* `≥ 0` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LENGTH_PENALTY_START_INDEX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOGPROBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LENGTH_PENALTY_START_INDEX+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOGPROBS+++` endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-new-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-new-tokens[quarkus.langchain4j.watsonx.chat-model.max-new-tokens]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-logprobs[`quarkus.langchain4j.watsonx.chat-model.top-logprobs`]## [.description] -- -The maximum number of new tokens to be generated. The maximum supported value for this field depends on the model being used. How the "token" is defined depends on the tokenizer and vocabulary size, which in turn depends on the model. Often the tokens are a mix of full words and sub-words. Depending on the users plan, and on the model being used, there may be an enforced maximum number of new tokens. +An integer specifying the number of most likely tokens to return at each token position, each with an associated log probability. The option `logprobs` must be set to `true` if this parameter is used. + +*Possible values:* `0 ≤ value ≤ 20` ++*++ -*Possible values:* `≥ 0` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_NEW_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_LOGPROBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_NEW_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_LOGPROBS+++` endif::add-copy-button-to-env-var[] ---|int -|`200` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-min-new-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-min-new-tokens[quarkus.langchain4j.watsonx.chat-model.min-new-tokens]` +-- +|int +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-tokens[`quarkus.langchain4j.watsonx.chat-model.max-tokens`]## [.description] -- -If stop sequences are given, they are ignored until minimum tokens are generated. +The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. -*Possible values:* `≥ 0` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MIN_NEW_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MIN_NEW_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int -|`0` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-random-seed]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-random-seed[quarkus.langchain4j.watsonx.chat-model.random-seed]` +-- +|int +|`1024` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-n]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-n[`quarkus.langchain4j.watsonx.chat-model.n`]## [.description] -- -Random number generator seed to use in sampling mode for experimental repeatability. +How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs -*Possible values:* `≥ 1` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RANDOM_SEED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_N+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RANDOM_SEED+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_N+++` endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-stop-sequences]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-stop-sequences[quarkus.langchain4j.watsonx.chat-model.stop-sequences]` +-- +|int +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-presence-penalty[`quarkus.langchain4j.watsonx.chat-model.presence-penalty`]## [.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. +Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + +*Possible values:* `-2 < value < 2` -*Possible values:* `0 ≤ number of items ≤ 6, contains only unique items` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_STOP_SEQUENCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PRESENCE_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_STOP_SEQUENCES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PRESENCE_PENALTY+++` endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature[quarkus.langchain4j.watsonx.chat-model.temperature]` +-- +|double +|`0` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature[`quarkus.langchain4j.watsonx.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. +What sampling temperature to use,. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic. + +We generally recommend altering this or `top_p` but not both. + +*Possible values:* `0 < value < 2` -*Possible values:* `0 ≤ value ≤ 2` ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TEMPERATURE+++[] @@ -425,446 +433,1018 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double -|`1.0` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-k]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-k[quarkus.langchain4j.watsonx.chat-model.top-k]` +-- +|double +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p[`quarkus.langchain4j.watsonx.chat-model.top-p`]## [.description] -- -The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for `sampling` mode. When decoding_strategy is set to `sample`, only the `top_k` most likely tokens are considered as candidates for the next generated token. +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So `0.1` means only the tokens comprising the top 10% probability mass are considered. + +We generally recommend altering this or `temperature` but not both. + +*Possible values:* `0 < value < 1` -*Possible values:* `1 ≤ value ≤ 100` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_K+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_K+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p[quarkus.langchain4j.watsonx.chat-model.top-p]` +-- +|double +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-response-format[`quarkus.langchain4j.watsonx.chat-model.response-format`]## [.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`. Also known as nucleus sampling. A value of `1.0` is equivalent to disabled. +Specifies the desired format for the model's output. + +*Allowable values:* `++[++json_object++]++` ++*++ + +*Applicable in modes:* `++[++chat++]++` -*Possible values:* `0 < value ≤ 1` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|double +-- +|string | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-repetition-penalty]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-repetition-penalty[quarkus.langchain4j.watsonx.chat-model.repetition-penalty]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests[`quarkus.langchain4j.watsonx.chat-model.log-requests`]## [.description] -- -Represents the penalty for penalizing tokens that have already been generated or belong to the context. The value `1.0` means that there is no penalty. +Whether chat model requests should be logged. -*Possible values:* `1 ≤ value ≤ 2` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_REPETITION_PENALTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_REPETITION_PENALTY+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|double -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-truncate-input-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-truncate-input-tokens[quarkus.langchain4j.watsonx.chat-model.truncate-input-tokens]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses[`quarkus.langchain4j.watsonx.chat-model.log-responses`]## [.description] -- -Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the start of the input (on the left), so the end of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. Zero means don't truncate. +Whether chat model responses should be logged. -*Possible values:* `≥ 0` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-include-stop-sequence]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-include-stop-sequence[quarkus.langchain4j.watsonx.chat-model.include-stop-sequence]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-model-id[`quarkus.langchain4j.watsonx.generation-model.model-id`]## [.description] -- -Pass `false` to omit matched stop sequences from the end of the output text. The default is `true`, meaning that the output will end with the stop sequence text when matched. +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests[quarkus.langchain4j.watsonx.chat-model.log-requests]` +-- +|string +|`mistralai/mistral-large` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-decoding-method[`quarkus.langchain4j.watsonx.generation-model.decoding-method`]## [.description] -- -Whether chat model requests should be logged. +Represents the strategy used for picking the tokens during generation of the output text. 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. + +*Allowable values:* `++[++sample,greedy++]++` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_DECODING_METHOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_DECODING_METHOD+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses[quarkus.langchain4j.watsonx.chat-model.log-responses]` +-- +|string +|`greedy` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-decay-factor]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-decay-factor[`quarkus.langchain4j.watsonx.generation-model.length-penalty.decay-factor`]## [.description] -- -Whether chat model responses should be logged. +Represents the factor of exponential decay. Larger values correspond to more aggressive decay. + +*Possible values:* `> 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-prompt-joiner]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-prompt-joiner[quarkus.langchain4j.watsonx.chat-model.prompt-joiner]` +-- +|double +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-start-index]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-start-index[`quarkus.langchain4j.watsonx.generation-model.length-penalty.start-index`]## [.description] -- -Delimiter used to concatenate the ChatMessage elements into a single string. By setting this property, you can define your preferred way of concatenating messages to ensure that the prompt is structured in the correct way. +A number of generated tokens after which this should take effect. + +*Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PROMPT_JOINER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PROMPT_JOINER+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++` endif::add-copy-button-to-env-var[] ---|string -|` -` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id[quarkus.langchain4j.watsonx.embedding-model.model-id]` +-- +|int +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-max-new-tokens[`quarkus.langchain4j.watsonx.generation-model.max-new-tokens`]## [.description] -- -Model id to use. To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. +The maximum number of new tokens to be generated. The maximum supported value for this field depends on the model being used. How the "token" is defined depends on the tokenizer and vocabulary size, which in turn depends on the model. Often the tokens are a mix of full words and sub-words. Depending on the users plan, and on the model being used, there may be an enforced maximum number of new tokens. + +*Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MAX_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MAX_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|string -|`ibm/slate-125m-english-rtrvr` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests[quarkus.langchain4j.watsonx.embedding-model.log-requests]` +-- +|int +|`200` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-min-new-tokens[`quarkus.langchain4j.watsonx.generation-model.min-new-tokens`]## [.description] -- -Whether embedding model requests should be logged. +If stop sequences are given, they are ignored until minimum tokens are generated. + +*Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MIN_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MIN_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses[quarkus.langchain4j.watsonx.embedding-model.log-responses]` +-- +|int +|`0` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-random-seed[`quarkus.langchain4j.watsonx.generation-model.random-seed`]## [.description] -- -Whether embedding model responses should be logged. +Random number generator seed to use in sampling mode for experimental repeatability. + +*Possible values:* `≥ 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_RANDOM_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_RANDOM_SEED+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` +-- +|int +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-stop-sequences[`quarkus.langchain4j.watsonx.generation-model.stop-sequences`]## -h|[[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-named-config-named-model-config]]link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-named-config-named-model-config[Named model config] +[.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. -h|Type -h|Default +*Possible values:* `0 ≤ number of items ≤ 6, contains only unique items` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_STOP_SEQUENCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_STOP_SEQUENCES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-temperature[`quarkus.langchain4j.watsonx.generation-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. + +*Possible values:* `0 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-k]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-k[`quarkus.langchain4j.watsonx.generation-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for `sampling` mode. When decoding_strategy is set to `sample`, only the `top_k` most likely tokens are considered as candidates for the next generated token. + +*Possible values:* `1 ≤ value ≤ 100` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-p[`quarkus.langchain4j.watsonx.generation-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`. Also known as nucleus sampling. A value of `1.0` is equivalent to disabled. + +*Possible values:* `0 < value ≤ 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id[quarkus.langchain4j.watsonx."model-name".chat-model.model-id]` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-repetition-penalty[`quarkus.langchain4j.watsonx.generation-model.repetition-penalty`]## +[.description] +-- +Represents the penalty for penalizing tokens that have already been generated or belong to the context. The value `1.0` means that there is no penalty. + +*Possible values:* `1 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.generation-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the start of the input (on the left), so the end of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. Zero means don't truncate. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-include-stop-sequence[`quarkus.langchain4j.watsonx.generation-model.include-stop-sequence`]## + +[.description] +-- +Pass `false` to omit matched stop sequences from the end of the output text. The default is `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_WATSONX_GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-requests[`quarkus.langchain4j.watsonx.generation-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-responses[`quarkus.langchain4j.watsonx.generation-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-prompt-joiner]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-prompt-joiner[`quarkus.langchain4j.watsonx.generation-model.prompt-joiner`]## + +[.description] +-- +Delimiter used to concatenate the ChatMessage elements into a single string. By setting this property, you can define your preferred way of concatenating messages to ensure that the prompt is structured in the correct way. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_PROMPT_JOINER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_PROMPT_JOINER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|` +` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id[`quarkus.langchain4j.watsonx.embedding-model.model-id`]## + +[.description] +-- +Model id to use. To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ibm/slate-125m-english-rtrvr` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.embedding-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests[`quarkus.langchain4j.watsonx.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses[`quarkus.langchain4j.watsonx.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-model-id[`quarkus.langchain4j.watsonx.scoring-model.model-id`]## [.description] -- Model id to use. -To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string -|`ibm/granite-13b-chat-v2` +-- +|string +|`cross-encoder/ms-marco-minilm-l-12-v2` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.scoring-model.truncate-input-tokens`]## +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. -a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-prompt-formatter]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-prompt-formatter[quarkus.langchain4j.watsonx."model-name".chat-model.prompt-formatter]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-requests[`quarkus.langchain4j.watsonx.scoring-model.log-requests`]## [.description] -- -Configuration property that enables or disables the functionality of the prompt formatter. +Whether embedding model requests should be logged. - - `true`: When enabled, prompts are automatically enriched with the specific tags defined by the model. - - `false`: Prompts will not be enriched with the model's tags. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PROMPT_FORMATTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PROMPT_FORMATTER+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-responses[`quarkus.langchain4j.watsonx.scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url[quarkus.langchain4j.watsonx."model-name".base-url]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-watsonx_section_quarkus-langchain4j-watsonx]] [.section-name.section-level0]##link:#quarkus-langchain4j-watsonx_section_quarkus-langchain4j-watsonx[Named model config]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-mode]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-mode[`quarkus.langchain4j.watsonx."model-name".mode`]## + +[.description] +-- +Specifies the mode of interaction with the LLM model. + +This property allows you to choose between two modes of operation: + + - *chat*: prompts are automatically enriched with the specific tags defined by the model + - *generation*: prompts require manual specification of tags *Allowable values:* `++[++chat, generation++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__MODE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url[`quarkus.langchain4j.watsonx."model-name".base-url`]## [.description] -- Base URL of the watsonx.ai API. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +IBM Cloud API key. + +To create a new API key, follow this link:https://cloud.ibm.com/iam/apikeys[link]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +Timeout for watsonx.ai calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version[`quarkus.langchain4j.watsonx."model-name".version`]## + +[.description] +-- +The version date for the API of the form YYYY-MM-DD. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2024-03-14` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-space-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-space-id[`quarkus.langchain4j.watsonx."model-name".space-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or `project_id` has to be given. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SPACE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SPACE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id[`quarkus.langchain4j.watsonx."model-name".project-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or project_id has to be given. + +To look up your project id, link:https://dataplatform.cloud.ibm.com/projects/?context=wx[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests[`quarkus.langchain4j.watsonx."model-name".log-requests`]## + +[.description] +-- +Whether the watsonx.ai client should log requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses[`quarkus.langchain4j.watsonx."model-name".log-responses`]## + +[.description] +-- +Whether the watsonx.ai client should log responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration[`quarkus.langchain4j.watsonx."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the watsonx.ai provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url[`quarkus.langchain4j.watsonx."model-name".iam.base-url`]## + +[.description] +-- +Base URL of the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://iam.cloud.ibm.com` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout[`quarkus.langchain4j.watsonx."model-name".iam.timeout`]## + +[.description] +-- +Timeout for IAM authentication calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type[`quarkus.langchain4j.watsonx."model-name".iam.grant-type`]## + +[.description] +-- +Grant type for the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`urn:ibm:params:oauth:grant-type:apikey` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id[`quarkus.langchain4j.watsonx."model-name".chat-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistralai/mistral-large` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.watsonx."model-name".chat-model.frequency-penalty`]## + +[.description] +-- +Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + +*Possible values:* `-2 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-logprobs[`quarkus.langchain4j.watsonx."model-name".chat-model.logprobs`]## + +[.description] +-- +Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. + + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOGPROBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOGPROBS+++` endif::add-copy-button-to-env-var[] ---|string -|`https://dummy.ai/api` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-api-key[quarkus.langchain4j.watsonx."model-name".api-key]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-logprobs[`quarkus.langchain4j.watsonx."model-name".chat-model.top-logprobs`]## [.description] -- -IBM Cloud API key. +An integer specifying the number of most likely tokens to return at each token position, each with an associated log probability. The option `logprobs` must be set to `true` if this parameter is used. + +*Possible values:* `0 ≤ value ≤ 20` ++*++ -To create a new API key, follow this link:https://cloud.ibm.com/iam/apikeys[link]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_LOGPROBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_LOGPROBS+++` endif::add-copy-button-to-env-var[] ---|string -|`dummy` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-timeout[quarkus.langchain4j.watsonx."model-name".timeout]` +-- +|int +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-tokens[`quarkus.langchain4j.watsonx."model-name".chat-model.max-tokens`]## [.description] -- -Timeout for watsonx.ai calls. +The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__TIMEOUT+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` 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]] -|`10s` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version[quarkus.langchain4j.watsonx."model-name".version]` +-- +|int +|`1024` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-n]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-n[`quarkus.langchain4j.watsonx."model-name".chat-model.n`]## [.description] -- -The version date for the API of the form YYYY-MM-DD. +How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_N+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_N+++` endif::add-copy-button-to-env-var[] ---|string -|`2024-03-14` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id[quarkus.langchain4j.watsonx."model-name".project-id]` +-- +|int +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-presence-penalty[`quarkus.langchain4j.watsonx."model-name".chat-model.presence-penalty`]## [.description] -- -The project that contains the watsonx.ai resource. +Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + +*Possible values:* `-2 < value < 2` -To look up your project id, link:https://dataplatform.cloud.ibm.com/projects/?context=wx[click here]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` endif::add-copy-button-to-env-var[] ---|string -|`dummy` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests[quarkus.langchain4j.watsonx."model-name".log-requests]` +-- +|double +|`0` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature[`quarkus.langchain4j.watsonx."model-name".chat-model.temperature`]## [.description] -- -Whether the watsonx.ai client should log requests. +What sampling temperature to use,. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic. + +We generally recommend altering this or `top_p` but not both. + +*Possible values:* `0 < value < 2` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses[quarkus.langchain4j.watsonx."model-name".log-responses]` +-- +|double +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p[`quarkus.langchain4j.watsonx."model-name".chat-model.top-p`]## [.description] -- -Whether the watsonx.ai client should log responses. +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So `0.1` means only the tokens comprising the top 10% probability mass are considered. + +We generally recommend altering this or `temperature` but not both. + +*Possible values:* `0 < value < 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration[quarkus.langchain4j.watsonx."model-name".enable-integration]` +-- +|double +|`1` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-response-format[`quarkus.langchain4j.watsonx."model-name".chat-model.response-format`]## [.description] -- -Whether to enable the integration. Defaults to `true`, which means requests are made to the watsonx.ai provider. Set to `false` to disable all requests. +Specifies the desired format for the model's output. + +*Allowable values:* `++[++json_object++]++` ++*++ + +*Applicable in modes:* `++[++chat++]++` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url[quarkus.langchain4j.watsonx."model-name".iam.base-url]` +-- +|string +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests[`quarkus.langchain4j.watsonx."model-name".chat-model.log-requests`]## [.description] -- -Base URL of the IAM Authentication API. +Whether chat model requests should be logged. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URL.html[URL] - -|`https://iam.cloud.ibm.com` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout[quarkus.langchain4j.watsonx."model-name".iam.timeout]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses[`quarkus.langchain4j.watsonx."model-name".chat-model.log-responses`]## [.description] -- -Timeout for IAM authentication calls. +Whether chat model responses should be logged. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_TIMEOUT+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` 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]] -|`10s` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type[quarkus.langchain4j.watsonx."model-name".iam.grant-type]` +-- +|boolean +|`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-model-id[`quarkus.langchain4j.watsonx."model-name".generation-model.model-id`]## [.description] -- -Grant type for the IAM Authentication API. +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string -|`urn:ibm:params:oauth:grant-type:apikey` - - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-decoding-method]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-decoding-method[quarkus.langchain4j.watsonx."model-name".chat-model.decoding-method]` +-- +|string +|`mistralai/mistral-large` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-decoding-method[`quarkus.langchain4j.watsonx."model-name".generation-model.decoding-method`]## [.description] -- @@ -872,18 +1452,18 @@ Represents the strategy used for picking the tokens during generation of the out *Allowable values:* `++[++sample,greedy++]++` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_DECODING_METHOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_DECODING_METHOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_DECODING_METHOD+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_DECODING_METHOD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`greedy` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-length-penalty-decay-factor]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-length-penalty-decay-factor[quarkus.langchain4j.watsonx."model-name".chat-model.length-penalty.decay-factor]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-decay-factor]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-decay-factor[`quarkus.langchain4j.watsonx."model-name".generation-model.length-penalty.decay-factor`]## [.description] -- @@ -891,18 +1471,18 @@ Represents the factor of exponential decay. Larger values correspond to more agg *Possible values:* `> 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-length-penalty-start-index]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-length-penalty-start-index[quarkus.langchain4j.watsonx."model-name".chat-model.length-penalty.start-index]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-start-index]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-start-index[`quarkus.langchain4j.watsonx."model-name".generation-model.length-penalty.start-index`]## [.description] -- @@ -910,18 +1490,18 @@ A number of generated tokens after which this should take effect. *Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LENGTH_PENALTY_START_INDEX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LENGTH_PENALTY_START_INDEX+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-new-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-new-tokens[quarkus.langchain4j.watsonx."model-name".chat-model.max-new-tokens]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-max-new-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.max-new-tokens`]## [.description] -- @@ -929,18 +1509,18 @@ The maximum number of new tokens to be generated. The maximum supported value fo *Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MAX_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_NEW_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MAX_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`200` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-min-new-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-min-new-tokens[quarkus.langchain4j.watsonx."model-name".chat-model.min-new-tokens]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-min-new-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.min-new-tokens`]## [.description] -- @@ -948,18 +1528,18 @@ If stop sequences are given, they are ignored until minimum tokens are generated *Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MIN_NEW_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MIN_NEW_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MIN_NEW_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MIN_NEW_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`0` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-random-seed]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-random-seed[quarkus.langchain4j.watsonx."model-name".chat-model.random-seed]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-random-seed[`quarkus.langchain4j.watsonx."model-name".generation-model.random-seed`]## [.description] -- @@ -967,18 +1547,18 @@ Random number generator seed to use in sampling mode for experimental repeatabil *Possible values:* `≥ 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_RANDOM_SEED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RANDOM_SEED+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_RANDOM_SEED+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-stop-sequences]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-stop-sequences[quarkus.langchain4j.watsonx."model-name".chat-model.stop-sequences]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-stop-sequences[`quarkus.langchain4j.watsonx."model-name".generation-model.stop-sequences`]## [.description] -- @@ -986,18 +1566,18 @@ Stop sequences are one or more strings which will cause the text generation to s *Possible values:* `0 ≤ number of items ≤ 6, contains only unique items` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_STOP_SEQUENCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_STOP_SEQUENCES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_STOP_SEQUENCES+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature[quarkus.langchain4j.watsonx."model-name".chat-model.temperature]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-temperature[`quarkus.langchain4j.watsonx."model-name".generation-model.temperature`]## [.description] -- @@ -1005,18 +1585,18 @@ A value used to modify the next-token probabilities in `sampling` mode. Values l *Possible values:* `0 ≤ value ≤ 2` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TEMPERATURE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TEMPERATURE+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`1.0` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-k]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-k[quarkus.langchain4j.watsonx."model-name".chat-model.top-k]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-k]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-k[`quarkus.langchain4j.watsonx."model-name".generation-model.top-k`]## [.description] -- @@ -1024,18 +1604,18 @@ The number of highest probability vocabulary tokens to keep for top-k-filtering. *Possible values:* `1 ≤ value ≤ 100` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_K+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_K+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_K+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_K+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p[quarkus.langchain4j.watsonx."model-name".chat-model.top-p]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-p[`quarkus.langchain4j.watsonx."model-name".generation-model.top-p`]## [.description] -- @@ -1043,18 +1623,18 @@ Similar to `top_k` except the candidates to generate the next token are the most *Possible values:* `0 < value ≤ 1` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_P+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_P+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-repetition-penalty]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-repetition-penalty[quarkus.langchain4j.watsonx."model-name".chat-model.repetition-penalty]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-repetition-penalty[`quarkus.langchain4j.watsonx."model-name".generation-model.repetition-penalty`]## [.description] -- @@ -1062,18 +1642,18 @@ Represents the penalty for penalizing tokens that have already been generated or *Possible values:* `1 ≤ value ≤ 2` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_REPETITION_PENALTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_REPETITION_PENALTY+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_REPETITION_PENALTY+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-truncate-input-tokens]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-truncate-input-tokens[quarkus.langchain4j.watsonx."model-name".chat-model.truncate-input-tokens]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.truncate-input-tokens`]## [.description] -- @@ -1081,139 +1661,230 @@ Represents the maximum number of input tokens accepted. This can be used to avoi *Possible values:* `≥ 0` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TRUNCATE_INPUT_TOKENS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-include-stop-sequence]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-include-stop-sequence[quarkus.langchain4j.watsonx."model-name".chat-model.include-stop-sequence]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-include-stop-sequence[`quarkus.langchain4j.watsonx."model-name".generation-model.include-stop-sequence`]## [.description] -- Pass `false` to omit matched stop sequences from the end of the output text. The default is `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_WATSONX__MODEL_NAME__CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_INCLUDE_STOP_SEQUENCE+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests[quarkus.langchain4j.watsonx."model-name".chat-model.log-requests]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-requests[`quarkus.langchain4j.watsonx."model-name".generation-model.log-requests`]## [.description] -- Whether chat model requests should be logged. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses[quarkus.langchain4j.watsonx."model-name".chat-model.log-responses]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-responses[`quarkus.langchain4j.watsonx."model-name".generation-model.log-responses`]## [.description] -- Whether chat model responses should be logged. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-prompt-joiner]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-prompt-joiner[quarkus.langchain4j.watsonx."model-name".chat-model.prompt-joiner]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-prompt-joiner]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-prompt-joiner[`quarkus.langchain4j.watsonx."model-name".generation-model.prompt-joiner`]## [.description] -- Delimiter used to concatenate the ChatMessage elements into a single string. By setting this property, you can define your preferred way of concatenating messages to ensure that the prompt is structured in the correct way. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PROMPT_JOINER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_PROMPT_JOINER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PROMPT_JOINER+++` +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_PROMPT_JOINER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |` ` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id[quarkus.langchain4j.watsonx."model-name".embedding-model.model-id]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id[`quarkus.langchain4j.watsonx."model-name".embedding-model.model-id`]## [.description] -- Model id to use. To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`ibm/slate-125m-english-rtrvr` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".embedding-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests[quarkus.langchain4j.watsonx."model-name".embedding-model.log-requests]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests[`quarkus.langchain4j.watsonx."model-name".embedding-model.log-requests`]## [.description] -- Whether embedding model requests should be logged. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses]]`link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses[quarkus.langchain4j.watsonx."model-name".embedding-model.log-responses]` - +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses[`quarkus.langchain4j.watsonx."model-name".embedding-model.log-responses`]## [.description] -- Whether embedding model responses should be logged. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-model-id[`quarkus.langchain4j.watsonx."model-name".scoring-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`cross-encoder/ms-marco-minilm-l-12-v2` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".scoring-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-requests[`quarkus.langchain4j.watsonx."model-name".scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean |`false` +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-responses[`quarkus.langchain4j.watsonx."model-name".scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-langchain4j-watsonx_quarkus-langchain4j] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1230,3 +1901,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-watsonx_quarkus.langchain4j.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc new file mode 100644 index 000000000..23b44ed27 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx_quarkus.langchain4j.adoc @@ -0,0 +1,1905 @@ +:summaryTableId: quarkus-langchain4j-watsonx_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|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-enabled[`quarkus.langchain4j.watsonx.chat-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_WATSONX_CHAT_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-enabled[`quarkus.langchain4j.watsonx.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_WATSONX_EMBEDDING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-enabled]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-enabled[`quarkus.langchain4j.watsonx.scoring-model.enabled`]## + +[.description] +-- +Whether the scoring model should be enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-mode]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-mode[`quarkus.langchain4j.watsonx.mode`]## + +[.description] +-- +Specifies the mode of interaction with the LLM model. + +This property allows you to choose between two modes of operation: + + - *chat*: prompts are automatically enriched with the specific tags defined by the model + - *generation*: prompts require manual specification of tags *Allowable values:* `++[++chat, generation++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_MODE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-base-url[`quarkus.langchain4j.watsonx.base-url`]## + +[.description] +-- +Base URL of the watsonx.ai API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +IBM Cloud API key. + +To create a new API key, follow this link:https://cloud.ibm.com/iam/apikeys[link]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +Timeout for watsonx.ai calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-version]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-version[`quarkus.langchain4j.watsonx.version`]## + +[.description] +-- +The version date for the API of the form YYYY-MM-DD. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2024-03-14` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-space-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-space-id[`quarkus.langchain4j.watsonx.space-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or `project_id` has to be given. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SPACE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SPACE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-project-id[`quarkus.langchain4j.watsonx.project-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or project_id has to be given. + +To look up your project id, link:https://dataplatform.cloud.ibm.com/projects/?context=wx[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-requests[`quarkus.langchain4j.watsonx.log-requests`]## + +[.description] +-- +Whether the watsonx.ai client should log requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-log-responses[`quarkus.langchain4j.watsonx.log-responses`]## + +[.description] +-- +Whether the watsonx.ai client should log responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-enable-integration[`quarkus.langchain4j.watsonx.enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the watsonx.ai provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-base-url[`quarkus.langchain4j.watsonx.iam.base-url`]## + +[.description] +-- +Base URL of the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://iam.cloud.ibm.com` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-timeout[`quarkus.langchain4j.watsonx.iam.timeout`]## + +[.description] +-- +Timeout for IAM authentication calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-grant-type]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-iam-grant-type[`quarkus.langchain4j.watsonx.iam.grant-type`]## + +[.description] +-- +Grant type for the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_GRANT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_IAM_GRANT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`urn:ibm:params:oauth:grant-type:apikey` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-model-id[`quarkus.langchain4j.watsonx.chat-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistralai/mistral-large` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-frequency-penalty[`quarkus.langchain4j.watsonx.chat-model.frequency-penalty`]## + +[.description] +-- +Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + +*Possible values:* `-2 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-logprobs[`quarkus.langchain4j.watsonx.chat-model.logprobs`]## + +[.description] +-- +Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOGPROBS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOGPROBS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-logprobs[`quarkus.langchain4j.watsonx.chat-model.top-logprobs`]## + +[.description] +-- +An integer specifying the number of most likely tokens to return at each token position, each with an associated log probability. The option `logprobs` must be set to `true` if this parameter is used. + +*Possible values:* `0 ≤ value ≤ 20` ++*++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_LOGPROBS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_LOGPROBS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-max-tokens[`quarkus.langchain4j.watsonx.chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-n]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-n[`quarkus.langchain4j.watsonx.chat-model.n`]## + +[.description] +-- +How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_N+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_N+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-presence-penalty[`quarkus.langchain4j.watsonx.chat-model.presence-penalty`]## + +[.description] +-- +Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + +*Possible values:* `-2 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperature[`quarkus.langchain4j.watsonx.chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use,. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic. + +We generally recommend altering this or `top_p` but not both. + +*Possible values:* `0 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-top-p[`quarkus.langchain4j.watsonx.chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So `0.1` means only the tokens comprising the top 10% probability mass are considered. + +We generally recommend altering this or `temperature` but not both. + +*Possible values:* `0 < value < 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-response-format[`quarkus.langchain4j.watsonx.chat-model.response-format`]## + +[.description] +-- +Specifies the desired format for the model's output. + +*Allowable values:* `++[++json_object++]++` ++*++ + +*Applicable in modes:* `++[++chat++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-requests[`quarkus.langchain4j.watsonx.chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-log-responses[`quarkus.langchain4j.watsonx.chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-model-id[`quarkus.langchain4j.watsonx.generation-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistralai/mistral-large` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-decoding-method[`quarkus.langchain4j.watsonx.generation-model.decoding-method`]## + +[.description] +-- +Represents the strategy used for picking the tokens during generation of the output text. 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. + +*Allowable values:* `++[++sample,greedy++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_DECODING_METHOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_DECODING_METHOD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`greedy` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-decay-factor]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-decay-factor[`quarkus.langchain4j.watsonx.generation-model.length-penalty.decay-factor`]## + +[.description] +-- +Represents the factor of exponential decay. Larger values correspond to more aggressive decay. + +*Possible values:* `> 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-start-index]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-length-penalty-start-index[`quarkus.langchain4j.watsonx.generation-model.length-penalty.start-index`]## + +[.description] +-- +A number of generated tokens after which this should take effect. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-max-new-tokens[`quarkus.langchain4j.watsonx.generation-model.max-new-tokens`]## + +[.description] +-- +The maximum number of new tokens to be generated. The maximum supported value for this field depends on the model being used. How the "token" is defined depends on the tokenizer and vocabulary size, which in turn depends on the model. Often the tokens are a mix of full words and sub-words. Depending on the users plan, and on the model being used, there may be an enforced maximum number of new tokens. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MAX_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`200` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-min-new-tokens[`quarkus.langchain4j.watsonx.generation-model.min-new-tokens`]## + +[.description] +-- +If stop sequences are given, they are ignored until minimum tokens are generated. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MIN_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_MIN_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-random-seed[`quarkus.langchain4j.watsonx.generation-model.random-seed`]## + +[.description] +-- +Random number generator seed to use in sampling mode for experimental repeatability. + +*Possible values:* `≥ 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-stop-sequences[`quarkus.langchain4j.watsonx.generation-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. + +*Possible values:* `0 ≤ number of items ≤ 6, contains only unique items` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_STOP_SEQUENCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_STOP_SEQUENCES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-temperature[`quarkus.langchain4j.watsonx.generation-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. + +*Possible values:* `0 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-k]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-k[`quarkus.langchain4j.watsonx.generation-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for `sampling` mode. When decoding_strategy is set to `sample`, only the `top_k` most likely tokens are considered as candidates for the next generated token. + +*Possible values:* `1 ≤ value ≤ 100` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-top-p[`quarkus.langchain4j.watsonx.generation-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`. Also known as nucleus sampling. A value of `1.0` is equivalent to disabled. + +*Possible values:* `0 < value ≤ 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-repetition-penalty[`quarkus.langchain4j.watsonx.generation-model.repetition-penalty`]## + +[.description] +-- +Represents the penalty for penalizing tokens that have already been generated or belong to the context. The value `1.0` means that there is no penalty. + +*Possible values:* `1 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.generation-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the start of the input (on the left), so the end of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. Zero means don't truncate. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-include-stop-sequence[`quarkus.langchain4j.watsonx.generation-model.include-stop-sequence`]## + +[.description] +-- +Pass `false` to omit matched stop sequences from the end of the output text. The default is `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_WATSONX_GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-requests[`quarkus.langchain4j.watsonx.generation-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-log-responses[`quarkus.langchain4j.watsonx.generation-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-prompt-joiner]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-generation-model-prompt-joiner[`quarkus.langchain4j.watsonx.generation-model.prompt-joiner`]## + +[.description] +-- +Delimiter used to concatenate the ChatMessage elements into a single string. By setting this property, you can define your preferred way of concatenating messages to ensure that the prompt is structured in the correct way. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_PROMPT_JOINER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_GENERATION_MODEL_PROMPT_JOINER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|` +` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-model-id[`quarkus.langchain4j.watsonx.embedding-model.model-id`]## + +[.description] +-- +Model id to use. To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ibm/slate-125m-english-rtrvr` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.embedding-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-requests[`quarkus.langchain4j.watsonx.embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-embedding-model-log-responses[`quarkus.langchain4j.watsonx.embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-model-id[`quarkus.langchain4j.watsonx.scoring-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`cross-encoder/ms-marco-minilm-l-12-v2` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-truncate-input-tokens[`quarkus.langchain4j.watsonx.scoring-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-requests[`quarkus.langchain4j.watsonx.scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-scoring-model-log-responses[`quarkus.langchain4j.watsonx.scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX_SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-langchain4j-watsonx_section_quarkus-langchain4j-watsonx]] [.section-name.section-level0]##link:#quarkus-langchain4j-watsonx_section_quarkus-langchain4j-watsonx[Named model config]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-mode]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-mode[`quarkus.langchain4j.watsonx."model-name".mode`]## + +[.description] +-- +Specifies the mode of interaction with the LLM model. + +This property allows you to choose between two modes of operation: + + - *chat*: prompts are automatically enriched with the specific tags defined by the model + - *generation*: prompts require manual specification of tags *Allowable values:* `++[++chat, generation++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__MODE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`chat` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-base-url[`quarkus.langchain4j.watsonx."model-name".base-url`]## + +[.description] +-- +Base URL of the watsonx.ai API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +IBM Cloud API key. + +To create a new API key, follow this link:https://cloud.ibm.com/iam/apikeys[link]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__API_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +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`]## + +[.description] +-- +Timeout for watsonx.ai calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-version[`quarkus.langchain4j.watsonx."model-name".version`]## + +[.description] +-- +The version date for the API of the form YYYY-MM-DD. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`2024-03-14` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-space-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-space-id[`quarkus.langchain4j.watsonx."model-name".space-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or `project_id` has to be given. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SPACE_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SPACE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-project-id[`quarkus.langchain4j.watsonx."model-name".project-id`]## + +[.description] +-- +The space that contains the resource. Either `space_id` or project_id has to be given. + +To look up your project id, link:https://dataplatform.cloud.ibm.com/projects/?context=wx[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__PROJECT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-requests[`quarkus.langchain4j.watsonx."model-name".log-requests`]## + +[.description] +-- +Whether the watsonx.ai client should log requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-log-responses[`quarkus.langchain4j.watsonx."model-name".log-responses`]## + +[.description] +-- +Whether the watsonx.ai client should log responses. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-enable-integration[`quarkus.langchain4j.watsonx."model-name".enable-integration`]## + +[.description] +-- +Whether to enable the integration. Defaults to `true`, which means requests are made to the watsonx.ai provider. Set to `false` to disable all requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__ENABLE_INTEGRATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-base-url[`quarkus.langchain4j.watsonx."model-name".iam.base-url`]## + +[.description] +-- +Base URL of the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_BASE_URL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URL.html[URL] +|`https://iam.cloud.ibm.com` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-timeout[`quarkus.langchain4j.watsonx."model-name".iam.timeout`]## + +[.description] +-- +Timeout for IAM authentication calls. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_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]] +|`10s` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-iam-grant-type[`quarkus.langchain4j.watsonx."model-name".iam.grant-type`]## + +[.description] +-- +Grant type for the IAM Authentication API. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__IAM_GRANT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`urn:ibm:params:oauth:grant-type:apikey` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-model-id[`quarkus.langchain4j.watsonx."model-name".chat-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistralai/mistral-large` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-frequency-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-frequency-penalty[`quarkus.langchain4j.watsonx."model-name".chat-model.frequency-penalty`]## + +[.description] +-- +Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + +*Possible values:* `-2 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_FREQUENCY_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-logprobs[`quarkus.langchain4j.watsonx."model-name".chat-model.logprobs`]## + +[.description] +-- +Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOGPROBS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOGPROBS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-logprobs]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-logprobs[`quarkus.langchain4j.watsonx."model-name".chat-model.top-logprobs`]## + +[.description] +-- +An integer specifying the number of most likely tokens to return at each token position, each with an associated log probability. The option `logprobs` must be set to `true` if this parameter is used. + +*Possible values:* `0 ≤ value ≤ 20` ++*++ + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_LOGPROBS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_LOGPROBS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-max-tokens[`quarkus.langchain4j.watsonx."model-name".chat-model.max-tokens`]## + +[.description] +-- +The maximum number of tokens that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_MAX_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1024` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-n]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-n[`quarkus.langchain4j.watsonx."model-name".chat-model.n`]## + +[.description] +-- +How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_N+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_N+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-presence-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-presence-penalty[`quarkus.langchain4j.watsonx."model-name".chat-model.presence-penalty`]## + +[.description] +-- +Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + +*Possible values:* `-2 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_PRESENCE_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-temperature[`quarkus.langchain4j.watsonx."model-name".chat-model.temperature`]## + +[.description] +-- +What sampling temperature to use,. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic. + +We generally recommend altering this or `top_p` but not both. + +*Possible values:* `0 < value < 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-top-p[`quarkus.langchain4j.watsonx."model-name".chat-model.top-p`]## + +[.description] +-- +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So `0.1` means only the tokens comprising the top 10% probability mass are considered. + +We generally recommend altering this or `temperature` but not both. + +*Possible values:* `0 < value < 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-response-format]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-response-format[`quarkus.langchain4j.watsonx."model-name".chat-model.response-format`]## + +[.description] +-- +Specifies the desired format for the model's output. + +*Allowable values:* `++[++json_object++]++` ++*++ + +*Applicable in modes:* `++[++chat++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_RESPONSE_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-requests[`quarkus.langchain4j.watsonx."model-name".chat-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-model-log-responses[`quarkus.langchain4j.watsonx."model-name".chat-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__CHAT_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-model-id[`quarkus.langchain4j.watsonx."model-name".generation-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp#model-ids[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`mistralai/mistral-large` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-decoding-method]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-decoding-method[`quarkus.langchain4j.watsonx."model-name".generation-model.decoding-method`]## + +[.description] +-- +Represents the strategy used for picking the tokens during generation of the output text. 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. + +*Allowable values:* `++[++sample,greedy++]++` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_DECODING_METHOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_DECODING_METHOD+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`greedy` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-decay-factor]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-decay-factor[`quarkus.langchain4j.watsonx."model-name".generation-model.length-penalty.decay-factor`]## + +[.description] +-- +Represents the factor of exponential decay. Larger values correspond to more aggressive decay. + +*Possible values:* `> 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_DECAY_FACTOR+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-start-index]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-length-penalty-start-index[`quarkus.langchain4j.watsonx."model-name".generation-model.length-penalty.start-index`]## + +[.description] +-- +A number of generated tokens after which this should take effect. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LENGTH_PENALTY_START_INDEX+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-max-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-max-new-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.max-new-tokens`]## + +[.description] +-- +The maximum number of new tokens to be generated. The maximum supported value for this field depends on the model being used. How the "token" is defined depends on the tokenizer and vocabulary size, which in turn depends on the model. Often the tokens are a mix of full words and sub-words. Depending on the users plan, and on the model being used, there may be an enforced maximum number of new tokens. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MAX_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MAX_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`200` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-min-new-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-min-new-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.min-new-tokens`]## + +[.description] +-- +If stop sequences are given, they are ignored until minimum tokens are generated. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MIN_NEW_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_MIN_NEW_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-random-seed]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-random-seed[`quarkus.langchain4j.watsonx."model-name".generation-model.random-seed`]## + +[.description] +-- +Random number generator seed to use in sampling mode for experimental repeatability. + +*Possible values:* `≥ 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_RANDOM_SEED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_RANDOM_SEED+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-stop-sequences]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-stop-sequences[`quarkus.langchain4j.watsonx."model-name".generation-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. + +*Possible values:* `0 ≤ number of items ≤ 6, contains only unique items` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_STOP_SEQUENCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_STOP_SEQUENCES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-temperature]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-temperature[`quarkus.langchain4j.watsonx."model-name".generation-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. + +*Possible values:* `0 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TEMPERATURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TEMPERATURE+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`1.0` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-k]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-k[`quarkus.langchain4j.watsonx."model-name".generation-model.top-k`]## + +[.description] +-- +The number of highest probability vocabulary tokens to keep for top-k-filtering. Only applies for `sampling` mode. When decoding_strategy is set to `sample`, only the `top_k` most likely tokens are considered as candidates for the next generated token. + +*Possible values:* `1 ≤ value ≤ 100` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_K+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_K+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-p]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-top-p[`quarkus.langchain4j.watsonx."model-name".generation-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`. Also known as nucleus sampling. A value of `1.0` is equivalent to disabled. + +*Possible values:* `0 < value ≤ 1` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_P+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TOP_P+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-repetition-penalty]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-repetition-penalty[`quarkus.langchain4j.watsonx."model-name".generation-model.repetition-penalty`]## + +[.description] +-- +Represents the penalty for penalizing tokens that have already been generated or belong to the context. The value `1.0` means that there is no penalty. + +*Possible values:* `1 ≤ value ≤ 2` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_REPETITION_PENALTY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_REPETITION_PENALTY+++` +endif::add-copy-button-to-env-var[] +-- +|double +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".generation-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the start of the input (on the left), so the end of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. Zero means don't truncate. + +*Possible values:* `≥ 0` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-include-stop-sequence]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-include-stop-sequence[`quarkus.langchain4j.watsonx."model-name".generation-model.include-stop-sequence`]## + +[.description] +-- +Pass `false` to omit matched stop sequences from the end of the output text. The default is `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_WATSONX__MODEL_NAME__GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_INCLUDE_STOP_SEQUENCE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-requests[`quarkus.langchain4j.watsonx."model-name".generation-model.log-requests`]## + +[.description] +-- +Whether chat model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-log-responses[`quarkus.langchain4j.watsonx."model-name".generation-model.log-responses`]## + +[.description] +-- +Whether chat model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-prompt-joiner]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-generation-model-prompt-joiner[`quarkus.langchain4j.watsonx."model-name".generation-model.prompt-joiner`]## + +[.description] +-- +Delimiter used to concatenate the ChatMessage elements into a single string. By setting this property, you can define your preferred way of concatenating messages to ensure that the prompt is structured in the correct way. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_PROMPT_JOINER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__GENERATION_MODEL_PROMPT_JOINER+++` +endif::add-copy-button-to-env-var[] +-- +|string +|` +` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-model-id[`quarkus.langchain4j.watsonx."model-name".embedding-model.model-id`]## + +[.description] +-- +Model id to use. To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`ibm/slate-125m-english-rtrvr` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".embedding-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-requests[`quarkus.langchain4j.watsonx."model-name".embedding-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-embedding-model-log-responses[`quarkus.langchain4j.watsonx."model-name".embedding-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__EMBEDDING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-model-id]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-model-id[`quarkus.langchain4j.watsonx."model-name".scoring-model.model-id`]## + +[.description] +-- +Model id to use. + +To view the complete model list, link:https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp[click here]. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_MODEL_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_MODEL_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`cross-encoder/ms-marco-minilm-l-12-v2` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-truncate-input-tokens]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-truncate-input-tokens[`quarkus.langchain4j.watsonx."model-name".scoring-model.truncate-input-tokens`]## + +[.description] +-- +Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_TRUNCATE_INPUT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-requests]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-requests[`quarkus.langchain4j.watsonx."model-name".scoring-model.log-requests`]## + +[.description] +-- +Whether embedding model requests should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_REQUESTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-responses]] [.property-path]##link:#quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-scoring-model-log-responses[`quarkus.langchain4j.watsonx."model-name".scoring-model.log-responses`]## + +[.description] +-- +Whether embedding model responses should be logged. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_WATSONX__MODEL_NAME__SCORING_MODEL_LOG_RESPONSES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-langchain4j-watsonx_quarkus-langchain4j] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* 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/pom.xml b/docs/pom.xml index 080ac0228..085f4610d 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -328,6 +328,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/ROOT/pages/includes/ + + maven-resources-plugin @@ -340,27 +348,6 @@ ${project.basedir}/modules/ROOT/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - quarkus-langchain4j.adoc - quarkus-langchain4j-anthropic.adoc - quarkus-langchain4j-easy-rag.adoc - quarkus-langchain4j-openai.adoc - quarkus-langchain4j-huggingface.adoc - quarkus-langchain4j-ollama.adoc - quarkus-langchain4j-mistralai.adoc - quarkus-langchain4j-redis.adoc - quarkus-langchain4j-chroma.adoc - quarkus-langchain4j-pinecone.adoc - quarkus-langchain4j-pgvector.adoc - quarkus-langchain4j-infinispan.adoc - quarkus-langchain4j-cohere.adoc - quarkus-langchain4j-watsonx.adoc - quarkus-langchain4j-mistralai.adoc - quarkus-langchain4j-neo4j.adoc - quarkus-langchain4j-tavily.adoc - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/pom.xml b/pom.xml index d25acfeec..74dd9b33c 100644 --- a/pom.xml +++ b/pom.xml @@ -67,6 +67,11 @@ quarkus-maven-plugin ${quarkus.version} + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + net.revelc.code impsort-maven-plugin