Merge pull request #1141 from rsvoboda/type.fixes.2024-12-06

geoand · web-flow · commit d7027e5687e7 · 2024-12-06T14:34:47.000+02:00
Typo fixes
diff --git a/core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/AiServicesProcessor.java b/core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/AiServicesProcessor.java
@@ -477,7 +477,7 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,
             List<DeclarativeAiServiceBuildItem> declarativeAiServiceItems,
             List<SelectedChatModelProviderBuildItem> selectedChatModelProvider,
             BuildProducer<SyntheticBeanBuildItem> syntheticBeanProducer,
-            BuildProducer<UnremovableBeanBuildItem> unremoveableProducer) {
+            BuildProducer<UnremovableBeanBuildItem> unremovableProducer) {
 
         boolean needsChatModelBean = false;
         boolean needsStreamingChatModelBean = false;
@@ -668,7 +668,7 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,
                     // constructor to obtain an instance.
                     if (bi.isCustomRetrievalAugmentorSupplierClassIsABean()) {
                         configurator.addInjectionPoint(ClassType.create(retrievalAugmentorSupplierClassName));
-                        unremoveableProducer
+                        unremovableProducer
                                 .produce(UnremovableBeanBuildItem.beanClassNames(retrievalAugmentorSupplierClassName));
                     }
                 }
@@ -724,34 +724,34 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,
         }
 
         if (needsChatModelBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MODEL));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MODEL));
         }
         if (needsStreamingChatModelBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.STREAMING_CHAT_MODEL));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.STREAMING_CHAT_MODEL));
         }
         if (needsChatMemoryProviderBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MEMORY_PROVIDER));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MEMORY_PROVIDER));
         }
         if (needsRetrieverBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVER));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVER));
         }
         if (needsRetrievalAugmentorBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVAL_AUGMENTOR));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVAL_AUGMENTOR));
         }
         if (needsAuditServiceBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.AUDIT_SERVICE));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.AUDIT_SERVICE));
         }
         if (needsModerationModelBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.MODERATION_MODEL));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.MODERATION_MODEL));
         }
         if (needsImageModelBean) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.IMAGE_MODEL));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.IMAGE_MODEL));
         }
         if (!allToolProviders.isEmpty()) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolProviders));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolProviders));
         }
         if (!allToolNames.isEmpty()) {
-            unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolNames));
+            unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolNames));
         }
     }
 
diff --git a/core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/BeansProcessor.java b/core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/BeansProcessor.java
@@ -600,9 +600,9 @@ public void cleanUp(LangChain4jRecorder recorder, ShutdownContextBuildItem shutd
     }
 
     @BuildStep
-    public void unremoveableBeans(BuildProducer<UnremovableBeanBuildItem> unremoveableProducer) {
-        unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(ObjectMapper.class));
-        unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(ModelAuthProvider.class));
+    public void unremovableBeans(BuildProducer<UnremovableBeanBuildItem> unremovableProducer) {
+        unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(ObjectMapper.class));
+        unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(ModelAuthProvider.class));
     }
 
     @BuildStep
diff --git a/core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/GuardrailException.java b/core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/GuardrailException.java
@@ -1,7 +1,7 @@
 package io.quarkiverse.langchain4j.runtime.aiservice;
 
 /**
- * Exception thrown when a input or output guardrail validation fails.
+ * Exception thrown when an input or output guardrail validation fails.
  * <p>
  * This exception is not intended to be used in guardrail implementation.
  */
diff --git a/docs/modules/ROOT/pages/easy-rag.adoc b/docs/modules/ROOT/pages/easy-rag.adoc
@@ -14,7 +14,7 @@ ingest them into an in-memory embedding store.
 
 Apache Tika, a library for parsing various file formats, is used under the
 hood, so your documents can be in any of its supported formats (plain text,
-PDF, DOCX, HTML, etc), including images with text, which will be parsed
+PDF, DOCX, HTML, etc.), including images with text, which will be parsed
 using OCR (OCR requires to have the Tesseract library installed in your
 system - see https://cwiki.apache.org/confluence/display/TIKA/TikaOCR).
 
diff --git a/docs/modules/ROOT/pages/enable-disable-integrations.adoc b/docs/modules/ROOT/pages/enable-disable-integrations.adoc
@@ -2,9 +2,9 @@
 
 include::./includes/attributes.adoc[]
 
-By default, all integrations with AI providers (OpenAI, HuggingFace, Azure OpenAI, etc) are enabled. This means that live calls are made to the configured AI provider.
+By default, all integrations with AI providers (OpenAI, HuggingFace, Azure OpenAI, etc.) are enabled. This means that live calls are made to the configured AI provider.
 
-Each provider has an `enable-integration` property (i.e. `quarkus.langchain4j.openai.enable-integration`, `quarkus.langchain4j.huggingface.enable-integration`, etc) that can be set to `false` to disable the integration. This property is read at runtime.
+Each provider has an `enable-integration` property (i.e. `quarkus.langchain4j.openai.enable-integration`, `quarkus.langchain4j.huggingface.enable-integration`, etc.) that can be set to `false` to disable the integration. This property is read at runtime.
 
 When disabled, any call made to the AI provider will end up in an `dev.langchain4j.model.ModelDisabledException` runtime exception being thrown.
 
diff --git a/docs/modules/ROOT/pages/guardrails.adoc b/docs/modules/ROOT/pages/guardrails.adoc
@@ -163,7 +163,7 @@ public interface Simulator {
 In this example, the `VerifyHeroFormat` is executed first to check that the passed hero is valid.
 Then, the `VerifyVillainFormat` is executed to check that the villain is valid.
 
-If the `VerifyHeroFormat` fails, the `VerifyVillainFormat` may or may not be executed depending on whether the failure is fatal or not. For instance the `VerifyHeroFormat` could be implemented as it follows.
+If the `VerifyHeroFormat` fails, the `VerifyVillainFormat` may or may not be executed depending on whether the failure is fatal or not. For instance, the `VerifyHeroFormat` could be implemented as it follows.
 
 [source,java]
 ----
@@ -511,7 +511,7 @@ public class HallucinationGuard implements OutputGuardrail {
 ----
 
 === Rewriting the LLM output
-It may happen that the output generated by the LLM is not completely satisfying, but it can be programmatically adjusted instead of attempting a retry or a remprompt, both implying a costly, time consuming and less reliable new interaction with the LLM. For instance it is quite common that an LLM produces the json of the data object that it is required to extract from the user prompt, but appends to it some unwanted explanation of why it generated that result, making the json unparsable, something like
+It may happen that the output generated by the LLM is not completely satisfying, but it can be programmatically adjusted instead of attempting a retry or a reprompt, both implying a costly, time consuming and less reliable new interaction with the LLM. For instance, it is quite common that an LLM produces the json of the data object that it is required to extract from the user prompt, but appends to it some unwanted explanation of why it generated that result, making the json unparsable, something like
 
 [source]
 ----
diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-watsonx.adoc
@@ -420,7 +420,7 @@ a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperat
 
 [.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.
+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.
 
@@ -1332,7 +1332,7 @@ a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-mod
 
 [.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.
+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.
 
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
@@ -420,7 +420,7 @@ a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-chat-model-temperat
 
 [.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.
+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.
 
@@ -1332,7 +1332,7 @@ a| [[quarkus-langchain4j-watsonx_quarkus-langchain4j-watsonx-model-name-chat-mod
 
 [.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.
+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.
 
diff --git a/docs/modules/ROOT/pages/web-search.adoc b/docs/modules/ROOT/pages/web-search.adoc
@@ -13,7 +13,7 @@ WebSearchEngine engine;
 
 and then use it by calling its `search` method.
 
-If you want to let an chat model use web search by itself, there are
+If you want to let a chat model use web search by itself, there are
 generally two recommended ways to accomplish this: either by implementing a
 tool that uses it, or as a content retriever inside a RAG pipeline. The
 https://github.com/quarkiverse/quarkus-langchain4j/tree/main/samples/chatbot-web-search[chatbot-web-search]
diff --git a/model-providers/watsonx/runtime/src/main/java/io/quarkiverse/langchain4j/watsonx/runtime/config/ChatModelConfig.java b/model-providers/watsonx/runtime/src/main/java/io/quarkiverse/langchain4j/watsonx/runtime/config/ChatModelConfig.java
@@ -70,7 +70,7 @@ public interface ChatModelConfig {
     Double presencePenalty();
 
     /**
-     * What sampling temperature to use,. Higher values like <code>0.8</code> will make the output more random, while lower
+     * What sampling temperature to use. Higher values like <code>0.8</code> will make the output more random, while lower
      * values
      * like <code>0.2</code> will make it more focused and deterministic.
      * <p>

Original file line number	Diff line number	Diff line change
`@@ -477,7 +477,7 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,`
`477`	`477`	`List<DeclarativeAiServiceBuildItem> declarativeAiServiceItems,`
`478`	`478`	`List<SelectedChatModelProviderBuildItem> selectedChatModelProvider,`
`479`	`479`	`BuildProducer<SyntheticBeanBuildItem> syntheticBeanProducer,`
`480`		`- BuildProducer<UnremovableBeanBuildItem> unremoveableProducer) {`
	`480`	`+ BuildProducer<UnremovableBeanBuildItem> unremovableProducer) {`
`481`	`481`
`482`	`482`	`boolean needsChatModelBean = false;`
`483`	`483`	`boolean needsStreamingChatModelBean = false;`
`@@ -668,7 +668,7 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,`
`668`	`668`	`// constructor to obtain an instance.`
`669`	`669`	`if (bi.isCustomRetrievalAugmentorSupplierClassIsABean()) {`
`670`	`670`	`configurator.addInjectionPoint(ClassType.create(retrievalAugmentorSupplierClassName));`
`671`		`- unremoveableProducer`
	`671`	`+ unremovableProducer`
`672`	`672`	`.produce(UnremovableBeanBuildItem.beanClassNames(retrievalAugmentorSupplierClassName));`
`673`	`673`	`}`
`674`	`674`	`}`
`@@ -724,34 +724,34 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,`
`724`	`724`	`}`
`725`	`725`
`726`	`726`	`if (needsChatModelBean) {`
`727`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MODEL));`
	`727`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MODEL));`
`728`	`728`	`}`
`729`	`729`	`if (needsStreamingChatModelBean) {`
`730`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.STREAMING_CHAT_MODEL));`
	`730`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.STREAMING_CHAT_MODEL));`
`731`	`731`	`}`
`732`	`732`	`if (needsChatMemoryProviderBean) {`
`733`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MEMORY_PROVIDER));`
	`733`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.CHAT_MEMORY_PROVIDER));`
`734`	`734`	`}`
`735`	`735`	`if (needsRetrieverBean) {`
`736`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVER));`
	`736`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVER));`
`737`	`737`	`}`
`738`	`738`	`if (needsRetrievalAugmentorBean) {`
`739`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVAL_AUGMENTOR));`
	`739`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.RETRIEVAL_AUGMENTOR));`
`740`	`740`	`}`
`741`	`741`	`if (needsAuditServiceBean) {`
`742`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.AUDIT_SERVICE));`
	`742`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.AUDIT_SERVICE));`
`743`	`743`	`}`
`744`	`744`	`if (needsModerationModelBean) {`
`745`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.MODERATION_MODEL));`
	`745`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.MODERATION_MODEL));`
`746`	`746`	`}`
`747`	`747`	`if (needsImageModelBean) {`
`748`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.IMAGE_MODEL));`
	`748`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(LangChain4jDotNames.IMAGE_MODEL));`
`749`	`749`	`}`
`750`	`750`	`if (!allToolProviders.isEmpty()) {`
`751`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolProviders));`
	`751`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolProviders));`
`752`	`752`	`}`
`753`	`753`	`if (!allToolNames.isEmpty()) {`
`754`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolNames));`
	`754`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(allToolNames));`
`755`	`755`	`}`
`756`	`756`	`}`
`757`	`757`
Original file line number	Diff line number	Diff line change
`@@ -600,9 +600,9 @@ public void cleanUp(LangChain4jRecorder recorder, ShutdownContextBuildItem shutd`
`600`	`600`	`}`
`601`	`601`
`602`	`602`	`@BuildStep`
`603`		`- public void unremoveableBeans(BuildProducer<UnremovableBeanBuildItem> unremoveableProducer) {`
`604`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(ObjectMapper.class));`
`605`		`- unremoveableProducer.produce(UnremovableBeanBuildItem.beanTypes(ModelAuthProvider.class));`
	`603`	`+ public void unremovableBeans(BuildProducer<UnremovableBeanBuildItem> unremovableProducer) {`
	`604`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(ObjectMapper.class));`
	`605`	`+ unremovableProducer.produce(UnremovableBeanBuildItem.beanTypes(ModelAuthProvider.class));`
`606`	`606`	`}`
`607`	`607`
`608`	`608`	`@BuildStep`