enterprise_ai.core.system

Source : sdks/python/src/enterprise_ai/_core/system.py. Retour à l'index de la référence du SDK Python.

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 SystemClient

Points d'accès en lecture au niveau de la plateforme (aucune donnée de tenant).

Resource

SystemClient.brick

brick(brick_id: str) -> Any

Lire une brique de la plateforme. Une brique du catalogue, retrouvée par son id sans tenir compte de la casse. Répond 404 not_found si aucune brique ne porte cet identifiant. Sans authentification.

Route : /v1/catalog/bricks/{brick_id} (GET).

Nom	Type	Défaut	Requis	Description
brick_id	str		oui	Identifiant de la brique dans le catalogue, insensible à la casse.

Retour : Any. Réponse JSON décodée de l'opération « Lire une brique de la plateforme ».

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

SystemClient.bricks

bricks() -> Any

Lister les briques de la plateforme. Catalogue des briques de la plateforme lu dans bricks.yaml du dossier de catalogue, en une seule page (next_cursor vaut toujours null). Le fichier est chargé en YAML sûr (sans ancres ni alias, 2 Mo au plus). Sans authentification.

Route : /v1/catalog/bricks (GET).

Cet élément ne prend aucun paramètre.

Retour : Any. Réponse JSON décodée de l'opération « Lister les briques de la plateforme ».

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

SystemClient.healthz

healthz() -> Any

Vérifier que le processus est vivant. Sonde de vie : répond toujours 200 avec status: ok et la version du Control Plane tant que le processus sert des requêtes. Elle ne vérifie aucune dépendance. Sans authentification ni limitation de débit.

Route : /healthz (GET).

Cet élément ne prend aucun paramètre.

Retour : Any. Réponse JSON décodée de l'opération « Vérifier que le processus est vivant ».

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

SystemClient.meta

meta() -> Any

Décrire l'instance du Control Plane. Nom, version et version d'API de l'instance, langues prises en charge et langue par défaut, domaines chargés, et fonctions activées par la configuration : authentification OIDC, par clé d'API, SPIFFE et de développement, OpenBao, OpenFGA, OPA et LiteLLM (vrai quand leur adresse est renseignée). Sans authentification.

Route : /v1/meta (GET).

Cet élément ne prend aucun paramètre.

Retour : Any. Réponse JSON décodée de l'opération « Décrire l'instance du Control Plane ».

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

SystemClient.metrics

metrics() -> Any

GET /metrics : format texte Prometheus (une coroutine sur le client asynchrone).

Cet élément ne prend aucun paramètre.

Retour : Any. Métriques au format texte d'exposition Prometheus (str, vide si le corps est vide).

SystemClient.operation

operation(operation_id: str) -> Any

Suivre une opération longue. L'opération (type, état pending ou accepted, méthode, chemin, statut HTTP, clé d'idempotence, ressource suivie, créateur et dates), sa réponse acceptée et l'état en direct de la ressource suivie. La ressource est lue avec les identifiants de l'appelant par la route de la ressource, donc l'autorisation de la ressource s'applique : si cette lecture échoue, result reste null et result_error.http_status donne le statut. status vaut pending pendant l'exécution de la requête, puis le status ou le state de la ressource. Demande un principal de tenant (403 tenant_required) ; une opération créée par quelqu'un d'autre répond 404 not_found sauf si l'appelant détient tenant_admin, platform_admin, auditor ou security_officer.

Route : /v1/operations/{operation_id} (GET).

Nom	Type	Défaut	Requis	Description
operation_id	str		oui	Identifiant de l'opération, tel que renvoyé dans l'en-tête Operation-Id.

Retour : Any. Réponse JSON décodée de l'opération « Suivre une opération longue ».

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

SystemClient.readyz

readyz() -> Any

Vérifier que l'instance est prête. Sonde de disponibilité : vérifie que la base de données répond et que les migrations du schéma ont été appliquées. Répond 200 ready quand chaque contrôle réussit, sinon 503 not_ready, avec le résultat de chaque contrôle et un message dans la langue de la requête. L'état du cache Redis est indiqué mais ne rend jamais l'instance indisponible. Sans authentification ni limitation de débit.

Route : /readyz (GET).

Cet élément ne prend aucun paramètre.

Retour : Any. Réponse JSON décodée de l'opération « Vérifier que l'instance est prête ».

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

SystemClient.roadmap

roadmap() -> Any

Lire la feuille de route du produit. Feuille de route lue dans roadmap.yaml du dossier de catalogue, toujours avec une liste phases (vide si le fichier est absent). Chargée en YAML sûr. Sans authentification.

Route : /v1/roadmap (GET).

Cet élément ne prend aucun paramètre.

Retour : Any. Réponse JSON décodée de l'opération « Lire la feuille de route du produit ».

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