client.ts

Source : sdks/typescript/packages/sdk/src/client.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.

Alias de type EnterpriseAIOptions

Options du constructeur d'EnterpriseAI, identiques aux ClientOptions du client HTTP.

Définition : ClientOptions.

Classe EnterpriseAI

Client de l'API Control Plane v1 d'Enterprise AI. Un sous-client par ressource de l'API.

Attributs :

Nom	Type	Requis	Description
a2a	A.A2AResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
adapters	L.AdaptersResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
agents	A.AgentsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
apiKeys	I.ApiKeysResource	oui	Identité. Qui appelle l'API et avec quels droits. Ce tag couvre l'identité de l'appelant (whoami), les clés d'API des scripts et des services, les identités de service (charges de travail SPIFFE) qu'un utilisateur peut endosser temporairement, et les correspondances de groupes de l'annuaire qui transforment les groupes Keycloak en appartenances à des projets et en quotas.
applications	Tr.ApplicationsResource	oui	Applications gouvernées et agents tiers.
approvals	I.ApprovalsResource	oui	Validations. Humain dans la boucle : demandes de validation des actions sensibles, avec séparation des tâches, quorum et expiration. Les exécutions d'agents qui atteignent un outil soumis à validation, les promotions de modèles, d'agents, d'outils, de compétences, de serveurs MCP ou de plugins, les accès d'urgence et les mandats créent tous leurs demandes de validation ici.
audit	M.AuditResource	oui	Événements d'audit (/v1/audit) : liste, vérification de la chaîne de hachage, export WORM et corrélations.
authz	I.AuthzResource	oui	Vérifications et tuples OpenFGA et décisions OPA expliquées ; une réponse sans décision explicite lève AuthzUnconfirmedError.
breakGlass	Tr.BreakGlassResource	oui	Délégation, mandats et accès d'urgence. Comment un agent, une application ou un sous-agent agit pour le compte de quelqu'un, et comment des droits exceptionnels sont accordés.
businessUnits	I.BusinessUnitsResource	oui	Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.
catalog	I.CatalogResource	oui	Système. Points techniques du Control Plane : sondes de vie et de disponibilité, description de l'instance, identité de l'appelant, catalogue des briques de la plateforme et feuille de route du produit.
channels	T.ChannelsResource	oui	Canaux. Channel Gateway : les points d'entrée où les utilisateurs finaux parlent aux agents (web, mobile, e-mail, Slack, Teams, WhatsApp, SMS, voix, API, et les canaux Navin Discord, Telegram, Matrix, Mattermost et Signal). Un message entrant devient un message de session et lance un run de l'agent du canal, dans des limites de taille, de débit et de sessions et avec DLP.
checkpoints	A.CheckpointsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
compliance	D.ComplianceResource	oui	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}.
connectors	T.ConnectorsResource	oui	Connecteurs. Connector Hub : registre des connexions aux systèmes externes (applications SaaS, API, sources de données), leurs identifiants conservés côté serveur, les exécutions de synchronisation, le Credential Broker qui remet des baux de courte durée à la place des secrets, et la Webhook Gateway qui reçoit les événements signés des fournisseurs.
context	L.ContextResource	oui	Plan du Context Manager et jetons de contexte d'exécution signés (/v1/context).
contracts	I.ContractsResource	oui	Contrats et manifestes. Schémas JSON publiés (contrats) des documents de la plateforme, et manifestes déclaratifs qui créent ou mettent à jour des objets à partir d'un document, dans l'esprit de l'infrastructure as code.
credentials	T.CredentialsResource	oui	Connecteurs. Connector Hub : registre des connexions aux systèmes externes (applications SaaS, API, sources de données), leurs identifiants conservés côté serveur, les exécutions de synchronisation, le Credential Broker qui remet des baux de courte durée à la place des secrets, et la Webhook Gateway qui reçoit les événements signés des fournisseurs.
delegations	Tr.DelegationsResource	oui	Délégation, mandats et accès d'urgence. Comment un agent, une application ou un sous-agent agit pour le compte de quelqu'un, et comment des droits exceptionnels sont accordés.
dlp	D.DlpResource	oui	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.
encryption	D.EncryptionResource	oui	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.
evaluations	M.EvaluationsResource	oui	Évaluation et red team. Qualité des systèmes d'IA du tenant : suites d'évaluation, exécutions, barrières de qualité avant promotion, comparaisons A/B avec une référence et campagnes de red team.
events	A.EventsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
evidence	P.EvidenceResource	oui	Preuves. Couche de preuve du journal d'audit : sceaux signés, paquets vérifiables hors ligne, moniteur d'intégrité, Audit Gateway, charges utiles chiffrées, accès audités, gels juridiques et preuves de purge, et configuration d'exécution des exécutions d'agents.
fileSecurity	T.FileSecurityResource	oui	Sécurité des fichiers. Contrôles antivirus et de contenu de chaque fichier qui entre dans la plateforme, avant qu'un analyseur, un modèle ou un magasin ne le voie.
finops	F.FinOpsResource	oui	FinOps. Gestion des coûts de l'usage de l'IA : grilles tarifaires, événements d'usage, estimations, quotas et réservations, répartition du coût des GPU, rapprochement de la facturation et alertes.
gateway	L.GatewayResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
governance	I.GovernanceResource	oui	Gouvernance. Registre de gouvernance : une vue agrégée des actifs d'IA du tenant, pour savoir ce qui existe, qui en est responsable et quel est son niveau de risque.
heartbeats	A.HeartbeatsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
http	HttpClient	oui	Transport HTTP partagé par tous les sous-clients.
incidents	I.IncidentsResource	oui	Incidents. Incidents de sécurité et d'exploitation du tenant : gravité, statut, chronologie, actions de confinement, alertes Alertmanager et transmission au SIEM.
isolation	L.IsolationResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
knowledgeBases	D.KnowledgeBasesResource	oui	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.
license	Tr.LicenseResource	oui	Licences. Licence de l'installation : activation d'une licence signée, état courant et historique.
lineage	D.LineageResource	oui	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.
litellm	L.LiteLLMResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
llm	L.LlmResource	oui	Interface llm unique : génération, flux, embeddings et vision, tous soumis aux contrôles du Model Gateway.
llmManagement	LlmManagementResource	oui	Gestion des LLM. Projets LLM d'un tenant, leur quota et les clés virtuelles LiteLLM que les applications utilisent pour appeler les modèles.
mandates	Tr.MandatesResource	oui	Mandats : autorité permanente d'un agent autonome, accordée par une approbation.
manifests	I.ManifestsResource	oui	Contrats et manifestes. Schémas JSON publiés (contrats) des documents de la plateforme, et manifestes déclaratifs qui créent ou mettent à jour des objets à partir d'un document, dans l'esprit de l'infrastructure as code.
marketplace	P.MarketplaceResource	oui	Marketplace. Catalogue de packs signés (ensembles d'agents, sous-agents, skills, outils, connecteurs, serveurs MCP et ressources), leurs contrôles de publication, le contrôle de mise en production, les éditeurs de confiance, les installations par environnement et le circuit de gestion des changements.
mcp	T.McpResource	oui	Passerelle MCP. Registre des serveurs MCP amont (Model Context Protocol) et MCP Gateway, un proxy JSON-RPC 2.0 qui applique les contrôles de la plateforme à chaque appel : isolation par projet, appelants permis, listes d'autorisation d'outils et de ressources, scopes, DLP, politique, quota, contrôle d'injection de prompt, comptage et audit.
mcpRuntime	T.McpRuntimeResource	oui	Runtime MCP. MCP Runtime : des instances isolées de serveur MCP démarrées à la demande pour un utilisateur d'un projet, à partir des modèles du catalogue de la plateforme, exécutées par ToolHive dans l'espace de noms du projet et joignables via la MCP Gateway.
me	I.MeResource	oui	Appelant connecté : /v1/me, whoami, connexion d'un compte local, changement de mot de passe et déconnexion.
media	M.MediaResource	oui	Multimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
members	I.MembersResource	oui	Membres du tenant, profils de quota et correspondances de groupes d'annuaire.
memory	D.MemoryResource	oui	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.
meta	I.MetaResource	oui	Système. Points techniques du Control Plane : sondes de vie et de disponibilité, description de l'instance, identité de l'appelant, catalogue des briques de la plateforme et feuille de route du produit.
models	L.ModelsResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
multimodal	M.MultimodalResource	oui	Multimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
navinLibrary	T.NavinLibraryResource	oui	Bibliothèque Navin. La bibliothèque Navin est le catalogue embarqué de skills, plugins, commandes, agents, presets MCP et canaux prêts à l'emploi. Un projet active ce dont il a besoin, installe des serveurs MCP et des canaux à partir de presets et garde ses propres règles, les instructions durables que reçoit chaque run du projet.
operations	I.OperationsResource	oui	Opérations. Opérations longues : un operation_id durable pour chaque création longue, pour la suivre et la relancer sans risque.
organizations	I.OrganizationsResource	oui	Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.
platformManager	P.PlatformManagerResource	oui	Platform Manager. Espace Platform Manager de la console : la passerelle du Control Plane vers le Navin Manager, qui installe, connecte et exploite les services de la plateforme sur les machines du client, ainsi que le coffre-fort informatique des administrateurs de la plateforme.
plugins	T.PluginsResource	oui	Plugins. Registre et cycle de vie d'exécution des plugins : des images OCI signées exécutées par la plateforme dans une sandbox (classe de runtime gVisor, Kata ou Wasm), avec un Deployment et une NetworkPolicy Kubernetes générés à partir du manifeste.
policies	I.PoliciesResource	oui	Politiques. Politiques fondées sur les attributs (ABAC) qui décident de chaque action sensible de la plateforme, avec le Policy Contract v1, le journal des décisions, la simulation, les révisions et les bundles OPA signés.
privacy	D.PrivacyResource	oui	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.
projects	I.ProjectsResource	oui	Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.
prompts	D.PromptsResource	oui	Prompts. Registre de prompts : modèles de prompt versionnés avec variables typées et rendu validé.
providers	L.ProvidersResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
quotas	F.QuotasResource	oui	FinOps. Gestion des coûts de l'usage de l'IA : grilles tarifaires, événements d'usage, estimations, quotas et réservations, répartition du coût des GPU, rapprochement de la facturation et alertes.
ragAgent	D.RagAgentResource	oui	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).
realtime	M.RealtimeResource	oui	Voix en temps réel. Sessions de voix en temps réel : un jeton de salle LiveKit et un protocole d'événements WebSocket pour diffuser de l'audio vers un agent, avec consentement des participants, tours de parole, transcriptions filtrées par la DLP, enregistrements facultatifs et comptage d'usage.
redteam	M.RedteamResource	oui	Évaluation et red team. Qualité des systèmes d'IA du tenant : suites d'évaluation, exécutions, barrières de qualité avant promotion, comparaisons A/B avec une référence et campagnes de red team.
retention	D.RetentionResource	oui	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.
risk	I.RiskResource	oui	Risques et conformité. Gestion des risques des systèmes d'IA du tenant : évaluations au titre de l'AI Act européen, contrôles rattachés à l'ISO/IEC 42001, au NIST AI RMF, au RGPD et à l'AI Act, preuves et dérogations limitées dans le temps.
roadmap	I.RoadmapResource	oui	Système. Points techniques du Control Plane : sondes de vie et de disponibilité, description de l'instance, identité de l'appelant, catalogue des briques de la plateforme et feuille de route du produit.
routes	L.RoutesResource	oui	LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.
runs	A.RunsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
sandbox	A.SandboxResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
schedules	A.SchedulesResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
secrets	I.SecretsResource	oui	Secrets. Magasin en écriture seule des secrets du tenant : clés de fournisseurs, mots de passe de connecteurs, jetons de serveurs MCP. Les valeurs sont chiffrées (dans OpenBao quand il est configuré, sinon en AES-GCM dans la base) et ne sont jamais renvoyées par l'API. Les autres objets désignent un secret par son chemin ; la plateforme ne lit la valeur côté serveur que lorsqu'elle en a besoin.
security	I.SecurityResource	oui	Posture et réglages de sécurité, signalement d'incident et confinement d'un run.
serviceIdentities	I.ServiceIdentitiesResource	oui	Identité. Qui appelle l'API et avec quels droits. Ce tag couvre l'identité de l'appelant (whoami), les clés d'API des scripts et des services, les identités de service (charges de travail SPIFFE) qu'un utilisateur peut endosser temporairement, et les correspondances de groupes de l'annuaire qui transforment les groupes Keycloak en appartenances à des projets et en quotas.
sessions	A.SessionsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
skills	T.SkillsResource	oui	Skills. Skill Registry et Skill Loader. Un skill est un ensemble d'instructions signé et versionné (en ligne, ou artefact Git ou OCI) avec les permissions dont il a besoin ; les agents chargent les skills accordés dans leur manifeste.
soc	S.SocResource	oui	SOC et réponse aux incidents IA. Opérations de sécurité pour l'IA (AI-SDR) : détections, ordres de confinement typés, registre des coupe-circuits (Kill Switch Registry), accusés de confinement, rétablissement à quatre yeux, preuves scellées des incidents et rapprochement des transactions à effet de bord.
storageProfiles	P.StorageProfilesResource	oui	Stockage. Profils de stockage : les buckets et conteneurs du client dans lesquels la plateforme écrit (exports d'audit, preuves, documents, médias, exports, sauvegardes), avec leur référence d'identifiants et leurs capacités découvertes par de vrais appels.
subagents	A.SubagentsResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
telemetry	M.TelemetryResource	oui	Télémétrie. Traces, journal des requêtes, flux en direct et objectifs de niveau de service (SLO) de la plateforme.
telephony	TelephonyResource	oui	Téléphonie. Téléphonie (ADR-0173) : PBX d'entreprise, bord SIP et agents vocaux IA du tenant. Navin Enterprise garde les données (trunks, extensions, numéros, règles de routage, flux SVI, files, agents humains et IA, conférences, quotas), compile les fichiers gérés d'Asterisk, les tables de routage Kamailio et les objets LiveKit SIP par pool PBX, et les publie vers les moteurs par AMI, JSONRPC et Twirp avec versions et retour arrière ; il n'exécute jamais de commande système. Le Navin Manager installe et exploite les moteurs.
tenants	I.TenantsResource	oui	Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.
tokenization	D.TokenizationResource	oui	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.
tools	T.ToolsResource	oui	Registre des outils et invocation par la Tool Gateway (/v1/tools).
triggers	A.TriggersResource	oui	Agents. Registre des agents du tenant et exécution côté serveur de leurs runs : étapes, budgets, points de reprise, heartbeats, sous-agents, messages d'agent à agent (A2A), sessions de conversation, planifications cron, déclencheurs sur événement et exécutions en sandbox.
webhooks	T.WebhooksResource	oui	Connecteurs. Connector Hub : registre des connexions aux systèmes externes (applications SaaS, API, sources de données), leurs identifiants conservés côté serveur, les exécutions de synchronisation, le Credential Broker qui remet des baux de courte durée à la place des secrets, et la Webhook Gateway qui reçoit les événements signés des fournisseurs.

Constructeur EnterpriseAI

new EnterpriseAI(options: EnterpriseAIOptions)

Crée le HttpClient à partir des options et, par-dessus, un sous-client par ressource de l'API.

Nom	Type	Défaut	Requis	Description
options	EnterpriseAIOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).