enterprise_ai.heartbeat
Source : sdks/python/src/enterprise_ai/heartbeat/__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.
Modèle HeartbeatResponse
Réponse analysée de POST /v1/runs/{id}/heartbeat (sémantique d'exécution partagée).
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
run_id | str | None | non | Identifiant du run indiqué dans la réponse. |
state | str | None | non | État du run, tiré du champ state ou status de la réponse. |
agent_status | str | None | non | Statut de l'agent renvoyé par le serveur (par exemple suspended ou killed). |
action | str | non | Action demandée par le serveur, en minuscules (continue par défaut) ; devient stop quand le statut demande l'arrêt. |
reason | str | None | non | Raison de l'action. Inscrite dans le journal d'audit avec l'acteur et l'heure. |
raw | dict[str, Any] | non | Réponse brute sous forme de dict. |
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
stop | bool | oui | Vrai quand action vaut stop, kill, cancel ou suspend. |
HeartbeatResponse.parse
parse(answer: Any) -> HeartbeatResponse
Construit une réponse à partir d'une réponse de heartbeat ; une réponse qui n'est pas un dict donne la réponse par défaut.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
answer | Any | oui | Réponse brute de POST /v1/runs/{id}/heartbeat. |
Retour : HeartbeatResponse. Un HeartbeatResponse : réponse analysée de POST /v1/runs/{id}/heartbeat (sémantique d'exécution partagée).
Classe Heartbeat
Heartbeat en arrière-plan pour un run synchrone (gestionnaire de contexte).
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
beats | oui | Nombre de heartbeats auxquels le serveur a répondu. | |
errors | oui | Nombre de heartbeats en échec avec une EaiError. | |
interval | oui | Secondes entre deux heartbeats. | |
last_answer | Any | oui | Réponse brute du dernier heartbeat réussi, ou None. |
last_response | HeartbeatResponse | None | oui | Dernière réponse analysée en HeartbeatResponse, ou None avant la première. |
on_stop | oui | Fonction appelée avec la réponse brute quand le serveur demande l'arrêt, ou None. | |
reason | str | None | oui | Raison de l'action. Inscrite dans le journal d'audit avec l'acteur et l'heure. |
run_id | oui | Identifiant du run qui reçoit les heartbeats. | |
runs | oui | Client des runs utilisé pour envoyer les heartbeats. | |
state | oui | Fonction qui renvoie les champs du prochain heartbeat. | |
stop_event | oui | threading.Event positionné quand le serveur demande l'arrêt du run. | |
stop_requested | bool | oui | Vrai dès que le serveur a demandé l'arrêt de ce run. |
Constructeur Heartbeat
Heartbeat(runs: Any, run_id: str, interval: float = 15.0, state: Callable[[], dict[str, Any]] | None = None, stop_event: threading.Event | None = None, on_stop: Callable[[dict[str, Any]], None] | None = None) -> None
Prépare le heartbeat d'un run ; le thread d'arrière-plan démarre avec start() ou à l'entrée du with.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
runs | Any | oui | Client des runs dont heartbeat(run_id, ...) envoie /v1/runs/{id}/heartbeat. | |
run_id | str | oui | Identifiant du run qui reçoit les heartbeats. | |
interval | float | 15.0 | non | Secondes entre deux heartbeats (15.0 par défaut). |
state | Callable[[], dict[str, Any]] | None | None | non | Fonction appelée avant chaque battement qui renvoie les champs du heartbeat (step, message, progress, worker) ; vide par défaut. |
stop_event | threading.Event | None | None | non | threading.Event à positionner quand le serveur demande l'arrêt, en général le stop_event de la boucle d'agent ; un nouvel événement par défaut. |
on_stop | Callable[[dict[str, Any]], None] | None | None | non | Fonction appelée avec la réponse brute quand le serveur demande l'arrêt du run. |
Heartbeat.beat
beat() -> Any
Envoie un heartbeat tout de suite ; positionne stop_event quand le serveur demande l'arrêt.
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse brute du serveur, ou None quand l'appel a levé une EaiError (comptée dans errors).
Heartbeat.start
start() -> Heartbeat
Démarre le thread d'arrière-plan qui bat toutes les interval secondes jusqu'à stop() ou une demande d'arrêt ; sans effet s'il tourne déjà.
Cet élément ne prend aucun paramètre.
Retour : Heartbeat. Un Heartbeat : heartbeat en arrière-plan pour un run synchrone (gestionnaire de contexte).
Heartbeat.stop
stop() -> None
Arrête le thread d'arrière-plan et l'attend au plus interval + 1 secondes.
Cet élément ne prend aucun paramètre.
Retour : None.
Classe AsyncHeartbeat
Heartbeat sous forme de tâche asyncio pour le client asynchrone (async with).
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
beats | oui | Nombre de heartbeats auxquels le serveur a répondu. | |
interval | oui | Secondes entre deux heartbeats. | |
run_id | oui | Identifiant du run qui reçoit les heartbeats. | |
runs | oui | Client asynchrone des runs utilisé pour envoyer les heartbeats. | |
state | oui | Fonction qui renvoie les champs du prochain heartbeat. | |
stop_event | asyncio.Event | oui | asyncio.Event positionné quand le serveur demande l'arrêt du run ; il met aussi fin à la tâche de heartbeat. |
Constructeur AsyncHeartbeat
AsyncHeartbeat(runs: Any, run_id: str, interval: float = 15.0, state: Callable[[], dict[str, Any]] | None = None) -> None
Prépare le heartbeat d'un run ; la tâche asyncio démarre à l'entrée du async with et est annulée à la sortie.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
runs | Any | oui | Client asynchrone des runs dont heartbeat(run_id, ...) envoie /v1/runs/{id}/heartbeat. | |
run_id | str | oui | Identifiant du run qui reçoit les heartbeats. | |
interval | float | 15.0 | non | Secondes entre deux heartbeats (15.0 par défaut). |
state | Callable[[], dict[str, Any]] | None | None | non | Fonction appelée avant chaque battement qui renvoie les champs du heartbeat (step, message, progress, worker) ; vide par défaut. |
AsyncHeartbeat.beat
async beat() -> Any
Envoie un heartbeat tout de suite ; positionne stop_event quand la réponse demande à l'agent de s'arrêter.
Cet élément ne prend aucun paramètre.
Retour : Any. Réponse du serveur, ou None quand l'appel a levé une EaiError.
Fonctions
should_stop
should_stop(answer: Any) -> bool
Vrai quand une réponse de heartbeat demande à l'agent de s'arrêter.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
answer | Any | oui | Réponse de heartbeat, sous forme de dict ou de HeartbeatResponse. |
Retour : bool. Vrai quand l'action vaut stop, kill, cancel ou suspend, quand le statut du run ou de l'agent est terminal (annulé, tué, suspendu, en échec) ou quand stop est vrai.