enterprise_ai.agent
Source : sdks/python/src/enterprise_ai/agent/__init__.py. Retour à l'index de la référence du SDK Python.
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 Agent
Agent défini par son manifeste, avec des outils locaux enregistrés par décorateur.
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
client | oui | Client Enterprise AI passé au constructeur (passerelle, outils, runs), ou None pour un agent purement local. | |
last_loop | AgentLoop | None | oui | Dernière AgentLoop construite par build_loop, ou None avant le premier run. |
manifest | oui | Agent Manifest à partir duquel l'agent a été construit, sous forme de dict. | |
metadata | oui | Paires clé-valeur libres enregistrées avec l'objet et renvoyées telles quelles ; la plateforme ne les interprète jamais. | |
name | str | oui | Nom de l'agent, tiré de metadata.name (agent par défaut) ; sert d'agent_id auprès du serveur. |
primary_model | dict[str, Any] | oui | Entrée de spec.models dont le role vaut primary, sinon la première entrée (dict vide si aucun modèle n'est déclaré). |
spec | oui | Section spec du manifeste (modèles, outils, autonomie, budgets). | |
subagents | oui | Gestionnaire de sous-agents construit à partir du manifeste, branché sur le runner de chaque tour. | |
system | oui | Prompt système de l'agent : l'argument system, sinon le spec.description du manifeste. | |
tools | dict[str, LocalTool] | oui | Outils locaux enregistrés avec tool, par nom. |
Constructeur Agent
Agent(manifest: dict[str, Any], client: Any = None, model_call: ModelCall | None = None, validate_manifest: bool = True, system: str | None = None) -> None
Crée l'agent à partir d'un manifeste (dict), validé avec le schéma agent-manifest sauf si validate_manifest est faux.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
manifest | dict[str, Any] | oui | Agent Manifest sous forme de dict (metadata, spec). | |
client | Any | None | non | Client parent. |
model_call | ModelCall | None | None | non | Fonction (messages, tools) -> dict qui appelle le modèle ; par défaut, l'agent appelle la passerelle avec le modèle du manifeste (default_model_call). |
validate_manifest | bool | True | non | Valide le manifeste avec le schéma agent-manifest et lève une erreur en cas d'écart (True par défaut). |
system | str | None | None | non | Prompt système de l'agent ; par défaut, le spec.description du manifeste. |
Agent.apply
apply() -> Any
Envoie le manifeste en POST à /v1/manifests/apply.
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse de client.manifests.apply pour le manifeste ; lève ValueError si l'agent n'a pas de client.
Erreurs levées : ValueError.
Agent.approval_patterns
approval_patterns() -> list[str]
Actions qui demandent une approbation humaine : les motifs de spec.autonomy.human_approval_for plus tool:<nom> pour chaque outil du manifeste marqué requires_approval.
Cet élément ne prend aucun paramètre.
Retour : list[str]. Liste des motifs d'approbation, passée à la boucle comme approval_for.
Agent.build_loop
build_loop(run_id: str | None = None, **kwargs: Any) -> AgentLoop
La :class:AgentLoop configurée à partir du manifeste.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
run_id | str | None | None | non | Identifiant du run transmis à la boucle, aux appels à la passerelle et aux invocations d'outils distants. |
**kwargs | Any | non | Options supplémentaires de AgentLoop ; budget vaut par défaut le budget du manifeste, approval_for vaut approval_patterns() et remote_tool_specs les specs des outils du Tool Gateway. |
Retour : AgentLoop. Un AgentLoop : 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.
Agent.default_model_call
default_model_call(run_id: str | None = None) -> ModelCall
Appel du modèle via la passerelle avec le modèle, l'effort et la limite de sortie du manifeste.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
run_id | str | None | None | non | Identifiant du run ajouté aux métadonnées eai de chaque appel à la passerelle. |
Retour : ModelCall. Fonction (messages, tools) -> dict qui appelle client.gateway.chat et renvoie la réponse brute, avec eai_cost quand le coût est mesuré ; lève ValueError sans client.
Erreurs levées : ValueError.
Agent.from_manifest
from_manifest(source: str | Path | dict[str, Any], **kwargs: Any) -> Agent
Construit l'agent à partir d'un manifeste en dict, en fichier ou en chaîne YAML.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
source | str | Path | dict[str, Any] | oui | Manifeste sous forme de dict, de chemin vers un fichier .yaml, .yml ou .json, ou de chaîne YAML. | |
**kwargs | Any | non | Arguments nommés du constructeur : client, model_call, validate_manifest, system. |
Retour : Agent. Un Agent : agent défini par son manifeste, avec des outils locaux enregistrés par décorateur.
Agent.remote_tools
remote_tools() -> list[str]
Noms des outils du manifeste qui ne sont pas implémentés localement (servis par le Tool Gateway).
Cet élément ne prend aucun paramètre.
Retour : list[str]. Liste des noms d'outils tirés des références de spec.tools, sans les outils locaux.
Agent.run
run(task: Any = None, run_id: str | None = None, session_id: str | None = None, **kwargs: Any) -> TurnResult
Exécute un tour Navin dans le processus : :meth:AgentLoop.run_once sur :class:AgentRunner.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
task | Any | None | non | Entrée du tour, ajoutée au contexte comme demande de l'utilisateur. |
run_id | str | None | None | non | Identifiant du run serveur auquel appartient ce tour, utilisé pour les métadonnées de la passerelle et les appels d'outils distants ; facultatif. |
session_id | str | None | None | non | Session dont l'historique construit le contexte et où la réponse est publiée. |
**kwargs | Any | non | Options de la boucle passées à build_loop ; state (état de tour sauvegardé à reprendre) est transmis à run_once. |
Retour : TurnResult. Un TurnResult : résultat de :meth:AgentRunner.run_turn.
Agent.run_legacy
run_legacy(task: Any = None, run_id: str | None = None, **kwargs: Any) -> LoopResult
L'ancienne boucle plan / act / verify (:meth:AgentLoop.run_legacy).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
task | Any | None | non | Tâche que la boucle planifie, exécute et vérifie. |
run_id | str | None | None | non | Identifiant du run serveur, transmis à build_loop ; facultatif. |
**kwargs | Any | non | messages, state et raise_on_budget vont à AgentLoop.run_legacy ; les autres options vont à build_loop. |
Retour : LoopResult. Un LoopResult : résultat de :meth:AgentLoop.run.
Agent.run_remote
run_remote(task: Any = None, heartbeat_interval: float = 15.0, **kwargs: Any) -> TurnResult
Crée un run serveur, puis l'exécute localement avec heartbeat, checkpoints et kill switch.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
task | Any | None | non | Tâche envoyée à client.agents.run pour créer le run serveur, puis transmise au tour local. |
heartbeat_interval | float | 15.0 | non | Secondes entre deux heartbeats envoyés au run (15.0 par défaut). |
**kwargs | Any | non | Options de la boucle passées à build_loop. |
Retour : TurnResult. Un TurnResult : résultat de :meth:AgentRunner.run_turn.
Erreurs levées : ValueError.
Agent.run_turn
run_turn(task: Any = None, session_id: str | None = None, run_id: str | None = None, **kwargs: Any) -> TurnResult
Alias de :meth:run (un tour Navin avec règles de continuation, heartbeat, checkpoints).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
task | Any | None | non | Entrée du tour, ajoutée au contexte comme demande de l'utilisateur. |
session_id | str | None | None | non | Session dont l'historique construit le contexte et où la réponse est publiée. |
run_id | str | None | None | non | Identifiant du run serveur auquel appartient ce tour ; facultatif. |
**kwargs | Any | non | Options passées à run (options de la boucle et state). |
Retour : TurnResult. Un TurnResult : résultat de :meth:AgentRunner.run_turn.
Agent.tool
tool(fn: Callable[..., Any] | None = None, **options: Any) -> Any
Décorateur qui enregistre un outil local (@agent.tool ou @agent.tool(requires_approval=True)).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
fn | Callable[..., Any] | None | None | non | Fonction à enregistrer comme outil ; si elle est omise, l'appel renvoie un décorateur qui applique les options données. |
**options | Any | non | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : Any. Le LocalTool enregistré quand fn est fourni, sinon le décorateur.
Fonctions
ref_name
ref_name(ref: str) -> str
tool:erp-purchase-orders@1.0.0 -> erp-purchase-orders.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ref | str | oui | Référence de la forme tool:nom@version. |
Retour : str. Nom sans le préfixe de type ni la version.
load_manifest
load_manifest(source: str | Path | dict[str, Any]) -> dict[str, Any]
Charge un Agent Manifest depuis un dict, un chemin de fichier YAML / JSON ou une chaîne YAML.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
source | str | Path | dict[str, Any] | oui | Manifeste sous forme de dict (renvoyé tel quel), de chemin vers un fichier .yaml, .yml ou .json, ou de chaîne YAML. |
Retour : dict[str, Any]. Manifeste sous forme de dict ; lève ValueError si le YAML n'est pas un mapping.
Erreurs levées : ValueError.