ki: add inline API doc for KIEmbedOptions/KIEmbeddingResult to prefer middleware-sourced documentation
This commit is contained in:
parent
1e15a96bbe
commit
924f5c7995
|
|
@ -8,6 +8,15 @@
|
||||||
|
|
||||||
namespace KI {
|
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
|
class KIEmbedOptions
|
||||||
{
|
{
|
||||||
Q_GADGET
|
Q_GADGET
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue