ki: add inline API doc for KIEmbedOptions/KIEmbeddingResult to prefer middleware-sourced documentation

This commit is contained in:
Χγφτ Kompanion 2025-10-19 08:34:04 +02:00
parent 1e15a96bbe
commit 924f5c7995
1 changed files with 9 additions and 0 deletions

View File

@ -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