enterprise_ai.loop.plan

Source : sdks/python/src/enterprise_ai/loop/plan.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.

Modèle PlanStep

Une étape d'un RunPlan : identifiant, titre, dépendances, statut et preuve.

Champs :

Nom	Type	Requis	Description
id	str	oui	Identifiant de l'étape, unique dans le plan.
title	str	oui	Titre court et lisible de l'étape.
depends_on	list[str]	non	Identifiants des étapes qui doivent être done avant que celle-ci puisse démarrer ; vide par défaut.
status	str	non	État de l'étape : pending (par défaut), in_progress, done ou skipped.
evidence	str | None	non	Preuves des mesures (journaux, horodatages, références de captures...).

Classe RunPlan

Étapes de plan ordonnées avec leurs dépendances.

Attributs :

Nom	Type	Requis	Description
client		oui	Client Enterprise AI utilisé pour refléter le plan en étapes d'exécution, ou None.
current	PlanStep | None	oui	L'étape au statut in_progress, ou None.
done	bool	oui	True lorsque toutes les étapes du plan sont done.
run_id		oui	Identifiant de l'exécution vers laquelle le plan est reflété, ou None.
steps	dict[str, PlanStep]	oui	Étapes du plan par identifiant (un dictionnaire de PlanStep), dans l'ordre d'insertion.

Constructeur RunPlan

RunPlan(steps: list[PlanStep | dict[str, Any]] | None = None, client: Any = None, run_id: str | None = None) -> None

Charge les étapes, puis démarre la première prête ; chaque changement est reflété comme une étape d'exécution de type plan si client et run_id sont fournis.

Nom	Type	Défaut	Requis	Description
steps	list[PlanStep | dict[str, Any]] | None	None	non	Étapes initiales, sous forme d'objets PlanStep ou de dictionnaires avec id, title et depends_on, dans l'ordre.
client	Any	None	non	Client parent.
run_id	str | None	None	non	Identifiant de l'exécution vers laquelle les étapes sont reflétées via client.runs.add_step ; None garde le plan local.

RunPlan.add

add(id: str, title: str, depends_on: list[str] | None = None, **_: Any) -> PlanStep

Ajoute une étape en attente au plan, en remplaçant toute étape de même identifiant ; ne la démarre pas.

Nom	Type	Défaut	Requis	Description
id	str		oui	Identifiant de la nouvelle étape.
title	str		oui	Titre court et lisible de l'étape.
depends_on	list[str] | None	None	non	Identifiants des étapes à terminer d'abord ; None signifie aucune dépendance.
**_	Any		non	Autres clés d'un dictionnaire d'étape, ignorées.

Retour : PlanStep. La nouvelle PlanStep, au statut pending.

RunPlan.advance

advance() -> PlanStep | None

Démarre l'étape prête suivante lorsqu'aucune n'est en cours.

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

Retour : PlanStep \| None. L'étape en cours (déjà lancée ou tout juste démarrée), ou None si aucune étape n'est prête.

RunPlan.complete

complete(step_id: str, evidence: str) -> PlanStep | None

Marque step_id comme terminée avec sa preuve et renvoie l'étape démarrée ensuite.

Nom	Type	Défaut	Requis	Description
step_id	str		oui	Identifiant de l'étape à terminer ; un identifiant inconnu lève KeyError.
evidence	str		oui	Preuve que l'étape est terminée, enregistrée sur l'étape et envoyée comme output_ref ; une valeur vide lève ValueError.

Retour : PlanStep \| None. L'étape démarrée ensuite, ou None si aucune étape n'est prête.

Erreurs levées : ValueError.

RunPlan.ready

ready() -> list[PlanStep]

Étapes en attente dont toutes les dépendances sont terminées.

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

Retour : list[PlanStep]. Liste des PlanStep prêtes, dans l'ordre d'insertion ; les dépendances inconnues sont ignorées.