From 148c22e9892ccf59b16021449666745753e12693 Mon Sep 17 00:00:00 2001 From: Eric Deandrea Date: Tue, 14 Jan 2025 08:32:24 -0500 Subject: [PATCH] Deprecate auditing stuff Fixes #1218 --- .../main/java/io/quarkiverse/langchain4j/audit/Audit.java | 7 +++++++ .../io/quarkiverse/langchain4j/audit/AuditService.java | 8 ++++++++ docs/modules/ROOT/pages/ai-services.adoc | 2 ++ 3 files changed, 17 insertions(+) diff --git a/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/Audit.java b/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/Audit.java index 3c96ce296..c81dc5482 100644 --- a/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/Audit.java +++ b/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/Audit.java @@ -12,7 +12,14 @@ /** * Abstract class to be implemented in order to keep track of whatever information is useful for the application auditing. + *

+ * + * @deprecated All the auditing stuff is going to be re-written, so don't use any of this stuff + * @see https://github.com/quarkiverse/quarkus-langchain4j/issues/1217 + *

*/ +@Deprecated(forRemoval = true) public abstract class Audit { /** diff --git a/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/AuditService.java b/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/AuditService.java index dacbc34f7..fe6cc057e 100644 --- a/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/AuditService.java +++ b/core/runtime/src/main/java/io/quarkiverse/langchain4j/audit/AuditService.java @@ -5,7 +5,15 @@ *

* When using {@link io.quarkiverse.langchain4j.RegisterAiService} if the application provides an implementation * of {@link AuditService} that is a CDI bean, it will be used by default. + *

+ *

+ * + * @deprecated All the auditing stuff is going to be re-written, so don't use any of this stuff + * @see https://github.com/quarkiverse/quarkus-langchain4j/issues/1217 + *

*/ +@Deprecated(forRemoval = true) public interface AuditService { /** diff --git a/docs/modules/ROOT/pages/ai-services.adoc b/docs/modules/ROOT/pages/ai-services.adoc index c579439c4..3994780c3 100644 --- a/docs/modules/ROOT/pages/ai-services.adoc +++ b/docs/modules/ROOT/pages/ai-services.adoc @@ -436,6 +436,8 @@ The extension allows users to audit the process of implementing an AiService by By default, if a bean of type `AuditService` is present in the application, it will be used in order to create an `Audit`, which received various callbacks pertaining to the implementation of the AiService method. More information can be found on the javadoc of these two classes. +CAUTION: The above-mentioned auditing capabilities are https://github.com/quarkiverse/quarkus-langchain4j/issues/1217[in process of being re-written]. Until that is complete it is advised to not use the auditing features. + === Working with images An _AI Service_ can also be used when working with images, both to describe an image and to generate one.