io.enterpriseai.resources.ContextClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/ContextClient.java. Retour à l'index de la référence du SDK Java.
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 ContextClient
Budget du Context Manager et planification de la compression.
Constructeur ContextClient
ContextClient(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. |
ContextClient.issue
JsonNode issue(Object body)
Émettre un contexte d'exécution signé. Construit et signe un ExecutionContext pour l'appelant et renvoie token, context_id, kid, alg, issued_at et expires_at (201). - Avec run_id : l'appelant doit avoir créé le run, en être le principal racine ou l'utilisateur pour qui il agit, ou détenir agent, tenant_admin ou security_officer (403 forbidden) ; la délégation du run est revérifiée et le manifeste de l'agent est inclus. - Avec delegation_id : la délégation doit être valide et l'appelant l'une de ses parties, ou agent ou tenant_admin. Erreurs : 400 context_wrong_audience pour une audience que la plateforme n'accepte pas, 400 context_ttl_exceeded, 403 delegation_expired, 503 context_authority_unavailable. Audité sous context.issue.
Route : /v1/context/issue (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Audience, durée de vie et run ou délégation visés par le contexte. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Émettre un contexte d'exécution signé ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.issue
JsonNode issue(Object body, RequestOptions options)
Émettre un contexte d'exécution signé. Construit et signe un ExecutionContext pour l'appelant et renvoie token, context_id, kid, alg, issued_at et expires_at (201). - Avec run_id : l'appelant doit avoir créé le run, en être le principal racine ou l'utilisateur pour qui il agit, ou détenir agent, tenant_admin ou security_officer (403 forbidden) ; la délégation du run est revérifiée et le manifeste de l'agent est inclus. - Avec delegation_id : la délégation doit être valide et l'appelant l'une de ses parties, ou agent ou tenant_admin. Erreurs : 400 context_wrong_audience pour une audience que la plateforme n'accepte pas, 400 context_ttl_exceeded, 403 delegation_expired, 503 context_authority_unavailable. Audité sous context.issue.
Route : /v1/context/issue (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Audience, durée de vie et run ou délégation visés par le contexte. | |
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 « Émettre un contexte d'exécution signé ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.jwks
JsonNode jwks()
Lire les clés publiques de vérification. Clés publiques de vérification sous forme de JWKS (actives, et retirées encore dans leur fenêtre de vérification), chacune avec kid, alg (ES256 ou EdDSA) et use: sig. Tout principal authentifié peut la lire. 503 context_authority_unavailable quand le registre de clés est illisible.
Route : /v1/context/jwks (GET).
Cet élément ne prend aucun paramètre.
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire les clés publiques de vérification ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.keys
JsonNode keys()
Lister les clés de signature. Registre des clés de signature des contextes : kid, algorithme, statut, dates d'utilisation, de retrait et de révocation. Demande security_officer ou auditor. 503 context_authority_unavailable quand le registre est illisible.
Route : /v1/context/keys (GET).
Cet élément ne prend aucun paramètre.
Retour : JsonNode. Réponse JSON décodée de l'opération « Lister les clés de signature ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.plan
JsonNode plan(Object body)
Planifier la fenêtre de contexte. Simulation du Context Manager : calcule le budget de jetons d'une fenêtre de modèle (réserves de sortie, de raisonnement et de sécurité) et les segments conservés, compressés ou écartés selon leur priorité. Avec model, la fenêtre et la réserve de sortie viennent du registre. Une fenêtre qui n'est pas un entier positif répond 422 parameter_invalid ; des segments qui ne peuvent pas tenir répondent 422 context_overflow. Demande un rôle de lecteur.
Route : /v1/context/plan (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | model (ou model_id), ou window (jetons) ; output (jetons de sortie réservés, par défaut le maximum du modèle plafonné à 4096), reasoning (jetons de raisonnement réservés), safety (marge) et segments (chacun avec type, et facultativement segment_id, priority, classification et son contenu). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Planifier la fenêtre de contexte ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.plan
JsonNode plan(Object body, RequestOptions options)
Planifier la fenêtre de contexte. Simulation du Context Manager : calcule le budget de jetons d'une fenêtre de modèle (réserves de sortie, de raisonnement et de sécurité) et les segments conservés, compressés ou écartés selon leur priorité. Avec model, la fenêtre et la réserve de sortie viennent du registre. Une fenêtre qui n'est pas un entier positif répond 422 parameter_invalid ; des segments qui ne peuvent pas tenir répondent 422 context_overflow. Demande un rôle de lecteur.
Route : /v1/context/plan (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | model (ou model_id), ou window (jetons) ; output (jetons de sortie réservés, par défaut le maximum du modèle plafonné à 4096), reasoning (jetons de raisonnement réservés), safety (marge) et segments (chacun avec type, et facultativement segment_id, priority, classification et son contenu). | |
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 « Planifier la fenêtre de contexte ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.revoke
JsonNode revoke(String contextId)
Révoquer un contexte d'exécution. Révoque un contexte émis avant son expiration ; sa vérification répond ensuite context_revoked. Permis pour le principal qui l'a émis, ou tenant_admin ou security_officer (403 forbidden). Une seconde révocation garde la première date. 404 context_not_found. Audité sous context.revoke.
Route : /v1/context/{context_id}/revoke (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
contextId | String | oui | Identifiant (UUID) du contexte, la revendication jti de son jeton. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Révoquer un contexte d'exécution ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.revoke
JsonNode revoke(String contextId, RequestOptions options)
Révoquer un contexte d'exécution. Révoque un contexte émis avant son expiration ; sa vérification répond ensuite context_revoked. Permis pour le principal qui l'a émis, ou tenant_admin ou security_officer (403 forbidden). Une seconde révocation garde la première date. 404 context_not_found. Audité sous context.revoke.
Route : /v1/context/{context_id}/revoke (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
contextId | String | oui | Identifiant (UUID) du contexte, la revendication jti de son jeton. | |
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 « Révoquer un contexte d'exécution ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.revokeKey
JsonNode revokeKey(String kid, Object body)
Révoquer une clé de signature. Révoque immédiatement une clé de signature des contextes : les contextes qu'elle a signés ne sont plus valides. Demande platform_admin. 404 signing_key_not_found. Audité sous context.key.revoke au niveau de la plateforme.
Route : /v1/context/keys/{kid}/revoke (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
kid | String | oui | Identifiant de clé, l'empreinte RFC 7638 de la clé publique. | |
body | Object | oui | Raison de la révocation. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Révoquer une clé de signature ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.revokeKey
JsonNode revokeKey(String kid, Object body, RequestOptions options)
Révoquer une clé de signature. Révoque immédiatement une clé de signature des contextes : les contextes qu'elle a signés ne sont plus valides. Demande platform_admin. 404 signing_key_not_found. Audité sous context.key.revoke au niveau de la plateforme.
Route : /v1/context/keys/{kid}/revoke (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
kid | String | oui | Identifiant de clé, l'empreinte RFC 7638 de la clé publique. | |
body | Object | oui | Raison de la révocation. | |
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 « Révoquer une clé de signature ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.verify
JsonNode verify(Object body)
Vérifier un contexte d'exécution signé. Contrôle un jeton et renvoie valid, context_id, kid, alg, les revendications et le document de contexte. Contrôles, dans l'ordre : structure et forme canonique (context_malformed), algorithme et signature (context_invalid_signature), clé connue et non révoquée (context_unknown_key), émetteur (context_wrong_issuer), audience (context_wrong_audience), durée de vie (context_expired), tenant de l'appelant (403 context_tenant_mismatch), enregistrement d'émission (context_revoked), empreinte du document et chaîne de délégation (une délégation révoquée donne context_revoked). Les refus répondent 401 sauf mention contraire et sont audités ; un succès rattache l'identité vérifiée aux événements d'audit de la requête.
Route : /v1/context/verify (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Jeton à vérifier et audience attendue. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Vérifier un contexte d'exécution signé ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ContextClient.verify
JsonNode verify(Object body, RequestOptions options)
Vérifier un contexte d'exécution signé. Contrôle un jeton et renvoie valid, context_id, kid, alg, les revendications et le document de contexte. Contrôles, dans l'ordre : structure et forme canonique (context_malformed), algorithme et signature (context_invalid_signature), clé connue et non révoquée (context_unknown_key), émetteur (context_wrong_issuer), audience (context_wrong_audience), durée de vie (context_expired), tenant de l'appelant (403 context_tenant_mismatch), enregistrement d'émission (context_revoked), empreinte du document et chaîne de délégation (une délégation révoquée donne context_revoked). Les refus répondent 401 sauf mention contraire et sont audités ; un succès rattache l'identité vérifiée aux événements d'audit de la requête.
Route : /v1/context/verify (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Jeton à vérifier et audience attendue. | |
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 « Vérifier un contexte d'exécution signé ».
Erreurs levées : les erreurs typées du transport (Erreurs).