Deprecate auditing stuff

Fixes #1218
quarkiverse · Jan 14, 2025 · 148c22e · 148c22e
1 parent e0f1362
commit 148c22e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
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
@@ -12,7 +12,14 @@
 
 /**
  * Abstract class to be implemented in order to keep track of whatever information is useful for the application auditing.
+ * <p>
+ *
+ * @deprecated All the auditing stuff is going to be re-written, so don't use any of this stuff
+ * @see <a href=
+ *      "https://github.com/quarkiverse/quarkus-langchain4j/issues/1217">https://github.com/quarkiverse/quarkus-langchain4j/issues/1217</a>
+ *      </p>
  */
+@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
@@ -5,7 +5,15 @@
  * <p>
  * 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.
+ * </p>
+ * <p>
+ *
+ * @deprecated All the auditing stuff is going to be re-written, so don't use any of this stuff
+ * @see <a href=
+ *      "https://github.com/quarkiverse/quarkus-langchain4j/issues/1217">https://github.com/quarkiverse/quarkus-langchain4j/issues/1217</a>
+ *      </p>
  */
+@Deprecated(forRemoval = true)
 public interface AuditService {
 
     /**

diff --git 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.