enterprise_ai.scheduler

Source : sdks/python/src/enterprise_ai/scheduler/__init__.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 SchedulesClient

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.

Resource

SchedulesClient.create

create(agent_id: str, cron: str, input: object = None, timezone: str = 'UTC', **extra: Any) -> Any

Créer une planification. Planifie des runs d'un agent à partir d'une expression cron évaluée dans un fuseau horaire ; la première échéance next_run_at est calculée (422 invalid_cron). Quand Temporal est configuré, la planification y est créée (503 scheduler_unavailable en cas d'échec). Demande tenant_admin, developer ou application_owner. 404 agent_not_found. Audité sous schedule.create.

Route : /v1/schedules (POST).

Nom	Type	Défaut	Requis	Description
agent_id	str		oui	Agent à exécuter (UUID ou nom).
cron	str		oui	Expression cron (1 à 200 caractères), évaluée dans timezone.
input	object	None	non	Entrée donnée à chaque run lancé par la planification.
timezone	str	'UTC'	non	Fuseau horaire IANA, par exemple Europe/Paris. UTC par défaut.
**extra	Any		non	Champs supplémentaires fusionnés dans le corps de la requête.

Retour : Any. Réponse JSON décodée de l'opération « Créer une planification ».

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

SchedulesClient.delete

delete(schedule_id: str) -> Any

Supprimer une planification. Supprime la planification ; elle ne lance plus aucun run. Demande tenant_admin, developer ou application_owner. Quand la planification est portée par Temporal, elle y est aussi supprimée (503 scheduler_unavailable si Temporal est injoignable). 404 schedule_not_found. Audité sous schedule.delete.

Route : /v1/schedules/{schedule_id} (DELETE).

Nom	Type	Défaut	Requis	Description
schedule_id	str		oui	Identifiant (UUID) de la planification.

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

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

SchedulesClient.list

list(**page: Any) -> Any

Lister les planifications. Planifications cron du tenant, de la plus ancienne à la plus récente, éventuellement pour un seul agent. Une seule page.

Route : /v1/schedules (GET).

Nom	Type	Défaut	Requis	Description
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

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

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

SchedulesClient.update

update(schedule_id: str, **changes: Any) -> Any

Modifier une planification. Modifie l'expression cron, le fuseau horaire, l'entrée ou l'activation. La prochaine échéance est recalculée (422 invalid_cron pour une expression ou un fuseau invalide) et la planification Temporal est mise à jour quand Temporal la porte (503 scheduler_unavailable). Demande tenant_admin, developer ou application_owner. Audité sous schedule.update.

Route : /v1/schedules/{schedule_id} (PATCH).

Nom	Type	Défaut	Requis	Description
schedule_id	str		oui	Identifiant (UUID) de la planification.
**changes	Any		non	Champs de la planification à modifier, envoyés comme corps du PATCH.

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

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

Classe TriggersClient

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.

Resource

TriggersClient.create

create(agent_id: str, subject: str, **extra: Any) -> Any

Créer un déclencheur. Lance un run de l'agent pour chaque événement publié dont le sujet correspond (jokers NATS * et > admis) et dont la charge utile passe le filtre. Demande tenant_admin, developer ou application_owner. 422 invalid_subject ou invalid_filter ; 404 agent_not_found. Audité sous trigger.create.

Route : /v1/triggers (POST).

Nom	Type	Défaut	Requis	Description
agent_id	str		oui	Agent à exécuter (UUID ou nom).
subject	str		oui	Sujet NATS à faire correspondre (1 à 255 caractères, jokers * et > admis).
**extra	Any		non	Champs supplémentaires fusionnés dans le corps de la requête.

Retour : Any. Réponse JSON décodée de l'opération « Créer un déclencheur ».

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

TriggersClient.delete

delete(trigger_id: str) -> Any

Supprimer un déclencheur. Supprime le déclencheur sur événement ; les événements correspondants ne lancent plus de run. Demande tenant_admin, developer ou application_owner. 404 trigger_not_found. Audité sous trigger.delete.

Route : /v1/triggers/{trigger_id} (DELETE).

Nom	Type	Défaut	Requis	Description
trigger_id	str		oui	Identifiant (UUID) du déclencheur.

Retour : Any. Réponse JSON décodée de l'opération « Supprimer un déclencheur ».

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

TriggersClient.list

list(**page: Any) -> Any

Lister les déclencheurs. Déclencheurs sur événement du tenant, du plus ancien au plus récent : agent, sujet et filtre. Une seule page.

Route : /v1/triggers (GET).

Nom	Type	Défaut	Requis	Description
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

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

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

TriggersClient.publish

publish(subject: str, payload: dict[str, Any], headers: dict[str, str] | None = None) -> Any

Publier un événement. Publie un événement (202) : sur NATS JetStream quand il est configuré, sinon dans l'outbox de la plateforme. Le contexte de trace W3C courant est ajouté aux en-têtes. Chaque déclencheur dont le sujet et le filtre correspondent lance un run de son agent (idempotent par événement et déclencheur) ; la réponse les liste dans triggered, avec skipped et un code d'erreur quand un run n'a pas pu démarrer. Demande tenant_admin, developer ou agent. 422 invalid_subject. Audité sous event.publish.

Route : /v1/events/publish (POST).

Nom	Type	Défaut	Requis	Description
subject	str		oui	Sujet de l'événement (1 à 255 caractères, sujet NATS valide sans joker), par exemple orders.created.
payload	dict[str, Any]		oui	Contenu de l'événement, toute valeur JSON. Les filtres des déclencheurs le lisent.
headers	dict[str, str] | None	None	non	En-têtes de l'événement, valeurs textuelles. Le contexte de trace y est ajouté.

Retour : Any. Réponse JSON décodée de l'opération « Publier un événement ».

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

Fonctions

validate_cron

validate_cron(expression: str) -> bool

Vérifie une expression cron à 5 champs (nombres, *, plages, listes et pas).

Nom	Type	Défaut	Requis	Description
expression	str		oui	Expression cron : minute, heure, jour du mois, mois, jour de la semaine (0 à 7).

Retour : bool. True si chaque champ est valide et dans sa plage, sinon False.