io.enterpriseai.resources.AgentsClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/AgentsClient.java. Retour à l'index de la référence du SDK Java.

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 AgentsClient

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.

Constructeur AgentsClient

AgentsClient(Transport transport)

Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.

Nom	Type	Défaut	Requis	Description
transport	Transport		oui	Transport partagé par les sous-clients d'un même client.

AgentsClient.create

JsonNode create(Object body)

Enregistrer un agent ou une version. Applique un manifeste Agent : crée l'agent, ou ajoute une version à un agent existant et la rend courante. Le manifeste est validé selon le contrat v1 (422 invalid_manifest) ; le niveau de risque unacceptable est refusé (422 agent_risk_unacceptable) ; la même version avec un autre contenu est refusée (409 version_immutable). apply_status dans la réponse vaut created, version_added ou unchanged. Demande tenant_admin, developer ou application_owner ; l'appelant devient propriétaire ReBAC. Audité sous agent.apply.

Route : /v1/agents (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Manifeste Agent (kind: Agent, metadata avec nom, version et propriétaire, spec).

Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer un agent ou une version ».

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

AgentsClient.create

JsonNode create(Object body, RequestOptions options)

Enregistrer un agent ou une version. Applique un manifeste Agent : crée l'agent, ou ajoute une version à un agent existant et la rend courante. Le manifeste est validé selon le contrat v1 (422 invalid_manifest) ; le niveau de risque unacceptable est refusé (422 agent_risk_unacceptable) ; la même version avec un autre contenu est refusée (409 version_immutable). apply_status dans la réponse vaut created, version_added ou unchanged. Demande tenant_admin, developer ou application_owner ; l'appelant devient propriétaire ReBAC. Audité sous agent.apply.

Route : /v1/agents (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Manifeste Agent (kind: Agent, metadata avec nom, version et propriétaire, spec).
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer un agent ou une version ».

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

AgentsClient.delete

void delete(String id)

Supprimer un agent. Supprime l'agent et ses versions. Demande le rôle tenant_admin et la relation ReBAC owner sur l'agent. Refusé avec 409 agent_has_active_runs tant qu'un run de l'agent est encore actif (en attente, en cours, en pause ou suspendu) ; 404 agent_not_found pour un agent inconnu. Audité sous agent.delete.

Route : /v1/agents/{agent_id} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : void.

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

AgentsClient.get

JsonNode get(String id)

Lire un agent. Renvoie l'agent, le manifeste de sa version courante et runs, le nombre de ses runs par état. Demande la relation ReBAC viewer sur l'agent. 404 agent_not_found.

Route : /v1/agents/{agent_id} (GET).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire un agent ».

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

AgentsClient.kill

JsonNode kill(String id)

Arrêter définitivement un agent. Kill switch : tous les runs actifs de l'agent sont annulés avec l'erreur killed et le statut de l'agent devient killed définitivement (il ne peut plus reprendre). Demande tenant_admin ou security_officer. 409 agent_killed s'il est déjà arrêté. La réponse liste affected_runs. Audité sous agent.kill.

Route : /v1/agents/{agent_id}/kill (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : JsonNode. Réponse JSON décodée de l'opération « Arrêter définitivement un agent ».

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

AgentsClient.kill

JsonNode kill(String id, Object body)

Arrêter définitivement un agent. Kill switch : tous les runs actifs de l'agent sont annulés avec l'erreur killed et le statut de l'agent devient killed définitivement (il ne peut plus reprendre). Demande tenant_admin ou security_officer. 409 agent_killed s'il est déjà arrêté. La réponse liste affected_runs. Audité sous agent.kill.

Route : /v1/agents/{agent_id}/kill (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.
body	Object		oui	Raison facultative, conservée sur l'agent et dans le journal d'audit.

Retour : JsonNode. Réponse JSON décodée de l'opération « Arrêter définitivement un agent ».

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

AgentsClient.list

Page<JsonNode> list()

Lister les agents. Agents du tenant, dans l'ordre des noms, paginés avec cursor. Tout principal du tenant peut l'appeler.

Route : /v1/agents (GET).

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

Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les agents ».

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

AgentsClient.list

Page<JsonNode> list(Map<String, ?> query)

Lister les agents. Agents du tenant, dans l'ordre des noms, paginés avec cursor. Tout principal du tenant peut l'appeler.

Route : /v1/agents (GET).

Nom	Type	Défaut	Requis	Description
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.

Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les agents ».

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

AgentsClient.resume

JsonNode resume(String id)

Demander la reprise d'un agent. Ouvre une approbation de promotion pour ramener un agent suspendu à active et répond 202 avec approval_id et status: pending_approval ; les approbateurs sont tenant_admin ou security_officer. Une fois approuvée, les runs suspendus par la suspension de l'agent reprennent. Demande tenant_admin ou security_officer. Refusé avec 409 agent_killed, ou 409 kill_switch_active tant qu'un confinement SOC retient l'agent (levé uniquement via POST /v1/soc/recoveries).

Route : /v1/agents/{agent_id}/resume (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : JsonNode. Réponse JSON décodée de l'opération « Demander la reprise d'un agent ».

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

AgentsClient.resume

JsonNode resume(String id, Object body)

Demander la reprise d'un agent. Ouvre une approbation de promotion pour ramener un agent suspendu à active et répond 202 avec approval_id et status: pending_approval ; les approbateurs sont tenant_admin ou security_officer. Une fois approuvée, les runs suspendus par la suspension de l'agent reprennent. Demande tenant_admin ou security_officer. Refusé avec 409 agent_killed, ou 409 kill_switch_active tant qu'un confinement SOC retient l'agent (levé uniquement via POST /v1/soc/recoveries).

Route : /v1/agents/{agent_id}/resume (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.
body	Object		oui	Raison facultative, montrée aux approbateurs.

Retour : JsonNode. Réponse JSON décodée de l'opération « Demander la reprise d'un agent ».

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

AgentsClient.suspend

JsonNode suspend(String id)

Suspendre un agent. Kill switch réversible : le statut de l'agent devient suspended, ses runs actifs passent à suspended et les nouveaux runs sont refusés. Demande tenant_admin ou security_officer. 409 agent_killed pour un agent arrêté. La réponse liste affected_runs. Audité sous agent.suspend.

Route : /v1/agents/{agent_id}/suspend (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : JsonNode. Réponse JSON décodée de l'opération « Suspendre un agent ».

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

AgentsClient.suspend

JsonNode suspend(String id, Object body)

Suspendre un agent. Kill switch réversible : le statut de l'agent devient suspended, ses runs actifs passent à suspended et les nouveaux runs sont refusés. Demande tenant_admin ou security_officer. 409 agent_killed pour un agent arrêté. La réponse liste affected_runs. Audité sous agent.suspend.

Route : /v1/agents/{agent_id}/suspend (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.
body	Object		oui	Raison facultative, conservée sur l'agent et dans le journal d'audit.

Retour : JsonNode. Réponse JSON décodée de l'opération « Suspendre un agent ».

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

AgentsClient.update

JsonNode update(String id, Object body)

Modifier un agent. Modifie les champs de registre de l'agent (propriétaire, niveau de risque, description, libellés) sans créer de version. Demande tenant_admin, developer ou application_owner et la relation ReBAC editor. Une valeur invalide répond 400 invalid_request. Audité sous agent.update avec les noms des champs modifiés.

Route : /v1/agents/{agent_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.
body	Object		oui	Champs à modifier ; ceux omis sont conservés.

Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un agent ».

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

AgentsClient.update

JsonNode update(String id, Object body, RequestOptions options)

Modifier un agent. Modifie les champs de registre de l'agent (propriétaire, niveau de risque, description, libellés) sans créer de version. Demande tenant_admin, developer ou application_owner et la relation ReBAC editor. Une valeur invalide répond 400 invalid_request. Audité sous agent.update avec les noms des champs modifiés.

Route : /v1/agents/{agent_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.
body	Object		oui	Champs à modifier ; ceux omis sont conservés.
options	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un agent ».

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

AgentsClient.versions

JsonNode versions(String id)

Lister les versions d'un agent. Toutes les versions enregistrées de l'agent, de la plus récente à la plus ancienne, avec manifeste, empreinte, auteur et current (vrai pour la version en service). Demande la relation ReBAC viewer. Une seule page.

Route : /v1/agents/{agent_id}/versions (GET).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) ou nom de l'agent.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lister les versions d'un agent ».

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