Aller au contenu principal

SDK TypeScript

En bref​

Le SDK TypeScript permet d'integrer Ontologie dans vos applications de maniere programmatique et type-safe. Accedez a l'ensemble de la plateforme — ontologie, agents, knowledge, workflows, calendrier, dashboards, gouvernance, spreadsheets — avec un typage complet genere depuis votre modele.

Inspire du pattern OSDK : requetes lazy, types generes, subscriptions temps reel.

Ce que vous allez faire​

  • Installer le SDK et generer les types depuis votre ontologie
  • Interroger et manipuler vos entites avec un builder type-safe
  • Recevoir des mises a jour en temps reel via WebSocket
  • Integrer l'agent IA, la knowledge base et les workflows dans vos apps
  • Construire des interfaces React avec les hooks fournis

Packages​

Le SDK est compose de 6 packages :

PackageDescription
@ontologie/sdk-typesTypes runtime purs — interfaces, erreurs, streaming. Zero dependance.
@ontologie/sdk-clientClient HTTP + WebSocket — createClient(), ObjectSet, CRUD, namespaces.
@ontologie/cliCLI et generateur — genere les types TypeScript depuis le manifeste de l'ontologie.
@ontologie/reactHooks React bases sur TanStack Query — useObjectSet, useAgent, etc.
@ontologie/oauthOAuth2 PKCE — authentification browser-safe sans client secret.
ontologie (pip)Client Python — models Pydantic + client httpx.

Dependances entre packages​

@ontologie/sdk-types          (zero deps)
       ^
       |
@ontologie/sdk-client          (depends on sdk-types)
       ^
       |  peer dep
@ontologie/react               (peer deps: react, @tanstack/react-query, sdk-client)

@ontologie/oauth               (standalone)
@ontologie/cli                 (standalone)
ontologie (pip)                (standalone)

Exemple rapide​

import { createClient } from '@ontologie/sdk-client';

const client = createClient({
  baseUrl: 'https://api.ontologie-growthsystemes.com',
  apiKey: process.env.ONTOLOGIE_API_KEY,
  workspaceId: 'votre-workspace-id',
});

// Lister les entites
const entities = await client.ontology.nodes.list();

// Recherche semantique
const results = await client.knowledge.search('fournisseurs actifs');

Documentation complete​

Portail Client
La documentation complete du SDK (quickstart, client, requetes, hooks React, Python, temps reel) est disponible sur le Portail Client.

Contactez votre interlocuteur commercial ou ecrivez a support@growthsystemes.com pour obtenir vos identifiants d'acces.

Compatibilite​

EnvironnementRequis
Node.js>= 18
NavigateurTous (fetch natif requis)
TypeScript>= 5.0 (recommande)
React>= 18 (pour @ontologie/react)
Python>= 3.9 (pour le SDK Python)

Limites​

  • Le SDK est en preview : certaines interfaces peuvent evoluer entre les versions mineures.
  • Le streaming temps reel (WebSocket) n'est pas encore disponible pour toutes les ressources.
  • Le SDK Python est un generateur de client — il ne couvre pas encore toutes les fonctionnalites du SDK TypeScript.
  • La documentation complete est accessible uniquement via le Portail Client.

Resultat attendu​

A la fin de ce parcours, vous disposerez d'un SDK type-safe connecte a votre ontologie, avec des types generes automatiquement, des requetes fluides et des mises a jour temps reel. Vos applications pourront lire, ecrire et reagir aux changements de donnees de maniere programmatique.

Besoin d'aide ?​

Ecrivez-nous : Support et contact.