`resources/data.ts`

Source : sdks/typescript/packages/sdk/src/resources/data.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe `PrivacyResource`

Vie privée et protection des données. Services de protection des données du tenant : classification, DLP (prévention des fuites de données), tokenisation et chiffrement par enveloppe.

Resource

`PrivacyResource.classify`

classify(body: { text?: string; media_id?: string } & Doc, opts?: CallOptions)

Classer un texte ou un média. Avec text, détecte les entités avec les règles du tenant et renvoie classification, findings et engine, sans modifier le texte. Avec media_id, renvoie la classification, les constats et le résultat DLP déjà calculés pour ce média (404 not_found pour un média inconnu). L'un des deux est obligatoire (400 invalid_request). Ouvert à tout membre du tenant.

Route : /v1/privacy/classify (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ text?: string; media_id?: string } & Doc`		oui	Texte ou média à classer, et langue.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PrivacyResource.detect`

detect(body: { text: string } & Doc, opts?: CallOptions)

Inspecter un texte à la recherche de données sensibles. Applique la DLP au texte avec les règles du tenant, en mode detect sauf si mode en décide autrement. La réponse donne text, findings (type, position, score, classification, court aperçu, action, règle), action (action la plus forte appliquée), classification, mode, engine (builtin ou presidio), blocked et count. Un mode inconnu répond 400. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.inspect (nombres et types uniquement).

Route : /v1/dlp/inspect (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ text: string } & Doc`		oui	Texte, mode et langue facultatifs.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PrivacyResource.detokenize`

detokenize(body: { tokens: string[]; purpose: string } & Doc, opts?: CallOptions)

Détokeniser des valeurs. Renvoie les valeurs d'origine des jetons donnés dans tokens ou trouvés dans text.

Route : /v1/tokenization/detokenize (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ tokens: string[]; purpose: string } & Doc`		oui	Jetons ou texte contenant des jetons, et finalité.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PrivacyResource.encrypt`

encrypt(body: { key: string; plaintext?: string; plaintext_base64?: string; aad?: string } & Doc, opts?: CallOptions)

Chiffrer des données avec une clé du tenant. Chiffre plaintext (texte UTF-8) ou plaintext_base64 (octets) avec la version courante de la clé, lié à aad. Renvoie ciphertext (eaienc1:...), key_id et key_version. L'une des deux entrées est obligatoire, et le base64 doit être valide (400 invalid_request) ; une clé inconnue répond 404 key_not_found. Ouvert à tout membre du tenant. Écrit l'événement d'audit encryption.encrypt (taille uniquement).

Route : /v1/encryption/encrypt (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ key: string; plaintext?: string; plaintext_base64?: string; aad?: string } & Doc`		oui	Clé, données à chiffrer et données associées.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PrivacyResource.mask`

mask(body: { text: string } & Doc, opts?: CallOptions)

Masquer les données sensibles d'un texte. Comme l'inspection, en mode mask par défaut : chaque constat est remplacé par [TYPE] (par exemple [EMAIL]), ou tokenisé ou bloqué quand une règle du tenant ou mode le demande ; un texte bloqué revient vide avec blocked: true. Ouvert à tout membre du tenant. Écrit l'événement d'audit dlp.redact.

Route : /v1/dlp/redact (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ text: string } & Doc`		oui	Texte, mode et langue facultatifs.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PrivacyResource.tokenize`

tokenize(body: Doc, opts?: CallOptions)

Tokeniser des valeurs. Remplace les valeurs sensibles par des jetons déterministes tok_<type>_<hex> du tenant (une même valeur donne toujours le même jeton), les valeurs étant conservées chiffrées dans le coffre. Avec values, renvoie tokens ; avec text, détecte les entités et renvoie le text tokenisé, findings et classification. L'un des deux est obligatoire (400 invalid_request). Ouvert à tout membre du tenant. Écrit l'événement d'audit tokenization.tokenize (nombre uniquement).

Route : /v1/tokenization/tokenize (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Valeurs ou texte à tokeniser.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Alias de type `DlpMode`

Mode DLP de DlpResource.redact : detect, mask, tokenize ou block.

Définition : "detect" \| "mask" \| "tokenize" \| "block".

Classe `DlpResource`

Vie privée et protection des données. Services de protection des données du tenant : classification, DLP (prévention des fuites de données), tokenisation et chiffrement par enveloppe.

Resource

`DlpResource.createRule`

createRule(body: Doc, opts?: CallOptions)

Créer ou modifier une règle DLP. Crée la règle, ou remplace la règle de même nom. Une règle exige un entity_type ou un pattern (expression régulière valide) ; les erreurs répondent 400 invalid_request (action inconnue, motif ou classification invalide). Exige tenant_admin ou security_officer. Écrit l'événement d'audit dlp.rule.upsert. Répond 201 avec la règle.

Route : /v1/dlp/rules (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Nom, type d'entité ou motif, action, classification et score de la règle.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`DlpResource.inspect`

inspect(body: { text: string } & Doc, opts?: CallOptions)

Route : /v1/dlp/inspect (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ text: string } & Doc`		oui	Texte, mode et langue facultatifs.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`DlpResource.listRules`

listRules(params?: ListParams, opts?: CallOptions)

Lister les règles DLP. Liste les règles DLP du tenant triées par nom. Ouvert à tout membre du tenant. next_cursor vaut toujours null.

Route : /v1/dlp/rules (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`DlpResource.redact`

redact(body: { text: string; mode?: DlpMode } & Doc, opts?: CallOptions)

Route : /v1/dlp/redact (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ text: string; mode?: DlpMode } & Doc`		oui	Texte, mode et langue facultatifs.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe `TokenizationResource`

Vie privée et protection des données. Services de protection des données du tenant : classification, DLP (prévention des fuites de données), tokenisation et chiffrement par enveloppe.

Resource

`TokenizationResource.detokenize`

detokenize(body: Doc, opts?: CallOptions)

Détokeniser des valeurs. Renvoie les valeurs d'origine des jetons donnés dans tokens ou trouvés dans text.

Route : /v1/tokenization/detokenize (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Jetons ou texte contenant des jetons, et finalité.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`TokenizationResource.tokenize`

tokenize(body: Doc, opts?: CallOptions)

Route : /v1/tokenization/tokenize (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Valeurs ou texte à tokeniser.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe `EncryptionResource`

Vie privée et protection des données. Services de protection des données du tenant : classification, DLP (prévention des fuites de données), tokenisation et chiffrement par enveloppe.

Resource

`EncryptionResource.createKey`

createKey(body: { name: string; purpose?: string } & Doc, opts?: CallOptions)

Créer une clé de chiffrement. Crée une clé nommée avec sa première version ; la clé de données est générée et enveloppée par OpenBao Transit s'il est configuré, localement sinon. Le nom doit être en minuscules, chiffres, ., _ ou -, 63 caractères au plus (400 invalid_request) ; un nom déjà utilisé répond 409 conflict. Exige tenant_admin ou security_officer. Écrit l'événement d'audit encryption.key.create.

Route : /v1/encryption/keys (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ name: string; purpose?: string } & Doc`		oui	Nom et usage de la clé.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`EncryptionResource.decrypt`

decrypt(body: { ciphertext: string; aad?: string; as_base64?: boolean } & Doc, opts?: CallOptions)

Déchiffrer un chiffré. Déchiffre un chiffré eaienc1 du tenant avec la version de clé qu'il désigne, en vérifiant la même aad qu'au chiffrement. Renvoie plaintext, ou plaintext_base64 avec as_base64 ou quand les données ne sont pas du texte UTF-8, et key_version. Les anciennes versions déchiffrent toujours après une rotation. Ouvert à tout membre du tenant. Écrit l'événement d'audit encryption.decrypt.

Route : /v1/encryption/decrypt (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ ciphertext: string; aad?: string; as_base64?: boolean } & Doc`		oui	Chiffré, données associées et format de sortie.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`EncryptionResource.encrypt`

encrypt(body: { key: string; plaintext?: string; plaintext_base64?: string; aad?: string } & Doc, opts?: CallOptions)

Route : /v1/encryption/encrypt (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ key: string; plaintext?: string; plaintext_base64?: string; aad?: string } & Doc`		oui	Clé, données à chiffrer et données associées.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`EncryptionResource.listKeys`

listKeys(params?: ListParams, opts?: CallOptions)

Lister les clés de chiffrement. Liste les clés de chiffrement du tenant triées par nom : identifiant, nom, moteur (openbao-transit ou local), usage, version courante et dates. Jamais le matériel de clé. Ouvert à tout membre du tenant.

Route : /v1/encryption/keys (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`EncryptionResource.rotateKey`

rotateKey(id: string, opts?: CallOptions)

Faire tourner une clé de chiffrement. Ajoute une nouvelle version à la clé : les nouveaux chiffrements l'utilisent, les chiffrés plus anciens se déchiffrent toujours avec leur propre version. Exige tenant_admin ou security_officer. Répond 404 key_not_found. Écrit l'événement d'audit encryption.key.rotate.

Route : /v1/encryption/keys/{key_id}/rotate (POST).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) ou nom de la clé.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe `KnowledgeBasesResource`

Bases de connaissances. Bases de connaissances pour la génération augmentée par récupération (RAG) : les documents sont analysés, extraits, contrôlés pour les données personnelles et l'empoisonnement, découpés, vectorisés via le Model Gateway et recherchés avec des filtres d'ACL et d'habilitation.

Resource

Attributs :

Nom	Type	Requis	Description
`body`	`{ content?: string; content_base64?: string; mime_type?: string; title?: string; uri?: string; metadata?: Doc; readers?: string[]; classification?: string } & Doc,`	oui	Document d'`addDocuments` : contenu ou contenu base64, type MIME, titre, URI, métadonnées, lecteurs et classification.
`id`	`string,`	oui	Identifiant de la base de connaissances qui reçoit le document dans `addDocuments`.
`opts`	`CallOptions) {`	non	Options par appel d'`addDocuments`.

`KnowledgeBasesResource.addDocuments`

addDocuments(id: string, body: { content?: string; content_base64?: string; mime_type?: string; title?: string; uri?: string; metadata?: Doc; readers?: string[]; classification?: string } & Doc, opts?: CallOptions)

Ajouter un document. Ingère un document (201). Demande la relation ReBAC editor et le droit d'écriture par l'ACL (403 not_permitted_acl). Étapes : 1. Le contenu (content ou content_base64, l'un est requis, sinon 400) est analysé par ClamAV et YARA-X (422 file_blocked, 503 file_scan_unavailable), puis le texte est extrait par Docling (422 unsupported_media). 2. La détection de données personnelles peut relever la classification ; un source_connector doit être actif. 3. Un document de même uri remplace la version précédente (version + 1). 4. Le texte est découpé, vectorisé et enregistré ; le contrôle d'empoisonnement peut mettre le document en quarantaine (status: quarantined). 409 knowledge_base_reindexing pendant une réindexation ; 409 embedding_dimension_mismatch ; 503 vector_store_unavailable. Audité sous knowledge.document.ingest.

Route : /v1/knowledge-bases/{kb_id}/documents (POST).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`{ content?: string; content_base64?: string; mime_type?: string; title?: string; uri?: string; metadata?: Doc; readers?: string[]; classification?: string } & Doc`	oui	Contenu, titre, URI, classification, lecteurs et métadonnées du document.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.chunks`

chunks(id: string, docId: string, params?: ListParams & { include_content?: boolean }, opts?: CallOptions)

Lister les fragments d'un document. Fragments de la version courante d'un document dans l'ordre de leur position, paginés avec cursor : chunk_id, ordinal, content (déchiffré pour les fragments scellés), classification, sealed, active, generation, fts_config (configuration de recherche plein texte) et metadata (source_page, section_title, element_type, language, char_start, char_end, bbox, document_version, content_hash, embedding_model, token_count, structure avec les marques de découpe des tableaux). Seuls les fragments dont l'appelant passe les lecteurs et la classification sont listés. Un document en quarantaine ou rejeté n'est montré qu'à tenant_admin, security_officer ou data_steward (403 forbidden). Demande la relation ReBAC viewer ; 404 not_found pour un document que l'appelant ne peut pas lire.

Route : /v1/knowledge-bases/{kb_id}/documents/{doc_id}/chunks (GET).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`docId`	`string`	oui	Identifiant (UUID) du document courant.
`params`	`ListParams & { include_content?: boolean }`	non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.cite`

async cite(id: string, body: { query: string; top_k?: number; min_score?: number } & Doc, opts?: CallOptions)

Exécute une requête et ne garde que les citations des sources autorisées et l'identifiant du run de lignage.

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant de la base de connaissances.
`body`	`{ query: string; top_k?: number; min_score?: number } & Doc`	oui	Corps de la requête, sérialisé en JSON.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

`KnowledgeBasesResource.create`

create(body: { name: string; description?: string; classification?: string; acl?: Doc; chunk_size?: number; chunk_overlap?: number; embedding_model?: string; dimensions?: number } & Doc, opts?: CallOptions)

Créer une base de connaissances. Crée une base avec son modèle d'embedding (par défaut : le modèle d'embedding RAG de la plateforme), qui doit être approuvé, avoir la capacité embeddings et accepter la classification. chunk_overlap doit être inférieur à chunk_size (400 invalid_request) ; une classification inconnue répond 400. Un nom déjà utilisé dans le tenant répond 409 conflict. Demande tenant_admin ou developer ; l'appelant devient propriétaire ReBAC. Audité sous knowledge_base.create.

Route : /v1/knowledge-bases (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ name: string; description?: string; classification?: string; acl?: Doc; chunk_size?: number; chunk_overlap?: number; embedding_model?: string; dimensions?: number } & Doc`		oui	Nom, découpage, classification, ACL et modèle d'embedding de la base.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.delete`

delete(id: string, opts?: CallOptions)

Supprimer une base de connaissances. Supprime la base, ses documents et leurs vecteurs dans le magasin vectoriel. Demande la relation ReBAC owner, et l'appelant doit être tenant_admin ou son créateur (403 forbidden). 404 not_found ; 503 vector_store_unavailable. Audité sous knowledge_base.delete.

Route : /v1/knowledge-bases/{kb_id} (DELETE).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de la base de connaissances.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.deleteDocument`

deleteDocument(id: string, docId: string, opts?: CallOptions)

Supprimer un document. Supprime le document et ses vecteurs. Demande la relation ReBAC editor et le droit d'écriture par l'ACL : tenant_admin, une identité listée dans writers, ou, si writers est vide, developer ou agent (sinon 403 not_permitted_acl). 404 not_found. Audité sous knowledge.document.delete.

Route : /v1/knowledge-bases/{kb_id}/documents/{doc_id} (DELETE).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`docId`	`string`	oui	Identifiant (UUID) du document.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.diagnostics`

diagnostics(id: string, query?: { diagnostics_id?: string; limit?: number }, opts?: CallOptions)

Lister les diagnostics des requêtes. Diagnostics enregistrés des requêtes sur la base, du plus récent au plus ancien, diagnostics_id d'une réponse pour en choisir un : mode, stratégie effective, stages (nom de l'étape, durée en millisecondes, candidats en entrée et en sortie), counts (documents filtrés, candidats denses et lexicaux, fusionnés, contrôlés, dédoublonnés, écartés par la revalidation, finaux, voisins de contexte, cache utilisé) et results (rang, fragment, document, scores nommés). Le texte de la requête n'est pas conservé, seulement son SHA-256. Un appelant voit ses propres requêtes ; tenant_admin, security_officer, data_steward et auditor voient toutes les requêtes. Demande la relation ReBAC viewer ; 404 not_found pour un appelant hors ACL ou un diagnostics_id qu'il ne peut pas voir.

Route : /v1/knowledge-bases/{kb_id}/query-diagnostics (GET).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`query`	`{ diagnostics_id?: string; limit?: number }`	non	Paramètres de la chaîne de requête de la route.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.documentStatus`

documentStatus(kbId: string, docId: string, opts?: CallOptions)

Lire l'état d'un document. État d'une version de document : document_id, document_key, version, version_state (current, superseded ou deleted), document_status (uploaded, active, quarantined, rejected, failed...), searchable (vrai seulement pour la version courante active), chunks, extractor, et ingestion, le dernier travail d'ingestion (job_id, state, attempts, last_error, updated_at) ou null pour une ingestion synchrone. Demande la relation ReBAC viewer ; 404 not_found pour un document que l'appelant ne peut pas lire.

Route : /v1/knowledge-bases/{kb_id}/documents/{doc_id}/status (GET).

Nom	Type	Requis	Description
`kbId`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`docId`	`string`	oui	Identifiant (UUID) de la version du document, le `document_id` de la réponse d'envoi.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.get`

get(id: string, opts?: CallOptions)

Lire une base de connaissances. Renvoie la base avec son nombre de documents, son pipeline d'ingestion et de recherche, le travail de réindexation (reindex) en cours le cas échéant et les datasets visibles par l'appelant. Demande la relation ReBAC viewer et le droit de lecture par l'ACL ; sinon 404 not_found.

Route : /v1/knowledge-bases/{kb_id} (GET).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de la base de connaissances.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.ingestionJob`

ingestionJob(kbId: string, jobId: string, opts?: CallOptions)

Lire un travail d'ingestion. Un travail d'ingestion asynchrone : job_id, kb_id, document_id, document_key, version, state (uploaded, quarantined, scanning, rejected, extracting, normalizing, chunking, embedding, indexing, enriching_memory, ready, partially_ready, failed, reindexing, deleting ou deleted), attempts, lease_owner, lease_expires_at, next_attempt_at, last_error, titre, nom de fichier, type de média, detected_format, size_bytes, sha256, scan_id, extractor (celui qui a tourné), storage (profil et emplacement quarantine ou permanent), création, mise à jour et fin, et history : chaque transition avec from_state, to_state, at et detail (verdict d'analyse, extracteur, nombre de fragments, nouvelle tentative et son délai, échec de l'OCR, mémoire skipped). Demande la relation ReBAC viewer ; 404 not_found pour un travail d'une autre base ou un document que l'appelant ne peut pas lire.

Route : /v1/knowledge-bases/{kb_id}/ingestion-jobs/{job_id} (GET).

Nom	Type	Requis	Description
`kbId`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`jobId`	`string`	oui	Identifiant (UUID) du travail d'ingestion, le `job_id` de la réponse d'envoi.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.list`

list(params?: ListParams, opts?: CallOptions)

Lister les bases de connaissances. Bases de connaissances du tenant que l'appelant peut lire selon leur ACL, dans l'ordre des noms, paginées avec cursor.

Route : /v1/knowledge-bases (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.listDocuments`

listDocuments(id: string, params?: ListParams, opts?: CallOptions)

Lister les documents d'une base. Documents lisibles par l'appelant (une de ses identités dans les readers du document, classification dans les limites de son habilitation), paginés avec cursor. Demande la relation ReBAC viewer et le droit de lecture sur la base.

Route : /v1/knowledge-bases/{kb_id}/documents (GET).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`params`	`ListParams`	non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.quarantine`

quarantine(id: string, opts?: CallOptions)

Lister les documents en quarantaine. Documents isolés par le contrôle d'empoisonnement (file de revue du data steward), du plus ancien au plus récent, 200 au plus, chacun avec les raisons du contrôle dans quarantine. Leurs fragments ne sont pas recherchables. Demande tenant_admin, security_officer ou data_steward et la relation ReBAC viewer.

Route : /v1/knowledge-bases/{kb_id}/quarantine (GET).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de la base de connaissances.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.query`

query(id: string, body: { query: string; top_k?: number; min_score?: number } & Doc, opts?: CallOptions)

Interroger une base de connaissances. Recherche dans la base et renvoie results (fragment, score, risque d'injection, classification, provenance), citations et un lineage_run_id. Demande la relation ReBAC can_invoke. Étapes : 1. La politique knowledge.query est évaluée et une réservation de quota est prise. 2. La requête est vectorisée avec le modèle de la base ; seuls les fragments dont les lecteurs correspondent aux identités de l'appelant et dont la classification respecte son habilitation sont recherchés. 3. Les fragments trouvés sont contrôlés contre l'injection de prompt (écartés en mode blocage) et vérifiés par rapport aux sources actives. 4. hybrid recalcule le score des candidats avec le recouvrement de mots-clés ; rerank les ordonne avec un modèle de reranking (un refus est signalé dans warnings, jamais caché). Un appelant hors ACL obtient un résultat vide, audité comme refus. Audité sous knowledge.query ; l'usage est mesuré.

Route : /v1/knowledge-bases/{kb_id}/query (POST).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`{ query: string; top_k?: number; min_score?: number } & Doc`	oui	Texte de la requête et options de recherche.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.reindex`

reindex(id: string, body: { embedding_model: string; dimensions?: number }, opts?: CallOptions)

Réindexer avec un autre modèle d'embedding. Met en file le passage de la base à un autre modèle d'embedding (travail embeddings_reindex) et répond 202 avec le travail. Le modèle doit être approuvé, avoir la capacité embeddings et accepter la classification la plus haute de la base et de ses documents (422 sinon). Les nouveaux vecteurs forment une nouvelle génération ; les deux espaces ne sont jamais mélangés. Demande tenant_admin ou developer, la relation ReBAC owner et le droit d'écriture. 409 knowledge_base_reindexing si un travail est déjà en cours. Audité sous knowledge_base.reindex.request.

Route : /v1/knowledge-bases/{kb_id}/reindex (POST).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`{ embedding_model: string; dimensions?: number }`	oui	Modèle d'embedding et dimension visés.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.reindexJobs`

reindexJobs(id: string, opts?: CallOptions)

Lister les travaux de réindexation. Travaux de réindexation de la base : statut, modèle, dimensions et génération source et cible, progression en documents et fragments, tentatives, erreur et dates. Demande la relation ReBAC viewer et le droit de lecture.

Route : /v1/knowledge-bases/{kb_id}/reindex-jobs (GET).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de la base de connaissances.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.retrieve`

async retrieve(id: string, body: { query: string; top_k?: number; min_score?: number } & Doc, opts?: CallOptions)

Exécute une requête et ne garde que les résultats filtrés par ACL.

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant de la base de connaissances.
`body`	`{ query: string; top_k?: number; min_score?: number } & Doc`	oui	Corps de la requête, sérialisé en JSON.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

`KnowledgeBasesResource.retryIngestion`

retryIngestion(kbId: string, jobId: string, body: { reason?: string } = {}, opts?: CallOptions)

Relancer un travail d'ingestion en échec. Remet en file un travail failed : en extracting quand son analyse a déjà libéré le fichier (jamais analysé deux fois), sinon en quarantined ; les tentatives repartent de zéro. Tout autre état est refusé en 409 ingestion_job_not_failed (un fichier rejected n'est jamais relancé). Répond le travail avec son historique. Audité knowledge.ingestion.retry. Demande la relation ReBAC editor.

Route : /v1/knowledge-bases/{kb_id}/ingestion-jobs/{job_id}/retry (POST).

Nom	Type	Défaut	Requis	Description
`kbId`	`string`		oui	Identifiant (UUID) de la base de connaissances.
`jobId`	`string`		oui	Identifiant (UUID) du travail d'ingestion en échec.
`body`	`{ reason?: string }`	`{}`	non	Raison facultative de la relance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.reviewDocument`

reviewDocument(id: string, docId: string, body: { decision: "release" | "reject"; reason?: string }, opts?: CallOptions)

Examiner un document en quarantaine. Libère (fragments de nouveau recherchables, status: active) ou rejette (status: rejected) un document en quarantaine. Demande tenant_admin, security_officer ou data_steward ; la politique knowledge.document.review est évaluée. 409 document_not_quarantined ; 404 not_found. La décision est enregistrée et auditée sous knowledge.document.release ou knowledge.document.reject.

Route : /v1/knowledge-bases/{kb_id}/documents/{doc_id}/review (POST).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`docId`	`string`	oui	Identifiant (UUID) du document.
`body`	`{ decision: "release" \| "reject"; reason?: string }`	oui	Décision et raison.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.search`

search(id: string, body: { query: string; top_k?: number; min_score?: number } & Doc, opts?: CallOptions)

Route : /v1/knowledge-bases/{kb_id}/query (POST).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`{ query: string; top_k?: number; min_score?: number } & Doc`	oui	Texte de la requête et options de recherche.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.setAcl`

setAcl(id: string, body: Doc, opts?: CallOptions)

Remplacer l'ACL d'une base. Remplace les lecteurs et rédacteurs de la base. Avec apply_to_documents, les documents qui héritent de l'ACL de la base (sans lecteurs propres) et leurs fragments reçoivent les nouveaux lecteurs ; documents_updated en donne le nombre. Demande la relation ReBAC owner, et l'appelant doit être tenant_admin, security_officer ou le créateur. Audité sous knowledge_base.acl.update ; le cache de recherche est invalidé.

Route : /v1/knowledge-bases/{kb_id}/acl (PUT).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`Doc`	oui	La nouvelle ACL.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.setRetrieval`

setRetrieval(id: string, body: RetrievalStrategy, opts?: CallOptions)

Définir la stratégie de recherche. Remplace la stratégie de recherche de la base : mode par défaut, fusion et son rrf_k, candidats par résultat, reranking et son modèle, déduplication, fenêtre de contexte et budget de jetons, signal de conflit. Un champ omis prend sa valeur par défaut ; les options d'une requête remplacent la stratégie pour cette requête. Demande la relation ReBAC owner et le droit d'écriture par l'ACL (403 not_permitted_acl) ; 404 not_found pour un appelant hors ACL. Audité sous knowledge_base.retrieval.update ; le cache de recherche est invalidé. Renvoie la base avec sa retrieval.

Route : /v1/knowledge-bases/{kb_id}/retrieval (PUT).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`RetrievalStrategy`	oui	La stratégie de recherche.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.uploadDocument`

uploadDocument(kbId: string, body: DocumentUpload, opts?: CallOptions)

Envoyer un document pour une ingestion asynchrone. Contrôle la taille (413 payload_too_large, limite EAI_RAG_UPLOAD_MAX_BYTES), le mime_type déclaré face à la signature réelle des octets (PDF, DOCX, XLSX et PPTX comme paquets ZIP aux bons types de contenu, PNG, JPEG, TIFF ; les formats texte doivent être de l'UTF-8 valide sans NUL) et l'extension de filename : 422 unsupported_format, format_mismatch, extension_mismatch ou archive_refused (bombe d'archive, archive imbriquée, trop volumineuse une fois décompressée). Les octets sont rangés sous le préfixe de quarantaine du profil de stockage des documents (409 ingestion_storage_required sans profil, 503 ingestion_storage_unavailable), la version du document est enregistrée avec document_status uploaded et un travail durable est créé. Répond 202 avec job_id, kb_id, document_id, document_key, version, state (uploaded), detected_format, size_bytes et sha256, et un en-tête Location. La tâche du worker knowledge_ingestion analyse ensuite le fichier par le domaine de sécurité des fichiers (fermé en cas d'échec), l'extrait, le découpe, calcule ses vecteurs et l'indexe. La même Idempotency-Key rejoue la même réponse (en-tête Idempotency-Replayed) ; avec un autre corps, elle est refusée en 409 idempotency_conflict. Demande la relation ReBAC editor.

Route : /v1/knowledge-bases/{kb_id}/documents/uploads (POST).

Nom	Type	Requis	Description
`kbId`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`body`	`DocumentUpload`	oui	Octets du fichier en base64, type de média déclaré, nom de fichier, titre, URI, classification, lecteurs, métadonnées, collection et langue.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`KnowledgeBasesResource.versions`

versions(id: string, docId: string, opts?: CallOptions)

Lister les versions d'un document. Historique des versions d'un document, de la plus récente à la plus ancienne : document_key (stable d'une version à l'autre) et items avec document_id, version, state (current, superseded ou deleted), searchable (seule la version courante active est recherchée), titre, URI, type de média, classification, content_hash, taille, nombre de fragments, extracteur, langue, collection, document_status, création, superseded_by et superseded_at, deleted_at, et les artifacts Docling (nature, profil de stockage, clé d'objet, taille, SHA-256). doc_id peut être le document courant ou n'importe quelle version passée. Une version n'est listée que si l'appelant fait partie de ses lecteurs et si sa classification respecte son habilitation. Demande la relation ReBAC viewer ; 404 not_found sinon.

Route : /v1/knowledge-bases/{kb_id}/documents/{doc_id}/versions (GET).

Nom	Type	Requis	Description
`id`	`string`	oui	Identifiant (UUID) de la base de connaissances.
`docId`	`string`	oui	Identifiant (UUID) du document ou de l'une de ses versions passées.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface `RetrievalStrategy`

Corps de setRetrieval : la stratégie de recherche d'une base de connaissances ; un champ omis prend sa valeur par défaut.

Doc

Champs :

Nom	Type	Requis	Description
`mode`	`"vector" \| "dense" \| "lexical" \| "hybrid"`	non	Mode de recherche : `vector`, `dense`, `lexical` ou `hybrid`.
`fusion`	`"rrf" \| "weighted"`	non	Fusion du mode hybride : `rrf` (fusion par rang réciproque) ou `weighted`.
`rrf_k`	`number`	non	Constante `k` de la fusion par rang réciproque (1 à 1000, 60 par défaut).
`candidates`	`number`	non	Multiplicateur de candidats de chaque moteur avant la fusion (1 à 20).
`rerank`	`boolean`	non	Ordonne les résultats avec un modèle de reclassement via le Model Gateway.
`rerank_model`	`string`	non	Identifiant du modèle de reclassement dans le registre.
`rerank_candidates`	`number`	non	Nombre de résultats confiés au modèle de reclassement (1 à 200).
`dedupe`	`boolean`	non	Retire des résultats les extraits quasi identiques.
`dedupe_threshold`	`number`	non	Similarité au-delà de laquelle deux extraits sont des doublons (0,5 à 1).
`context_window`	`number`	non	Fenêtre de contexte en jetons, positive.
`token_budget`	`number`	non	Budget en jetons du contexte construit à partir des résultats (0 à 32000).
`conflicts`	`boolean`	non	Ajoute à la réponse le signal heuristique `signals.possible_conflicts`.

Interface `DocumentUpload`

Corps de uploadDocument : le fichier en base64 et ses métadonnées, pour l'ingestion asynchrone.

Doc

Champs :

Nom	Type	Requis	Description
`content_base64`	`string`	oui	Contenu du fichier, encodé en base64.
`mime_type`	`string`	oui	Type de média du contenu, par exemple `application/pdf` ou `image/png`.
`title`	`string`	non	Titre du document.
`filename`	`string`	non	Nom de fichier d'origine ; son extension doit correspondre au format réel.
`uri`	`string`	non	URI source ; l'`uri` d'un document existant fait de cet envoi sa version suivante.
`classification`	`string`	non	Classification du document, jamais au-dessus de celle de la base de connaissances.
`readers`	`string[]`	non	Lecteurs du document (par défaut : les lecteurs de la base de connaissances).
`metadata`	`Doc`	non	Paires clé-valeur libres enregistrées avec l'objet et renvoyées telles quelles ; la plateforme ne les interprète jamais.
`collection`	`string`	non	Collection du document, utilisable comme filtre de requête.
`language`	`string`	non	Langue de l'interface et des messages : `en` ou `fr`.

Interface `MemoryWrite`

Corps de POST /v1/memory.

Doc

Champs :

Nom	Type	Requis	Description
`memory_id`	`string`	non	Élément existant à mettre à jour (nouvelle version). Omettez-le pour créer un élément.
`scope`	`MemoryContract["scope"]`	non	Ce qui est sauvegardé (clusters, services, jeux de données), sous forme d'objet.
`kind`	`MemoryContract["kind"]`	non	Type de mémoire : `episodic`, `semantic`, `procedural`, `preference` ou `fact`.
`content`	`string`	non	Texte de la mémoire.
`content_ref`	`string`	non	Référence vers un contenu stocké ailleurs (non recherchable).
`classification`	`MemoryContract["classification"]`	non	Classification du contenu de la mémoire.
`acl`	`MemoryContract["acl"]`	non	Lecteurs, rédacteurs et propriétaires de la mémoire.
`ttl_seconds`	`number \| null`	non	Durée de vie en secondes. Une fois écoulée, l'élément expire et n'est plus accepté.
`subject_id`	`string`	non	Personne concernée par la mémoire, utilisée par l'effacement d'un sujet.
`source`	`Doc`	non	Provenance de la mémoire.
`deletable`	`boolean`	non	Si faux, seul `tenant_admin` peut supprimer l'élément. Vrai par défaut.
`legal_hold`	`boolean`	non	Place la mémoire sous conservation légale : elle ne peut pas être supprimée et une mise à jour ne peut pas lever la conservation. Faux par défaut.

Classe `MemoryResource`

Mémoire. Memory Manager : éléments de mémoire durables des agents et des utilisateurs, conformes au Memory Contract v1, avec ACL, durée de vie, conservation légale, versionnage et recherche hybride.

Resource

`MemoryResource.addKnowledge`

addKnowledge(agentId: string, body: { texts: string[]; scope?: string; team?: string; dataset_id?: string; classification?: string; retention_days?: number; legal_hold?: boolean; build_graph?: boolean }, opts?: CallOptions)

Ingérer des connaissances. Ajoute des textes au jeu de données Cognee d'une portée (Cognee POST /api/v1/add, puis POST /api/v1/cognify si build_graph), seulement si la politique active knowledge_graph et si le moteur est cognee ou hybrid (sinon 403 ou 422 memory_capability_unsupported). Mêmes contrôles DLP, de classification, de conservation et d'isolation qu'une mémoire ; relation editor sur l'agent. 201 avec dataset, items et graph. Accepte un en-tête Idempotency-Key. Audité sous memory.knowledge.create sans le contenu.

Route : /v1/memory/agents/{agent_id}/knowledge (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`{ texts: string[]; scope?: string; team?: string; dataset_id?: string; classification?: string; retention_days?: number; legal_hold?: boolean; build_graph?: boolean }`	oui	Textes à ingérer et leur portée.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.agentPolicy`

agentPolicy(agentId: string, opts?: CallOptions)

Lire la politique de mémoire d'un agent. Choix du moteur (builtin, mem0, cognee, hybrid), instances, modes, portées, limites de mémorisation, conservation, partage et isolation exigée de l'agent, avec version, configured (faux : valeurs par défaut, moteur builtin) et engines (par usage memory ou knowledge : instance, fournisseur, isolation et capacités). Relation viewer sur l'agent, ou l'agent lui-même.

Route : /v1/memory/agents/{agent_id}/policy (GET).

Nom	Type	Défaut	Requis	Description
`agentId`	`string`		oui	Nom ou identifiant de l'agent.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.agentPolicyVersions`

agentPolicyVersions(agentId: string, opts?: CallOptions)

Lister les versions de la politique de mémoire. Anciennes versions de la politique de mémoire de l'agent, de la plus récente à la plus ancienne (au plus 200), chacune avec son moteur, ses instances, sa politique, son auteur et sa date. Relation viewer sur l'agent.

Route : /v1/memory/agents/{agent_id}/policy/versions (GET).

Nom	Type	Défaut	Requis	Description
`agentId`	`string`		oui	Nom ou identifiant de l'agent.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.buildGraph`

buildGraph(agentId: string, body: { dataset_ids?: string[] } = {}, opts?: CallOptions)

Construire le graphe de connaissances. Lance Cognee POST /api/v1/cognify sur les jeux de données lisibles de l'instance de l'agent (tous par défaut). Relation editor sur l'agent. Audité sous memory.knowledge.build.

Route : /v1/memory/agents/{agent_id}/knowledge/graph (POST).

Nom	Type	Défaut	Requis	Description
`agentId`	`string`		oui	Nom ou identifiant de l'agent.
`body`	`{ dataset_ids?: string[] }`	`{}`	non	Jeux de données à traiter.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.datasets`

datasets(agentId: string, params?: ListParams & { scope?: string }, opts?: CallOptions)

Lister les jeux de données de connaissances. Jeux de données que l'appelant peut lire via cet agent, paginés avec cursor.

Route : /v1/memory/agents/{agent_id}/knowledge/datasets (GET).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`params`	`ListParams & { scope?: string }`	non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.declareEngine`

declareEngine(body: MemoryEngineDeclare, opts?: CallOptions)

Déclarer une instance de moteur de mémoire. Déclare une instance de Mem0 ou de Cognee installée et exploitée par le Navin Manager, par exemple une instance dédiée à un tenant (tenant_id : séparation physique, comme l'exige une banque). Réservé à platform_admin (403 sinon). L'identifiant de connexion n'est qu'une référence (openbao://<chemin> ou env://EAI_CRED_<NOM>), résolue côté serveur. 409 conflict si l'identifiant existe ou est réservé (builtin, mem0, cognee), 404 pour un tenant inconnu. Accepte un en-tête Idempotency-Key. Audité sous memory.engine.declare.

Route : /v1/memory/engines (POST).

Nom	Type	Défaut	Requis	Description
`body`	`MemoryEngineDeclare`		oui	L'instance de moteur à déclarer.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.delete`

delete(id: string, opts?: CallOptions)

Supprimer un élément de mémoire. Efface le contenu, la référence, le vecteur et les anciennes versions de l'élément et le marque supprimé. Permis pour un rédacteur ou propriétaire de l'élément, ou tenant_admin (sinon 403 not_permitted_acl). Un élément sous conservation légale répond 409 legal_hold (le refus est audité) ; un élément non supprimable répond 409 conflict sauf pour tenant_admin. 404 not_found. Audité sous memory.delete.

Route : /v1/memory/{memory_id} (DELETE).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de l'élément de mémoire.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.deleteDataset`

deleteDataset(agentId: string, datasetId: string, opts?: CallOptions)

Supprimer un jeu de données de connaissances. Supprime le jeu de données dans Cognee (DELETE /api/v1/datasets/{dataset_id}) et ses entrées d'index. 409 legal_hold si le jeu de données ou l'un de ses éléments est sous conservation légale. Audité sous memory.knowledge.delete.

Route : /v1/memory/agents/{agent_id}/knowledge/datasets/{dataset_id} (DELETE).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`datasetId`	`string`	oui	Identifiant (UUID) de l'entrée d'index Navin du jeu de données.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.deleteEngine`

deleteEngine(engineId: string, opts?: CallOptions)

Retirer une instance de moteur de mémoire déclarée. Retire une instance déclarée et les identifiants de tenant qui lui sont liés. Réservé à platform_admin. 409 memory_engine_in_use tant qu'une politique d'agent ou une mémoire l'utilise ; 404 memory_engine_not_found. Audité sous memory.engine.delete.

Route : /v1/memory/engines/{engine_id} (DELETE).

Nom	Type	Défaut	Requis	Description
`engineId`	`string`		oui	Identifiant de l'instance de moteur.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.deleteEngineCredential`

deleteEngineCredential(engineId: string, opts?: CallOptions)

Délier l'identifiant du tenant. Retire l'identifiant de connexion de ce tenant sur l'instance ; celui de l'instance est de nouveau utilisé. Rôle tenant_admin. Audité sous memory.engine.change.

Route : /v1/memory/engines/{engine_id}/credential (DELETE).

Nom	Type	Défaut	Requis	Description
`engineId`	`string`		oui	Identifiant de l'instance de moteur.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.engineCapabilities`

engineCapabilities(engineId: string, opts?: CallOptions)

Lire les capacités d'un moteur de mémoire. Ensemble déclaratif des capacités du moteur : seulement ce que son fournisseur exécute réellement. memory : parmi remember, recall, search, update, forget, list, get, purge, get_health, get_capabilities ; knowledge : parmi ingest_knowledge, build_graph, search_graph, get_relations, delete_dataset. Une opération hors de cet ensemble répond 422 memory_capability_unsupported. Donne aussi isolation pour le tenant et session_memory (vrai pour builtin seulement : la mémoire de session ne va jamais vers un moteur externe). Rien n'est envoyé au moteur.

Route : /v1/memory/engines/{engine_id}/capabilities (GET).

Nom	Type	Défaut	Requis	Description
`engineId`	`string`		oui	Identifiant de l'instance de moteur (`builtin`, `mem0`, `cognee` ou un identifiant déclaré).
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.engineHealth`

engineHealth(engineId: string, opts?: CallOptions)

Vérifier la santé d'un moteur de mémoire. Appelle le moteur avec l'identifiant de connexion du tenant : Mem0 GET /auth/setup-status puis GET /configure/providers, Cognee GET /health puis GET /api/v1/datasets. Répond status up (ou degraded), ou down avec error et reason (jamais un secret). Rôles tenant_admin, developer, security_officer ou auditor.

Route : /v1/memory/engines/{engine_id}/health (GET).

Nom	Type	Défaut	Requis	Description
`engineId`	`string`		oui	Identifiant de l'instance de moteur.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.engines`

engines(opts?: CallOptions)

Lister les moteurs de mémoire. Moteurs de mémoire utilisables par le tenant (Navin Memory Provider) : builtin (le magasin du Memory Manager), les instances de plateforme mem0 et cognee rendues par le Navin Manager depuis ses liaisons (seulement si elles sont configurées), et les instances déclarées par l'administrateur de la plateforme (celles partagées et celles dédiées à ce tenant ; une instance dédiée à un autre tenant n'est jamais listée). Chaque entrée donne provider, base_url, origin (builtin, manager_binding, declared), dedicated, credential_bound (l'identifiant lui-même n'est jamais renvoyé), isolation (logical, backend ou dedicated_instance : la séparation que cette instance garantit pour le tenant) et capabilities. Navin Enterprise n'installe ni ne configure aucun moteur : c'est le rôle du Navin Manager.

Route : /v1/memory/engines (GET).

Nom	Type	Défaut	Requis	Description
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.export`

export(agentId: string, body: { scopes?: string[] } = {}, opts?: CallOptions)

Exporter les mémoires d'un agent. Exporte au plus 1000 mémoires lisibles avec leur contenu (données non fiables). Refusé aux agents (403). Audité sous memory.export sans le contenu.

Route : /v1/memory/agents/{agent_id}/memories/export (POST).

Nom	Type	Défaut	Requis	Description
`agentId`	`string`		oui	Nom ou identifiant de l'agent.
`body`	`{ scopes?: string[] }`	`{}`	non	Portées à exporter (par défaut : toutes les portées lisibles).
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.forget`

forget(agentId: string, itemId: string, opts?: CallOptions)

Oublier une mémoire d'un agent. Supprime la mémoire dans son moteur (Mem0 DELETE /memories/{memory_id}, suppression de l'élément de données Cognee, suppression logique builtin) et marque l'entrée d'index supprimée. 409 legal_hold ; seul l'agent propriétaire d'une mémoire partagée (403). Audité sous memory.provider.delete.

Route : /v1/memory/agents/{agent_id}/memories/{item_id} (DELETE).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`itemId`	`string`	oui	Identifiant (UUID) de l'entrée d'index Navin.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.get`

get(id: string, opts?: CallOptions)

Lire un élément de mémoire. Renvoie l'élément sous forme de document Memory Contract avec son history (numéros et dates des anciennes versions). Un élément expiré, ou que l'appelant ne peut pas lire selon l'ACL ou l'habilitation, répond 404 not_found.

Route : /v1/memory/{memory_id} (GET).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Identifiant (UUID) de l'élément de mémoire.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.list`

list(params?: ListParams, opts?: CallOptions)

Lister les éléments de mémoire. Éléments lisibles par l'appelant (présent dans readers, classification dans les limites de son habilitation, non expirés, non supprimés), sous forme de documents Memory Contract, paginés avec cursor.

Route : /v1/memory (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.memories`

memories(agentId: string, params?: ListParams & { scope?: string; include_content?: boolean }, opts?: CallOptions)

Lister les mémoires d'un agent. Entrées d'index des mémoires que l'appelant peut lire via cet agent (portées lisibles de la politique, classification dans l'habilitation, non expirées), paginées avec cursor. Avec include_content=true (au plus 100 par page), le contenu est lu dans le moteur et renvoyé comme donnée non fiable. Audité sous memory.provider.read.

Route : /v1/memory/agents/{agent_id}/memories (GET).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`params`	`ListParams & { scope?: string; include_content?: boolean }`	non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.memoryItem`

memoryItem(agentId: string, itemId: string, opts?: CallOptions)

Lire une mémoire d'un agent. Entrée d'index et contenu (lu dans le moteur, donnée non fiable) d'une mémoire. Un élément d'une portée que l'appelant ne peut pas lire répond 404, jamais 403, pour ne pas révéler son existence. Audité sous memory.provider.read.

Route : /v1/memory/agents/{agent_id}/memories/{item_id} (GET).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`itemId`	`string`	oui	Identifiant (UUID) de l'entrée d'index Navin.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.purge`

purge(agentId: string, body: { scope: string; confirm: boolean; team?: string; session_id?: string }, opts?: CallOptions)

Purger une portée d'un agent. Supprime toutes les mémoires et tous les jeux de données d'une portée de l'appelant (Mem0 DELETE /memories avec les identifiants de la portée, suppression du jeu de données Cognee, suppression logique builtin). confirm doit être vrai (400). 409 legal_hold si un élément de la portée est sous conservation légale. Audité sous memory.provider.purge.

Route : /v1/memory/agents/{agent_id}/memories/purge (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`{ scope: string; confirm: boolean; team?: string; session_id?: string }`	oui	La portée à purger et la confirmation.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.recall`

recall(agentId: string, body: AgentMemoryRecall, opts?: CallOptions)

Rappeler des mémoires pour le LLM. Recherche dans les portées lisibles sur les moteurs de la politique (hybride : Mem0 et Cognee, fusionnés et dédoublonnés par contenu, chaque source gardée dans sources), ne garde que les résultats indexés par Navin pour une portée lisible et dans l'habilitation (contrôle des permissions avant que quoi que ce soit n'atteigne le LLM), les contrôle contre l'injection de prompt (éléments bloqués écartés) et les renvoie comme données non fiables : framed_content encadré par les marqueurs de contenu non fiable et context_segments de type memory pour le Context Manager, jamais comme instructions. La décision de politique memory.search est évaluée. Audité sous memory.provider.read avec des comptes seulement.

Route : /v1/memory/agents/{agent_id}/recall (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`AgentMemoryRecall`	oui	Requête, portées, nombre de résultats et session.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.relations`

relations(agentId: string, datasetId: string, opts?: CallOptions)

Lire les relations d'un jeu de données. Nœuds et arêtes du graphe de connaissances d'un jeu de données lisible (Cognee GET /api/v1/datasets/{dataset_id}/graph), contrôlés contre l'injection de prompt et renvoyés comme données non fiables. 404 pour un jeu de données que l'appelant ne peut pas lire. Audité sous memory.provider.read.

Route : /v1/memory/agents/{agent_id}/knowledge/datasets/{dataset_id}/relations (GET).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`datasetId`	`string`	oui	Identifiant (UUID) de l'entrée d'index Navin du jeu de données.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.remember`

remember(agentId: string, body: AgentMemoryWrite, opts?: CallOptions)

Mémoriser via le moteur de l'agent. Écrit une mémoire via le moteur de la politique de l'agent (portée session : toujours le magasin builtin ; hybrid : Mem0). 201 avec items (entrées d'index, sans contenu), engine et engine_instance. Le contexte (tenant, organisation, projet, utilisateur, agent, session) est dérivé côté serveur du principal authentifié, du registre des agents et de la session vérifiée, jamais du corps. Contrôles, chaque refus étant audité : un agent n'utilise que sa propre mémoire (403 memory_agent_mismatch), la portée et le type doivent être permis par la politique (403), les portées partagées exigent editor sur l'agent, le moteur doit annoncer remember (422 memory_capability_unsupported) et garantir l'isolation exigée (409), les secrets, mots de passe, jetons et clés sont refusés (422 memory_secret_refused), les données personnelles si la politique les interdit (422), une classification au-dessus de la politique ou de l'habilitation (403), une conservation au-delà de la politique (422). Accepte un en-tête Idempotency-Key. Audité sous memory.provider.create sans le contenu.

Route : /v1/memory/agents/{agent_id}/memories (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`AgentMemoryWrite`	oui	La mémoire à retenir.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.restoreAgentPolicy`

restoreAgentPolicy(agentId: string, version: number, opts?: CallOptions)

Restaurer une version de la politique de mémoire. Applique de nouveau une ancienne version comme nouvelle version, avec les mêmes contrôles que PUT .../policy. 404 pour une version inconnue. Audité sous memory.policy.restore.

Route : /v1/memory/agents/{agent_id}/policy/restore (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`version`	`number`	oui	Numéro de version (1 ou plus).
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.search`

search(body: { query: string; scope?: Doc; top_k?: number } & Doc, opts?: CallOptions)

Rechercher dans la mémoire. Calcule le score des éléments visibles (au plus les 2000 mis à jour le plus récemment et ayant un contenu) et renvoie les top_k meilleurs avec score, keyword_score et vector_score. keyword : part des termes de la requête trouvés ; vector : similarité cosinus avec l'embedding de la requête (seulement les éléments vectorisés avec le modèle courant) ; hybrid (par défaut) : moitié de chaque. Le contenu rappelé est contrôlé contre l'injection de prompt ; les éléments bloqués sont écartés. La politique memory.search est évaluée. 400 invalid_request pour un mode inconnu. Audité sous memory.search.

Route : /v1/memory/search (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ query: string; scope?: Doc; top_k?: number } & Doc`		oui	Requête, portée et type facultatifs, nombre de résultats et mode.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.searchKnowledge`

searchKnowledge(agentId: string, body: { query: string; dataset_ids?: string[]; top_k?: number; search_type?: "CHUNKS" | "CHUNKS_LEXICAL" | "SUMMARIES" | "RAG_COMPLETION" | "GRAPH_COMPLETION" }, opts?: CallOptions)

Rechercher dans le graphe de connaissances. Cognee POST /api/v1/search, un jeu de données lisible par appel afin que chaque passage soit attribué à son jeu de données ; les résultats sont contrôlés et renvoyés comme données non fiables avec framed_content. La décision de politique memory.search est évaluée. Audité sous memory.provider.read.

Route : /v1/memory/agents/{agent_id}/knowledge/search (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`{ query: string; dataset_ids?: string[]; top_k?: number; search_type?: "CHUNKS" \| "CHUNKS_LEXICAL" \| "SUMMARIES" \| "RAG_COMPLETION" \| "GRAPH_COMPLETION" }`	oui	Requête, jeux de données, nombre de résultats et type de recherche.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.searchMemories`

searchMemories(agentId: string, body: AgentMemoryRecall, opts?: CallOptions)

Rechercher dans les mémoires d'un agent. Même recherche que recall pour une personne qui consulte les mémoires (sans context_segments) ; les portées partagées exigent editor sur l'agent. Les résultats sont des données non fiables. Audité sous memory.provider.read.

Route : /v1/memory/agents/{agent_id}/memories/search (POST).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`AgentMemoryRecall`	oui	Requête, portées, nombre de résultats et session.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.setAgentPolicy`

setAgentPolicy(agentId: string, body: { engine?: "builtin" | "mem0" | "cognee" | "hybrid"; mem0_instance?: string; cognee_instance?: string; policy?: Doc }, opts?: CallOptions)

Définir la politique de mémoire d'un agent. Remplace la politique de mémoire de l'agent (nouvelle version, l'ancienne est gardée pour une restauration). Contrôles : rôles tenant_admin, developer ou application_owner et relation editor sur l'agent (403) ; global_access exige tenant_admin ; default_scope doit être une portée d'écriture et shared_with des agents existants (400) ; les instances choisies doivent exister, correspondre au fournisseur et garantir required_isolation (409 memory_isolation_unsatisfied : une instance dédiée installée par le Navin Manager est nécessaire). La décision de politique memory.policy.update est appliquée. shared_with écrit ou supprime la relation OpenFGA memory_reader de chaque agent sur celui-ci. Audité sous memory.policy.update, plus memory.engine.change quand le moteur ou une instance change et memory.share quand le partage change.

Route : /v1/memory/agents/{agent_id}/policy (PUT).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`body`	`{ engine?: "builtin" \| "mem0" \| "cognee" \| "hybrid"; mem0_instance?: string; cognee_instance?: string; policy?: Doc }`	oui	Choix du moteur, instances et politique de mémoire de l'agent.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.setEngineCredential`

setEngineCredential(engineId: string, credentialRef: string, opts?: CallOptions)

Lier l'identifiant du tenant sur un moteur. Lie l'identifiant de connexion de ce tenant sur une instance partagée (référence openbao://<chemin> vers un secret du tenant). Sur une instance Cognee avec contrôle d'accès côté moteur, c'est la clé d'API de l'utilisateur Cognee du tenant : ses jeux de données et permissions sont alors appliqués par Cognee lui-même (isolation devient backend). Sur Mem0, une clé ne sépare pas les mémoires (logical reste). Rôle tenant_admin. Audité sous memory.engine.change.

Route : /v1/memory/engines/{engine_id}/credential (PUT).

Nom	Type	Requis	Description
`engineId`	`string`	oui	Identifiant de l'instance de moteur.
`credentialRef`	`string`	oui	Référence `openbao://<chemin>` vers un secret du tenant.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.updateMemory`

updateMemory(agentId: string, itemId: string, content: string, opts?: CallOptions)

Modifier une mémoire d'un agent. Remplace le contenu d'une mémoire dans son moteur (Mem0 PUT /memories/{memory_id}, nouvelle version builtin) après les mêmes contrôles DLP qu'une création ; la version augmente. Seul l'agent propriétaire d'une mémoire partagée peut la modifier (403) ; un élément sous conservation légale répond 409 legal_hold. Audité sous memory.provider.update.

Route : /v1/memory/agents/{agent_id}/memories/{item_id} (PATCH).

Nom	Type	Requis	Description
`agentId`	`string`	oui	Nom ou identifiant de l'agent.
`itemId`	`string`	oui	Identifiant (UUID) de l'entrée d'index Navin.
`content`	`string`	oui	Texte (1 à 20000 caractères) ; les secrets sont refusés.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`MemoryResource.write`

write(body: MemoryWrite, opts?: CallOptions)

Écrire un élément de mémoire. Crée un élément, ou une nouvelle version de memory_id (201, document Memory Contract). Étapes : 1. kind et scope.type sont vérifiés (400 invalid_request) ; content ou content_ref est requis. 2. La détection de données personnelles peut relever la classification ; une classification au-dessus de l'habilitation de l'appelant répond 403 policy_denied ; la politique memory.write est évaluée. 3. Pour une mise à jour, l'appelant doit être rédacteur ou propriétaire (403 not_permitted_acl) avant l'envoi du contenu au modèle d'embedding. 4. Le contenu est vectorisé et enregistré. Un nouvel élément a par défaut l'appelant comme lecteur, rédacteur et propriétaire, et la portée user de l'appelant. Audité sous memory.create ou memory.update.

Route : /v1/memory (POST).

Nom	Type	Défaut	Requis	Description
`body`	`MemoryWrite`		oui	L'élément de mémoire à écrire.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface `RagAgentInstanceCreate`

Corps de ragAgent.create : la fiche d'activation d'une instance du RAG Agent, créée en brouillon.

Doc

Champs :

Nom	Type	Requis	Description
`name`	`string`	oui	Nom affiché de l'instance.
`project`	`string`	oui	Identifiant du projet auquel les résultats sont limités.
`deployment_model`	`"shared" \| "dedicated"`	oui	`shared` (le runtime partagé existant) ou `dedicated` (un runtime installé par le Navin Manager).
`generation_model`	`string`	oui
`embedding_model`	`string`	oui	Identifiant dans le registre du modèle d'embeddings de l'instance.
`id`	`string`	non	`model_name` LiteLLM, unique dans le profil.
`description`	`string`	non	Description libre de l'instance.
`organization_id`	`string`	non	Organisation du tenant à laquelle appartient l'instance.
`business_unit_id`	`string`	non	Unité métier à laquelle appartient l'instance.
`version`	`string`	non	Version du RAG Agent à déployer (par défaut : la version courante).

Classe `RagAgentResource`

Instances de l'agent RAG. Activation et cycle de vie des instances du Navin Enterprise RAG Agent. Le Control Plane porte l'enregistrement d'activation de chaque instance (son statut, son modèle de déploiement, ses versions et les ressources qu'elle possède), car dans le modèle dédié le runtime du RAG n'existe pas encore au moment de l'activation. Le runtime du RAG lit son activation avec GET /v1/rag-agent/instances/{instance_id} et refuse de servir des conversations tant que le statut n'est pas ready ou degraded (instance_not_ready).

Resource

`RagAgentResource.backup`

backup(instanceId: string, opts?: CallOptions)

Sauvegarder une instance (non pris en charge). Répond 501 rag_agent_backup_not_supported avec parts et la raison de chacune : le runtime du RAG n'a pas de route d'administration pour exporter les lignes du schéma rag d'une instance, le domaine des connaissances n'a pas d'export de base de connaissances. Rien n'est simulé ; le refus est audité.

Route : /v1/rag-agent/instances/{instance_id}/backup (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.create`

create(body: RagAgentInstanceCreate, opts?: CallOptions)

Créer une instance brouillon de l'agent RAG. Crée l'enregistrement d'activation en draft (201) avec son id immuable (fourni, par exemple l'identifiant choisi par le runtime du RAG, ou généré). Demande un administrateur du tenant ou un propriétaire du projet (403 forbidden) ; projet inconnu : 404 rag_agent_project_not_found ; un nom ou un identifiant déjà pris : 409 conflict. Avec Idempotency-Key, une nouvelle tentative rejoue la première réponse. Audité sous rag_agent.create.

Route : /v1/rag-agent/instances (POST).

Nom	Type	Défaut	Requis	Description
`body`	`RagAgentInstanceCreate`		oui	Nom, projet, organisation et unité métier, modèle de déploiement, modèles de génération et d'embeddings du registre, version facultative.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.delete`

delete(instanceId: string, opts?: CallOptions)

Supprimer une instance. Opération longue (202, statut deleting puis deleted) depuis draft, stopped ou failed (une instance prête est d'abord arrêtée, sinon 409). Ne supprime que ce que l'instance possède, tel qu'enregistré dans resources : sa base de connaissances et ses points Qdrant, les objets sous son préfixe de stockage, les mémoires et la politique de mémoire de son agent, ses tuples, sa clé d'API et son secret, son agent ; l'application gouvernée est retirée. Le runtime partagé, une base de données partagée, la collection Qdrant partagée par les bases du tenant et le profil de stockage sont conservés. Chaque étape liste deleted et kept. Audité sous rag_agent.delete et rag_agent.delete.completed.

Route : /v1/rag-agent/instances/{instance_id} (DELETE).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.deleteLogo`

deleteLogo(instanceId: string, opts?: CallOptions)

Retirer le logo d'une instance. Retour au logo par défaut du runtime : l'image de marque ne pointe plus vers un objet, version est incrémentée et l'objet stocké est supprimé. Sans logo, renvoie l'image de marque inchangée. Mêmes droits que le PUT ; audité sous rag_agent.branding.logo.remove.

Route : /v1/rag-agent/instances/{instance_id}/branding/logo (DELETE).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.get`

get(instanceId: string, opts?: CallOptions)

Lire une instance de l'agent RAG. L'enregistrement d'activation avec serving (vrai pour ready et degraded), l'operation et le run courants, validation, last_error et les steps de l'exécution courante dans l'ordre (état, tentatives, détail, journaux, horaires). C'est la route que le runtime du RAG lit au démarrage et à la demande.

Route : /v1/rag-agent/instances/{instance_id} (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance, le même dans le Control Plane et dans le runtime du RAG.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.getBranding`

getBranding(instanceId: string, opts?: CallOptions)

Lire l'image de marque d'une instance. L'image de marque choisie dans le parcours d'activation, portée par le Control Plane : agent_name, sidebar_color, navbar_color, les couleurs de texte calculées pour elles (sidebar_text_color, navbar_text_color, noir ou blanc, contraste de 4,5:1 ou plus), logo (content_type, sha256, size_bytes, url) ou null, version, updated_at, et app_url (l'URL de l'application web une fois connue). Un champ null signifie la valeur par défaut du runtime. Le runtime du RAG en garde une réplique pour sa page de connexion publique et la réécrit quand version est plus récente. Tout principal du tenant ; l'instance d'un autre tenant répond 404.

Route : /v1/rag-agent/instances/{instance_id}/branding (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.getLogo`

getLogo(instanceId: string, opts?: CallOptions)

Lire le logo d'une instance. Les octets du logo, lus par le domaine de stockage et contrôlés avec le sha256 enregistré, avec le Content-Type du format validé (image/png ou image/jpeg), X-Content-Type-Options: nosniff, une Content-Security-Policy commençant par default-src 'none' et un ETag. 404 rag_agent_logo_not_found quand l'instance n'a pas de logo. Tout principal du tenant.

Route : /v1/rag-agent/instances/{instance_id}/branding/logo (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.health`

health(instanceId: string, opts?: CallOptions)

Santé d'une instance. Contrôles réels : URL de disponibilité du runtime (GET /readyz), base de connaissances (ligne, vector store qdrant, /readyz de Qdrant) et passerelle de modèles (modèles de génération et d'embeddings dans le registre, utilisables). status vaut up, degraded ou down (runtime hors service) ; instance_status est le statut du cycle de vie. Chaque contrôle a status, duration_ms et reason quand il n'est pas up.

Route : /v1/rag-agent/instances/{instance_id}/health (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.list`

list(query?: { status?: string; project?: string; limit?: number }, opts?: CallOptions)

Lister les instances de l'agent RAG. Enregistrements d'activation du tenant, du plus récent au plus ancien, avec statut, modèle de déploiement, versions et ressources possédées (une page, next_cursor nul). Filtres : status, project.

Route : /v1/rag-agent/instances (GET).

Nom	Type	Défaut	Requis	Description
`query`	`{ status?: string; project?: string; limit?: number }`		non	Paramètres de la chaîne de requête de la route.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.provision`

provision(instanceId: string, opts?: CallOptions)

Provisionner une instance. Opération longue (202, Operation-Id) : statut provisioning puis starting, étapes de validation à activation exécutées par le worker. Depuis un draft validé (sinon 409 rag_agent_not_validated) ou après un provisionnement en échec, qui reprend à l'étape en échec. Répété pendant le provisionnement ou une fois prête : changed: false. Audité sous rag_agent.provision, chaque étape sous rag_agent.step.

Route : /v1/rag-agent/instances/{instance_id}/provision (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.restart`

restart(instanceId: string, opts?: CallOptions)

Redémarrer une instance. Opération longue (202) : depuis ready, degraded, stopped ou après un redémarrage en échec, étapes deployment (redémarrage par le Navin Manager pour une instance dédiée), health, smoke, activation. Un redémarrage en cours : changed: false.

Route : /v1/rag-agent/instances/{instance_id}/restart (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.restore`

restore(instanceId: string, backupId: string, opts?: CallOptions)

Restaurer une instance (non pris en charge). Répond 501 rag_agent_backup_not_supported avec les mêmes parts que la sauvegarde : aucune sauvegarde d'instance ne peut encore être faite réellement. Audité.

Route : /v1/rag-agent/instances/{instance_id}/restore (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`backupId`	`string`	oui	Identifiant de la sauvegarde à restaurer.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.start`

start(instanceId: string, opts?: CallOptions)

Démarrer une instance. Opération longue (202) : depuis stopped (ou après un démarrage ou un arrêt en échec), étapes deployment (démarrage par le Navin Manager pour une instance dédiée, statut seulement pour une partagée), health, smoke, activation (application gouvernée active). Déjà en démarrage ou prête : changed: false.

Route : /v1/rag-agent/instances/{instance_id}/start (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.stop`

stop(instanceId: string, opts?: CallOptions)

Arrêter une instance. Opération longue (202) : depuis ready, degraded ou après un démarrage, un redémarrage, une mise à niveau ou un arrêt en échec, étapes deployment (arrêt par le Navin Manager pour une instance dédiée, statut seulement pour une partagée) et activation (application gouvernée suspendue, raison rag_instance_stopped) ; statut stopped. Déjà en arrêt ou arrêtée : changed: false.

Route : /v1/rag-agent/instances/{instance_id}/stop (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.updateBranding`

updateBranding(instanceId: string, body: RagAgentBrandingUpdate, opts?: CallOptions)

Modifier l'image de marque d'une instance. Écrit les champs fournis (un champ absent est conservé, null le ramène à la valeur par défaut du runtime) et renvoie l'image de marque. Les couleurs sont au format #RRGGBB (enregistrées en majuscules) ; le texte affiché dessus est noir ou blanc, selon le meilleur contraste (luminance relative WCAG 2.2, la règle du frontend du RAG), et une couleur dont le texte resterait sous 4,5:1 répond 422 rag_agent_branding_contrast. app_url doit être une URL https sans identifiants (422 rag_agent_app_url_invalid). Un changement du nom, des couleurs ou du logo incrémente version ; un expected_version différent de la version courante répond 409 rag_agent_branding_version_conflict. Avec une Idempotency-Key, une nouvelle tentative avec le même corps rejoue la première réponse (Idempotency-Replayed: true), un autre corps répond 409 idempotency_conflict. Demande un administrateur du tenant ou un propriétaire du projet (403 forbidden) ; refusé quand l'instance est deleting ou deleted (409). Audité sous rag_agent.branding.update.

Route : /v1/rag-agent/instances/{instance_id}/branding (PUT).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`body`	`RagAgentBrandingUpdate`	oui	Les champs de l'image de marque à écrire.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.upgrade`

upgrade(instanceId: string, version: string, opts?: CallOptions)

Mettre à niveau une instance. Opération longue (202), statut updating : une instance partagée suit le runtime partagé, donc l'étape de déploiement vérifie que le runtime exécute la version demandée (sinon shared_runtime_version_mismatch) ; une instance dédiée est réinstallée par le Navin Manager. Puis health, smoke, activation ; deployed_version devient la version. La même version déjà déployée ou en cours : changed: false.

Route : /v1/rag-agent/instances/{instance_id}/upgrade (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`version`	`string`	oui	Version à déployer (lettres, chiffres, `.`, `_`, `+`, `-`, 64 caractères au plus).
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.uploadLogo`

uploadLogo(instanceId: string, input: RagAgentLogoUpload | FormData, opts?: CallOptions)

Téléverser le logo d'une instance. Multipart file (avec les champs texte facultatifs filename et mime_type). PNG ou JPEG uniquement : le SVG et tout autre format sont refusés. La signature réelle, le Content-Type déclaré et l'extension du fichier doivent concorder ; 32 à 1024 pixels de côté, 512 Kio au plus ; sinon 422 rag_agent_logo_invalid avec details.reason (format_not_allowed, signature_invalid, signature_mismatch, extension_mismatch, dimensions_out_of_bounds, too_large, empty). Le fichier est ensuite analysé par le domaine de sécurité des fichiers, en échec fermé : un fichier bloqué répond 422 file_blocked, un analyseur indisponible 503 file_scan_unavailable. Il est stocké par le domaine de stockage dans le profil de stockage des documents du tenant sous rag-agent/<tenant>/<instance>/branding/ (409 rag_agent_branding_storage_required sans un tel profil, 503 rag_agent_branding_storage_unavailable quand il est injoignable) ; l'objet remplacé est supprimé. Incrémente version et renvoie l'image de marque. Mêmes droits que le PUT ; audité sous rag_agent.branding.logo.update (un refus est audité comme refus).

Route : /v1/rag-agent/instances/{instance_id}/branding/logo (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`input`	`RagAgentLogoUpload \| FormData`	oui	Logo à envoyer, ou un FormData déjà prêt portant la partie `file`.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RagAgentResource.validate`

validate(instanceId: string, opts?: CallOptions)

Valider une instance. Contrôles réels avant le provisionnement : le projet existe et l'appelant peut l'administrer, le modèle de génération existe dans le registre avec la capacité chat et un statut utilisable, le modèle d'embeddings se résout dans la Model Gateway (capacité embeddings), le quota d'instances, Qdrant répond, le runtime partagé répond (modèle partagé) ou le Navin Manager répond (modèle dédié, un service du catalogue non publié est un avertissement). Depuis draft ou après une validation en échec. 200 avec validation et le statut draft ; 422 rag_agent_validation_failed avec les contrôles en échec (statut failed, étape validation). Audité sous rag_agent.validate et rag_agent.validate.completed.

Route : /v1/rag-agent/instances/{instance_id}/validate (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface `RagAgentBranding`

Habillage d'une instance du RAG Agent, géré par le Control Plane : nom, couleurs, résumé du logo, version et URL de l'application.

Doc

Champs :

Nom	Type	Requis	Description
`agent_name`	`string \| null`	non	Nom de l'agent affiché aux utilisateurs, 1 à 80 caractères, sans `<`, `>` ni caractère de contrôle.
`sidebar_color`	`string \| null`	non	Couleur de la barre latérale, `#RRGGBB` ; le texte dessus est noir ou blanc avec un contraste de 4,5:1 ou plus.
`navbar_color`	`string \| null`	non	Couleur de la barre supérieure, `#RRGGBB` ; le texte dessus est noir ou blanc avec un contraste de 4,5:1 ou plus.
`sidebar_text_color`	`string \| null`	non	Couleur du texte de la barre latérale, noir ou blanc, choisie pour un contraste de 4,5:1 ou plus.
`navbar_text_color`	`string \| null`	non	Couleur du texte de la barre de navigation, noir ou blanc, choisie pour un contraste de 4,5:1 ou plus.
`logo`	`{ content_type: string; sha256: string; size_bytes: number; url: string } \| null`	non	Logo personnalisé (type de contenu, sha256, taille en octets, URL), ou null pour le logo par défaut.
`version`	`number`	non	Version de l'habillage, augmentée à chaque écriture ; la réplique du runtime RAG suit une version plus récente.
`updated_at`	`string \| null`	non	Date de la dernière écriture de l'habillage.
`app_url`	`string \| null`	non	URL de l'application web de l'instance une fois connue, https uniquement, sans identifiants (2048 caractères au plus).

Interface `RagAgentBrandingUpdate`

Corps de ragAgent.updateBranding : les clés fournies sont écrites, null ramène un champ à sa valeur par défaut.

Champs :

Nom	Type	Requis	Description
`agent_name`	`string \| null`	non	Nom de l'agent affiché aux utilisateurs, 1 à 80 caractères, sans `<`, `>` ni caractère de contrôle.
`sidebar_color`	`string \| null`	non	Couleur de la barre latérale, `#RRGGBB` ; le texte dessus est noir ou blanc avec un contraste de 4,5:1 ou plus.
`navbar_color`	`string \| null`	non	Couleur de la barre supérieure, `#RRGGBB` ; le texte dessus est noir ou blanc avec un contraste de 4,5:1 ou plus.
`app_url`	`string \| null`	non	URL de l'application web de l'instance une fois connue, https uniquement, sans identifiants (2048 caractères au plus).
`expected_version`	`number`	non	Version lue en dernier par l'appelant. La modification est refusée avec 409 si l'objet a changé depuis (concurrence optimiste).

Interface `RagAgentLogoUpload`

Logo de ragAgent.uploadLogo : PNG ou JPEG, 32 à 1024 pixels, 512 Kio au plus.

Champs :

Nom	Type	Requis	Description
`file`	`Blob \| Uint8Array`	oui	Octets de l'image, en Blob ou en Uint8Array.
`filename`	`string`	oui	Nom du fichier du logo ; son extension doit correspondre au format réel.
`mime_type`	`"image/png" \| "image/jpeg"`	oui	Type de média du contenu, par exemple `application/pdf` ou `image/png`.

Interface `ComplianceInstanceCreate`

Doc

Champs :

Nom	Type	Requis	Description
`name`	`string`	oui
`project`	`string`	oui	Identifiant du projet auquel les résultats sont limités.
`deployment_model`	`"shared" \| "dedicated"`	oui	`shared` (le runtime partagé existant) ou `dedicated` (un runtime installé par le Navin Manager).
`generation_model`	`string`	oui
`embedding_model`	`string`	oui
`sector`	`"generic" \| "banking" \| "insurance" \| "industry"`	non	Secteur de l'instance : `generic` (par défaut), `banking`, `insurance` ou `industry`.
`pack`	`"banking" \| "insurance" \| "industry" \| null`	non	Pack métier chargé au-dessus du noyau générique : `banking`, `insurance` ou `industry` ; null pour le noyau seul.
`id`	`string`	non	`model_name` LiteLLM, unique dans le profil.
`description`	`string`	non
`organization_id`	`string`	non
`business_unit_id`	`string`	non
`version`	`string`	non

Classe `ComplianceResource`

Instances de l'agent de conformité et d'audit. Activation et cycle de vie des instances du Navin Enterprise Compliance & Audit Agent (ADR-0177, section 8), copie adaptée du modèle de l'agent RAG. Le Control Plane porte l'enregistrement d'activation de chaque instance (son statut, son secteur et son pack, son modèle de déploiement, ses versions et les ressources qu'elle possède), car dans le modèle dédié le runtime de conformité n'existe pas encore au moment de l'activation. Le runtime de conformité lit son activation avec GET /v1/compliance/instances/{instance_id}.

Resource

`ComplianceResource.backup`

backup(instanceId: string, opts?: CallOptions)

Sauvegarder une instance (non pris en charge). Répond 501 compliance_backup_not_supported avec parts et la raison de chacune : le runtime de conformité n'a pas de route d'administration pour exporter les lignes du schéma compliance d'une instance, le domaine des connaissances n'a pas d'export de base de connaissances. Rien n'est simulé ; le refus est audité.

Route : /v1/compliance/instances/{instance_id}/backup (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.create`

create(body: ComplianceInstanceCreate, opts?: CallOptions)

Créer une instance brouillon de l'agent de conformité et d'audit. Crée l'enregistrement d'activation en draft (201) avec son id immuable (fourni, par exemple l'identifiant choisi par le runtime de conformité, ou généré), son secteur et son pack. Demande un administrateur du tenant ou un propriétaire du projet (403 forbidden) ; projet inconnu : 404 compliance_project_not_found ; un nom ou un identifiant déjà pris : 409 conflict. Avec Idempotency-Key, une nouvelle tentative rejoue la première réponse. Audité sous compliance.create.

Route : /v1/compliance/instances (POST).

Nom	Type	Défaut	Requis	Description
`body`	`ComplianceInstanceCreate`		oui	Nom, projet, organisation et unité métier, secteur et pack, modèle de déploiement, modèles de génération et d'embeddings du registre, version facultative.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.delete`

delete(instanceId: string, opts?: CallOptions)

Route : /v1/compliance/instances/{instance_id} (DELETE).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.deleteLogo`

deleteLogo(instanceId: string, opts?: CallOptions)

Route : /v1/compliance/instances/{instance_id}/branding/logo (DELETE).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.get`

get(instanceId: string, opts?: CallOptions)

Lire une instance de l'agent de conformité et d'audit. L'enregistrement d'activation avec serving (vrai pour ready et degraded), sector, pack, l'operation et le run courants, validation, last_error et les steps de l'exécution courante dans l'ordre (état, tentatives, détail, journaux, horaires). C'est la route que le runtime de conformité lit au démarrage et à la demande.

Route : /v1/compliance/instances/{instance_id} (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance, le même dans le Control Plane et dans le runtime de conformité.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.getBranding`

getBranding(instanceId: string, opts?: CallOptions)

Lire l'image de marque d'une instance. L'image de marque choisie dans le parcours d'activation, portée par le Control Plane : agent_name, sidebar_color, navbar_color, les couleurs de texte calculées pour elles (sidebar_text_color, navbar_text_color, noir ou blanc, contraste de 4,5:1 ou plus), logo (content_type, sha256, size_bytes, url) ou null, version, updated_at, et app_url (l'URL de l'application web une fois connue). Un champ null signifie la valeur par défaut du runtime. Le runtime de conformité en garde une réplique pour sa page de connexion publique et la réécrit quand version est plus récente. Tout principal du tenant ; l'instance d'un autre tenant répond 404.

Route : /v1/compliance/instances/{instance_id}/branding (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.getLogo`

getLogo(instanceId: string, opts?: CallOptions)

Lire le logo d'une instance. Les octets du logo, lus par le domaine de stockage et contrôlés avec le sha256 enregistré, avec le Content-Type du format validé (image/png ou image/jpeg), X-Content-Type-Options: nosniff, une Content-Security-Policy commençant par default-src 'none' et un ETag. 404 compliance_logo_not_found quand l'instance n'a pas de logo. Tout principal du tenant.

Route : /v1/compliance/instances/{instance_id}/branding/logo (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.health`

health(instanceId: string, opts?: CallOptions)

Route : /v1/compliance/instances/{instance_id}/health (GET).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.list`

list(query?: { status?: string; project?: string; sector?: string; limit?: number }, opts?: CallOptions)

Lister les instances de l'agent de conformité et d'audit. Enregistrements d'activation du tenant, du plus récent au plus ancien, avec statut, secteur, pack, modèle de déploiement, versions et ressources possédées (une page, next_cursor nul). Filtres : status, project, sector.

Route : /v1/compliance/instances (GET).

Nom	Type	Défaut	Requis	Description
`query`	`{ status?: string; project?: string; sector?: string; limit?: number }`		non	Paramètres de la chaîne de requête de la route.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.provision`

provision(instanceId: string, opts?: CallOptions)

Provisionner une instance. Opération longue (202, Operation-Id) : statut provisioning puis starting, étapes de validation à activation exécutées par le worker. Depuis un draft validé (sinon 409 compliance_not_validated) ou après un provisionnement en échec, qui reprend à l'étape en échec. Répété pendant le provisionnement ou une fois prête : changed: false. Audité sous compliance.provision, chaque étape sous compliance.step.

Route : /v1/compliance/instances/{instance_id}/provision (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.restart`

restart(instanceId: string, opts?: CallOptions)

Route : /v1/compliance/instances/{instance_id}/restart (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.restore`

restore(instanceId: string, backupId: string, opts?: CallOptions)

Restaurer une instance (non pris en charge). Répond 501 compliance_backup_not_supported avec les mêmes parts que la sauvegarde : aucune sauvegarde d'instance ne peut encore être faite réellement. Audité.

Route : /v1/compliance/instances/{instance_id}/restore (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`backupId`	`string`	oui	Identifiant de la sauvegarde à restaurer.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.start`

start(instanceId: string, opts?: CallOptions)

Route : /v1/compliance/instances/{instance_id}/start (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.stop`

stop(instanceId: string, opts?: CallOptions)

Arrêter une instance. Opération longue (202) : depuis ready, degraded ou après un démarrage, un redémarrage, une mise à niveau ou un arrêt en échec, étapes deployment (arrêt par le Navin Manager pour une instance dédiée, statut seulement pour une partagée) et activation (application gouvernée suspendue, raison compliance_instance_stopped) ; statut stopped. Déjà en arrêt ou arrêtée : changed: false.

Route : /v1/compliance/instances/{instance_id}/stop (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.updateBranding`

updateBranding(instanceId: string, body: RagAgentBrandingUpdate, opts?: CallOptions)

Modifier l'image de marque d'une instance. Écrit les champs fournis (un champ absent est conservé, null le ramène à la valeur par défaut du runtime) et renvoie l'image de marque. Les couleurs sont au format #RRGGBB (enregistrées en majuscules) ; le texte affiché dessus est noir ou blanc, selon le meilleur contraste (luminance relative WCAG 2.2), et une couleur dont le texte resterait sous 4,5:1 répond 422 compliance_branding_contrast. app_url doit être une URL https sans identifiants (422 compliance_app_url_invalid). Un changement du nom, des couleurs ou du logo incrémente version ; un expected_version différent de la version courante répond 409 compliance_branding_version_conflict. Avec une Idempotency-Key, une nouvelle tentative avec le même corps rejoue la première réponse (Idempotency-Replayed: true), un autre corps répond 409 idempotency_conflict. Demande un administrateur du tenant ou un propriétaire du projet (403 forbidden) ; refusé quand l'instance est deleting ou deleted (409). Audité sous compliance.branding.update.

Route : /v1/compliance/instances/{instance_id}/branding (PUT).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`body`	`RagAgentBrandingUpdate`	oui	Les champs de l'image de marque à écrire.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.upgrade`

upgrade(instanceId: string, version: string, opts?: CallOptions)

Mettre à niveau une instance. Opération longue (202), statut updating : une instance partagée suit le runtime partagé, donc l'étape de déploiement lit la version du runtime dans son document OpenAPI (GET /api/v1/compliance/openapi.json) et vérifie que c'est la version demandée (sinon shared_runtime_version_mismatch) ; une instance dédiée est réinstallée par le Navin Manager. Puis health, smoke, activation ; deployed_version devient la version. La même version déjà déployée ou en cours : changed: false.

Route : /v1/compliance/instances/{instance_id}/upgrade (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`version`	`string`	oui	Version à déployer (lettres, chiffres, `.`, `_`, `+`, `-`, 64 caractères au plus).
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.uploadLogo`

uploadLogo(instanceId: string, input: RagAgentLogoUpload | FormData, opts?: CallOptions)

Téléverser le logo d'une instance. Multipart file (avec les champs texte facultatifs filename et mime_type). PNG ou JPEG uniquement : le SVG et tout autre format sont refusés. La signature réelle, le Content-Type déclaré et l'extension du fichier doivent concorder ; 32 à 1024 pixels de côté, 512 Kio au plus ; sinon 422 compliance_logo_invalid avec details.reason (format_not_allowed, signature_invalid, signature_mismatch, extension_mismatch, dimensions_out_of_bounds, too_large, empty). Le fichier est ensuite analysé par le domaine de sécurité des fichiers, en échec fermé : un fichier bloqué répond 422 file_blocked, un analyseur indisponible 503 file_scan_unavailable. Il est stocké par le domaine de stockage dans le profil de stockage des documents du tenant sous compliance-agent/<tenant>/<instance>/branding/ (409 compliance_branding_storage_required sans un tel profil, 503 compliance_branding_storage_unavailable quand il est injoignable) ; l'objet remplacé est supprimé. Incrémente version et renvoie l'image de marque. Mêmes droits que le PUT ; audité sous compliance.branding.logo.update (un refus est audité comme refus).

Route : /v1/compliance/instances/{instance_id}/branding/logo (POST).

Nom	Type	Requis	Description
`instanceId`	`string`	oui	Identifiant (UUID) de l'instance.
`input`	`RagAgentLogoUpload \| FormData`	oui
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`ComplianceResource.validate`

validate(instanceId: string, opts?: CallOptions)

Valider une instance. Contrôles réels avant le provisionnement : le projet existe et l'appelant peut l'administrer, le modèle de génération existe dans le registre avec la capacité chat et un statut utilisable, le modèle d'embeddings se résout dans la Model Gateway (capacité embeddings), le quota d'instances, Qdrant répond, le runtime partagé répond (modèle partagé) ou le Navin Manager répond (modèle dédié, un service du catalogue non publié est un avertissement). Depuis draft ou après une validation en échec. 200 avec validation et le statut draft ; 422 compliance_validation_failed avec les contrôles en échec (statut failed, étape validation). Audité sous compliance.validate et compliance.validate.completed.

Route : /v1/compliance/instances/{instance_id}/validate (POST).

Nom	Type	Défaut	Requis	Description
`instanceId`	`string`		oui	Identifiant (UUID) de l'instance.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Interface `MemoryEngineDeclare`

Corps de declareEngine : une instance de moteur mem0 ou Cognee du Navin Memory Provider.

Doc

Champs :

Nom	Type	Requis	Description
`id`	`string`	oui	`model_name` LiteLLM, unique dans le profil.
`provider`	`"mem0" \| "cognee"`	oui	Moteur de l'instance : `mem0` ou `cognee`.
`base_url`	`string`	oui	Adresse de l'API rendue par le Navin Manager (https en recette et en production).
`tenant_id`	`string`	non	Locataire de l'agent. `default` par défaut.
`credential_ref`	`string`	non	Référence de l'identifiant dans le magasin de secrets ; l'identifiant lui-même n'est jamais envoyé.
`access_control`	`boolean`	non	Cognee seulement : l'instance tourne avec le contrôle d'accès côté moteur (un utilisateur par tenant donne une séparation `backend`).
`tls_verify`	`boolean`	non	Indique si le certificat TLS du serveur est vérifié. Gardez-le à vrai hors bac à sable.
`timeout_seconds`	`number`	non	Délai maximal d'un appel au moteur, en secondes (300 au plus).
`manager_cluster`	`string`	non	Cluster du Platform Manager qui a installé le moteur.
`manager_service`	`string`	non	Service du Platform Manager correspondant au moteur.

Interface `AgentMemoryWrite`

Corps de remember : un souvenir de l'agent, stocké par le moteur de sa politique.

Doc

Champs :

Nom	Type	Requis	Description
`content`	`string`	oui	Texte du souvenir (20000 caractères au plus).
`scope`	`string`	non	Ce qui est sauvegardé (clusters, services, jeux de données), sous forme d'objet.
`kind`	`"episodic" \| "semantic" \| "procedural" \| "preference" \| "fact"`	non	Type de souvenir : `episodic`, `semantic`, `procedural`, `preference` ou `fact`.
`classification`	`"public" \| "internal" \| "confidential" \| "restricted"`	non	Classification : `public`, `internal`, `confidential` ou `restricted`.
`session_id`	`string`	non	Session du souvenir, pour la portée `session`.
`team`	`string`	non	Équipe du souvenir, pour la portée `team`.
`retention_days`	`number`	non	Nombre de jours pendant lesquels une sauvegarde est conservée avant de pouvoir être supprimée, 1 ou plus.
`legal_hold`	`boolean`	non	Place le souvenir sous conservation légale : il ne peut être ni oublié ni purgé.
`source`	`{ source_type: string; source_id: string; uri?: string; version?: string }`	non	Origine du souvenir : `source_type`, `source_id`, `uri` et `version`.

Interface `AgentMemoryRecall`

Corps de recall et de searchMemories.

Doc

Champs :

Nom	Type	Requis	Description
`query`	`string`	oui	Texte recherché dans les souvenirs de l'agent.
`scopes`	`string[]`	non	Portées demandées ; doivent comprendre `openid`. Par défaut `openid`, `profile`, `email`.
`top_k`	`number`	non	Nombre de souvenirs renvoyés (1 à 50).
`session_id`	`string`	non	Session dont les souvenirs sont recherchés avec la portée `session`.

Classe `RetentionResource`

Conservation. Durée de conservation des données du tenant, leur purge, l'effacement d'une personne concernée (article 17 du RGPD) et les gels juridiques.

Resource

`RetentionResource.createPolicy`

createPolicy(body: Doc, opts?: CallOptions)

Créer ou modifier une politique de conservation. Définit la politique de conservation d'un type de ressource, en remplaçant l'existante. Exige tenant_admin, security_officer ou data_steward. Un type de ressource inconnu ou une action autre que erase ou archive répond 400 invalid_request. La politique s'applique à la passe de conservation suivante. Écrit l'événement d'audit retention.policy.upsert. Répond 201 avec la politique.

Route : /v1/retention/policies (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Type de ressource, durée de vie et action de la politique.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RetentionResource.erase`

erase(body: { subject_id: string } & Doc, opts?: CallOptions)

Effacer une personne concernée. Supprime les données détenues sur une personne, en une transaction. Exige tenant_admin, security_officer ou data_steward.

Route : /v1/retention/erase (POST).

Nom	Type	Défaut	Requis	Description
`body`	`{ subject_id: string } & Doc`		oui	Personne, périmètre et raison de l'effacement.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RetentionResource.legalHold`

legalHold(body: Doc, opts?: CallOptions)

Poser ou lever un gel juridique. Sans hold_id, pose un nouveau gel sur une personne (subject_id) ou sur une ressource (resource_type et resource_id) ; reason est obligatoire (400 invalid_request sinon). Avec hold_id, active ou lève ce gel selon active (404 not_found pour un gel inconnu).

Route : /v1/retention/legal-hold (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Nouveau gel, ou identifiant d'un gel à activer ou lever.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RetentionResource.listPolicies`

listPolicies(params?: ListParams, opts?: CallOptions)

Lister les politiques de conservation. Renvoie les politiques de conservation du tenant triées par type de ressource dans items, et les gels juridiques actifs dans legal_holds. Ouvert à tout membre du tenant. next_cursor vaut toujours null.

Route : /v1/retention/policies (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`RetentionResource.run`

run(body: Doc = {}, opts?: CallOptions)

Lancer les politiques de conservation. Applique maintenant les politiques actives, à tous les types de ressources ou à ceux de resource_types. Les éléments de mémoire et les médias dont l'expiration propre est passée sont purgés même sans politique ; les transcriptions et enregistrements temps réel suivent la durée de conservation du consentement des participants. Les éléments sous gel juridique sont ignorés.

Route : /v1/retention/run (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`	`{}`	non	Indicateur de simulation et types de ressources facultatifs. Un corps vide lance réellement toutes les politiques.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe `LineageResource`

Lignage. Lignage des données du tenant, alimenté par des événements OpenLineage : quels traitements lisent quels jeux de données et en produisent d'autres.

Resource

`LineageResource.dataset`

dataset(id: string, opts?: CallOptions)

Lire le lignage d'un jeu de données. Renvoie le nœud du jeu de données, les traitements qui le produisent (produced_by), ceux qui le consomment (consumed_by) et ses graphes amont et aval jusqu'à depth sauts. Ouvert à tout membre du tenant. Répond 404 not_found pour un jeu de données inconnu.

Route : /v1/lineage/datasets/{dataset_id} (GET).

Nom	Type	Défaut	Requis	Description
`id`	`string`		oui	Clé du jeu de données, `dataset:<namespace>:<name>` ou `<namespace>:<name>` (le préfixe est ajouté), encodée pour l'URL.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`LineageResource.emit`

emit(body: Doc | Doc[], opts?: CallOptions)

Envoyer des événements OpenLineage. Accepte un RunEvent OpenLineage ou {"events": [RunEvent, ...]}, en une transaction. Chaque événement exige run.runId, job.namespace et job.name ; eventType vaut START, RUNNING, COMPLETE, ABORT, FAIL ou OTHER (par défaut ; toute autre valeur répond 400) ; eventTime vaut par défaut l'heure de réception.

Route : /v1/lineage/events (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc \| Doc[]`		oui	Un RunEvent OpenLineage, ou un objet `events` qui en contient une liste.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`LineageResource.graph`

graph(query?: Query, opts?: CallOptions)

Lire le graphe de lignage. Renvoie nodes et edges. Avec node, le graphe est parcouru depuis ce nœud dans la direction direction jusqu'à depth sauts (404 not_found pour un nœud inconnu). Sans node, renvoie jusqu'à limit nœuds de traitements et de jeux de données triés par clé, et les arêtes qui les relient. Une direction autre que both, upstream ou downstream répond 400 invalid_request. Ouvert à tout membre du tenant.

Route : /v1/lineage/graph (GET).

Nom	Type	Défaut	Requis	Description
`query`	`Query`		non	Paramètres de la chaîne de requête de la route.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe `PromptsResource`

Prompts. Registre de prompts : modèles de prompt versionnés avec variables typées et rendu validé.

Resource

`PromptsResource.create`

create(body: Doc, opts?: CallOptions)

Publier une version de prompt. Crée un prompt, ou publie une nouvelle version quand le nom existe ; un modèle et des variables identiques ne sont pas dupliqués (la version courante est renvoyée). Le nom est en minuscules, chiffres, ., _, - (1 à 128 caractères, 400 invalid_request sinon). Un emplacement mal fermé, un type de variable inconnu ou un emplacement non déclaré dans variables répond 422 template_error. Demande tenant_admin ou developer. Audité sous prompt.publish.

Route : /v1/prompts (POST).

Nom	Type	Défaut	Requis	Description
`body`	`Doc`		oui	Nom, modèle, description, variables et indication de modèle.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PromptsResource.list`

list(params?: ListParams, opts?: CallOptions)

Lister les prompts. Prompts du tenant dans l'ordre des noms avec leur dernier numéro de version, paginés avec cursor.

Route : /v1/prompts (GET).

Nom	Type	Défaut	Requis	Description
`params`	`ListParams`		non	Champs supplémentaires fusionnés dans la requête.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PromptsResource.render`

render(name: string, body: { variables?: Doc; version?: string } & Doc, opts?: CallOptions)

Rendre un prompt. Remplit le modèle d'une version (par défaut : la dernière) avec les valeurs données et renvoie text, chars et estimated_tokens (nombre de caractères divisé par 4). Des valeurs obligatoires absentes, de mauvais types, des valeurs hors enum, au-delà de max_length et, avec strict, des variables inconnues répondent 422 missing_variables avec une entrée par problème. 404 not_found pour un prompt ou une version inconnus. Rien n'est enregistré.

Route : /v1/prompts/{name}/render (POST).

Nom	Type	Requis	Description
`name`	`string`	oui	Nom du prompt.
`body`	`{ variables?: Doc; version?: string } & Doc`	oui	Valeurs des variables, version et mode strict.
`opts`	`CallOptions`	non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

`PromptsResource.versions`

versions(name: string, opts?: CallOptions)

Lister les versions d'un prompt. Le prompt et toutes ses versions, de la plus récente à la plus ancienne, avec modèle, variables, indication de modèle, empreinte et auteur. 404 not_found.

Route : /v1/prompts/{name}/versions (GET).

Nom	Type	Défaut	Requis	Description
`name`	`string`		oui	Nom du prompt.
`opts`	`CallOptions`		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe PrivacyResource
- PrivacyResource.classify
- PrivacyResource.detect
- PrivacyResource.detokenize
- PrivacyResource.encrypt
- PrivacyResource.mask
- PrivacyResource.tokenize
Alias de type DlpMode
Classe DlpResource
- DlpResource.createRule
- DlpResource.inspect
- DlpResource.listRules
- DlpResource.redact
Classe TokenizationResource
- TokenizationResource.detokenize
- TokenizationResource.tokenize
Classe EncryptionResource
- EncryptionResource.createKey
- EncryptionResource.decrypt
- EncryptionResource.encrypt
- EncryptionResource.listKeys
- EncryptionResource.rotateKey
Classe KnowledgeBasesResource
- KnowledgeBasesResource.addDocuments
- KnowledgeBasesResource.chunks
- KnowledgeBasesResource.cite
- KnowledgeBasesResource.create
- KnowledgeBasesResource.delete
- KnowledgeBasesResource.deleteDocument
- KnowledgeBasesResource.diagnostics
- KnowledgeBasesResource.documentStatus
- KnowledgeBasesResource.get
- KnowledgeBasesResource.ingestionJob
- KnowledgeBasesResource.list
- KnowledgeBasesResource.listDocuments
- KnowledgeBasesResource.quarantine
- KnowledgeBasesResource.query
- KnowledgeBasesResource.reindex
- KnowledgeBasesResource.reindexJobs
- KnowledgeBasesResource.retrieve
- KnowledgeBasesResource.retryIngestion
- KnowledgeBasesResource.reviewDocument
- KnowledgeBasesResource.search
- KnowledgeBasesResource.setAcl
- KnowledgeBasesResource.setRetrieval
- KnowledgeBasesResource.uploadDocument
- KnowledgeBasesResource.versions
Interface RetrievalStrategy
Interface DocumentUpload
Interface MemoryWrite
Classe MemoryResource
- MemoryResource.addKnowledge
- MemoryResource.agentPolicy
- MemoryResource.agentPolicyVersions
- MemoryResource.buildGraph
- MemoryResource.datasets
- MemoryResource.declareEngine
- MemoryResource.delete
- MemoryResource.deleteDataset
- MemoryResource.deleteEngine
- MemoryResource.deleteEngineCredential
- MemoryResource.engineCapabilities
- MemoryResource.engineHealth
- MemoryResource.engines
- MemoryResource.export
- MemoryResource.forget
- MemoryResource.get
- MemoryResource.list
- MemoryResource.memories
- MemoryResource.memoryItem
- MemoryResource.purge
- MemoryResource.recall
- MemoryResource.relations
- MemoryResource.remember
- MemoryResource.restoreAgentPolicy
- MemoryResource.search
- MemoryResource.searchKnowledge
- MemoryResource.searchMemories
- MemoryResource.setAgentPolicy
- MemoryResource.setEngineCredential
- MemoryResource.updateMemory
- MemoryResource.write
Interface RagAgentInstanceCreate
Classe RagAgentResource
- RagAgentResource.backup
- RagAgentResource.create
- RagAgentResource.delete
- RagAgentResource.deleteLogo
- RagAgentResource.get
- RagAgentResource.getBranding
- RagAgentResource.getLogo
- RagAgentResource.health
- RagAgentResource.list
- RagAgentResource.provision
- RagAgentResource.restart
- RagAgentResource.restore
- RagAgentResource.start
- RagAgentResource.stop
- RagAgentResource.updateBranding
- RagAgentResource.upgrade
- RagAgentResource.uploadLogo
- RagAgentResource.validate
Interface RagAgentBranding
Interface RagAgentBrandingUpdate
Interface RagAgentLogoUpload
Interface ComplianceInstanceCreate
Classe ComplianceResource
- ComplianceResource.backup
- ComplianceResource.create
- ComplianceResource.delete
- ComplianceResource.deleteLogo
- ComplianceResource.get
- ComplianceResource.getBranding
- ComplianceResource.getLogo
- ComplianceResource.health
- ComplianceResource.list
- ComplianceResource.provision
- ComplianceResource.restart
- ComplianceResource.restore
- ComplianceResource.start
- ComplianceResource.stop
- ComplianceResource.updateBranding
- ComplianceResource.upgrade
- ComplianceResource.uploadLogo
- ComplianceResource.validate
Interface MemoryEngineDeclare
Interface AgentMemoryWrite
Interface AgentMemoryRecall
Classe RetentionResource
- RetentionResource.createPolicy
- RetentionResource.erase
- RetentionResource.legalHold
- RetentionResource.listPolicies
- RetentionResource.run
Classe LineageResource
- LineageResource.dataset
- LineageResource.emit
- LineageResource.graph
Classe PromptsResource
- PromptsResource.create
- PromptsResource.list
- PromptsResource.render
- PromptsResource.versions

Classe PrivacyResource​

PrivacyResource.classify​

PrivacyResource.detect​

PrivacyResource.detokenize​

PrivacyResource.encrypt​

PrivacyResource.mask​

PrivacyResource.tokenize​

Alias de type DlpMode​

Classe DlpResource​

DlpResource.createRule​

DlpResource.inspect​

DlpResource.listRules​

DlpResource.redact​

Classe TokenizationResource​

TokenizationResource.detokenize​

TokenizationResource.tokenize​

Classe EncryptionResource​

EncryptionResource.createKey​

EncryptionResource.decrypt​

EncryptionResource.encrypt​

EncryptionResource.listKeys​

EncryptionResource.rotateKey​

Classe KnowledgeBasesResource​

KnowledgeBasesResource.addDocuments​

KnowledgeBasesResource.chunks​

KnowledgeBasesResource.cite​

KnowledgeBasesResource.create​

KnowledgeBasesResource.delete​

KnowledgeBasesResource.deleteDocument​

KnowledgeBasesResource.diagnostics​

KnowledgeBasesResource.documentStatus​

KnowledgeBasesResource.get​

KnowledgeBasesResource.ingestionJob​

KnowledgeBasesResource.list​

KnowledgeBasesResource.listDocuments​

KnowledgeBasesResource.quarantine​

KnowledgeBasesResource.query​

KnowledgeBasesResource.reindex​

KnowledgeBasesResource.reindexJobs​

KnowledgeBasesResource.retrieve​

KnowledgeBasesResource.retryIngestion​

KnowledgeBasesResource.reviewDocument​

KnowledgeBasesResource.search​

KnowledgeBasesResource.setAcl​

KnowledgeBasesResource.setRetrieval​

KnowledgeBasesResource.uploadDocument​

KnowledgeBasesResource.versions​

Interface RetrievalStrategy​

Interface DocumentUpload​

Interface MemoryWrite​

Classe MemoryResource​

MemoryResource.addKnowledge​

MemoryResource.agentPolicy​

MemoryResource.agentPolicyVersions​

MemoryResource.buildGraph​

MemoryResource.datasets​

MemoryResource.declareEngine​

MemoryResource.delete​

MemoryResource.deleteDataset​

MemoryResource.deleteEngine​

MemoryResource.deleteEngineCredential​

MemoryResource.engineCapabilities​

MemoryResource.engineHealth​

MemoryResource.engines​

MemoryResource.export​

MemoryResource.forget​

MemoryResource.get​

MemoryResource.list​

MemoryResource.memories​

MemoryResource.memoryItem​

MemoryResource.purge​

MemoryResource.recall​

MemoryResource.relations​

MemoryResource.remember​

MemoryResource.restoreAgentPolicy​

MemoryResource.search​

MemoryResource.searchKnowledge​

MemoryResource.searchMemories​

MemoryResource.setAgentPolicy​

MemoryResource.setEngineCredential​

Classe `PrivacyResource`

`PrivacyResource.classify`

`PrivacyResource.detect`

`PrivacyResource.detokenize`

`PrivacyResource.encrypt`

`PrivacyResource.mask`

`PrivacyResource.tokenize`

Alias de type `DlpMode`

Classe `DlpResource`

`DlpResource.createRule`

`DlpResource.inspect`

`DlpResource.listRules`

`DlpResource.redact`

Classe `TokenizationResource`

`TokenizationResource.detokenize`

`TokenizationResource.tokenize`

Classe `EncryptionResource`

`EncryptionResource.createKey`

`EncryptionResource.decrypt`

`EncryptionResource.encrypt`

`EncryptionResource.listKeys`

`EncryptionResource.rotateKey`

Classe `KnowledgeBasesResource`

`KnowledgeBasesResource.addDocuments`

`KnowledgeBasesResource.chunks`

`KnowledgeBasesResource.cite`

`KnowledgeBasesResource.create`

`KnowledgeBasesResource.delete`

`KnowledgeBasesResource.deleteDocument`

`KnowledgeBasesResource.diagnostics`

`KnowledgeBasesResource.documentStatus`

`KnowledgeBasesResource.get`

`KnowledgeBasesResource.ingestionJob`

`KnowledgeBasesResource.list`

`KnowledgeBasesResource.listDocuments`

`KnowledgeBasesResource.quarantine`

`KnowledgeBasesResource.query`

`KnowledgeBasesResource.reindex`

`KnowledgeBasesResource.reindexJobs`

`KnowledgeBasesResource.retrieve`

`KnowledgeBasesResource.retryIngestion`

`KnowledgeBasesResource.reviewDocument`

`KnowledgeBasesResource.search`

`KnowledgeBasesResource.setAcl`

`KnowledgeBasesResource.setRetrieval`

`KnowledgeBasesResource.uploadDocument`

`KnowledgeBasesResource.versions`

Interface `RetrievalStrategy`

Interface `DocumentUpload`

Interface `MemoryWrite`

Classe `MemoryResource`

`MemoryResource.addKnowledge`

`MemoryResource.agentPolicy`

`MemoryResource.agentPolicyVersions`

`MemoryResource.buildGraph`

`MemoryResource.datasets`

`MemoryResource.declareEngine`

`MemoryResource.delete`

`MemoryResource.deleteDataset`

`MemoryResource.deleteEngine`

`MemoryResource.deleteEngineCredential`

`MemoryResource.engineCapabilities`

`MemoryResource.engineHealth`

`MemoryResource.engines`

`MemoryResource.export`

`MemoryResource.forget`

`MemoryResource.get`

`MemoryResource.list`

`MemoryResource.memories`

`MemoryResource.memoryItem`

`MemoryResource.purge`

`MemoryResource.recall`

`MemoryResource.relations`

`MemoryResource.remember`

`MemoryResource.restoreAgentPolicy`

`MemoryResource.search`

`MemoryResource.searchKnowledge`

`MemoryResource.searchMemories`

`MemoryResource.setAgentPolicy`

`MemoryResource.setEngineCredential`