From 924f5c79953a168750c1f791c537853f402b3332 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=CE=A7=CE=B3=CF=86=CF=84=20Kompanion?=
 <chigammaphitau@chelydra.at>
Date: Sun, 19 Oct 2025 08:34:04 +0200
Subject: [PATCH] ki: add inline API doc for KIEmbedOptions/KIEmbeddingResult
 to prefer middleware-sourced documentation

---
 src/KI/Embedding/KIEmbedding.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/KI/Embedding/KIEmbedding.h b/src/KI/Embedding/KIEmbedding.h
index 310599a..62d2fc8 100644
--- a/src/KI/Embedding/KIEmbedding.h
+++ b/src/KI/Embedding/KIEmbedding.h
@@ -8,6 +8,15 @@
 
 namespace KI {
 
+/**
+ * KIEmbedOptions and KIEmbeddingResult document the embedding API exposed by libKI providers.
+ *
+ * Semantics
+ * - Providers should accept one or many input texts and return one vector per input.
+ * - The `model` is a free-form identifier understood by the provider (e.g., "bge-m3:latest").
+ * - If `normalize` is set to "l2", providers may L2-normalize vectors client-side for cosine search.
+ */
+
 class KIEmbedOptions
 {
     Q_GADGET