Aller au contenu principal

io.enterpriseai.resources.RoutesClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/RoutesClient.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 RoutesClient​

LLM et passerelle de modèles. Fournisseurs de modèles, registre des modèles, règles de routage et passerelle de modèles (Model Gateway) : le seul chemin par lequel agents et applications appellent les modèles.

Constructeur RoutesClient​

RoutesClient(Transport transport)

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

NomTypeDéfautRequisDescription
transportTransportouiTransport partagé par les sous-clients d'un même client.

RoutesClient.create​

JsonNode create(Object body)

Créer une règle de routage. Crée une règle de routage du tenant et répond 201. Un principal de plateforme sans tenant répond 403 platform_only ; une stratégie inconnue 422 parameter_invalid. Audité (route.create). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/routes (POST).

NomTypeDéfautRequisDescription
bodyObjectouiname (default par défaut), match (champs de la requête auxquels la règle s'applique, une valeur ou une liste de valeurs), strategy (priority par défaut, cost, latency, quality), candidates (identifiants de modèles, ou un seul target_model), fallbacks, constraints, priority (100 par défaut, la plus basse d'abord), enabled (vrai par défaut).

Retour : JsonNode. Réponse JSON décodée de l'opération « Créer une règle de routage ».

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

RoutesClient.create​

JsonNode create(Object body, RequestOptions options)

Créer une règle de routage. Crée une règle de routage du tenant et répond 201. Un principal de plateforme sans tenant répond 403 platform_only ; une stratégie inconnue 422 parameter_invalid. Audité (route.create). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/routes (POST).

NomTypeDéfautRequisDescription
bodyObjectouiname (default par défaut), match (champs de la requête auxquels la règle s'applique, une valeur ou une liste de valeurs), strategy (priority par défaut, cost, latency, quality), candidates (identifiants de modèles, ou un seul target_model), fallbacks, constraints, priority (100 par défaut, la plus basse d'abord), enabled (vrai par défaut).
optionsRequestOptionsouiOptions 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 « Créer une règle de routage ».

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

RoutesClient.delete​

void delete(String id)

Supprimer une règle de routage. Supprime une règle de routage du tenant et répond 204. Règle inconnue : 404 route_not_found. Audité (route.delete). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/routes/{rid} (DELETE).

NomTypeDéfautRequisDescription
idStringouiIdentifiant de la règle de routage.

Retour : void.

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

RoutesClient.list​

Page<JsonNode> list()

Lister les règles de routage. Règles de routage du tenant par priorité puis par nom, chacune avec ses critères, sa stratégie, ses candidats, ses replis, ses contraintes et son target_model (le premier candidat). Demande un rôle de lecteur.

Route : /v1/routes (GET).

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

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

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

RoutesClient.replace​

JsonNode replace(String id, Object body)

Remplacer une règle de routage. Remplace les critères, la stratégie, les candidats, les replis, les contraintes, la priorité et l'indicateur d'activation d'une règle du tenant (les champs omis prennent leur valeur par défaut ; le nom est conservé). Règle inconnue : 404 route_not_found. Audité (route.update). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/routes/{rid} (PUT).

NomTypeDéfautRequisDescription
idStringouiIdentifiant de la règle de routage.
bodyObjectouiLa règle complète : mêmes champs qu'à la création sauf name.

Retour : JsonNode. Réponse JSON décodée de l'opération « Remplacer une règle de routage ».

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

RoutesClient.replace​

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

Remplacer une règle de routage. Remplace les critères, la stratégie, les candidats, les replis, les contraintes, la priorité et l'indicateur d'activation d'une règle du tenant (les champs omis prennent leur valeur par défaut ; le nom est conservé). Règle inconnue : 404 route_not_found. Audité (route.update). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/routes/{rid} (PUT).

NomTypeDéfautRequisDescription
idStringouiIdentifiant de la règle de routage.
bodyObjectouiLa règle complète : mêmes champs qu'à la création sauf name.
optionsRequestOptionsouiOptions 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 « Remplacer une règle de routage ».

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

RoutesClient.simulate​

JsonNode simulate(Object body)

Simuler le routage d'une requête. Indique vers quel modèle une requête serait routée, sans l'appeler : la règle donnée par route_id ou la première règle active qui correspond, les listes d'autorisation et d'interdiction du tenant (restreintes par la requête), la classification et la politique de repli. Répond le modèle choisi, les replis, les candidats écartés avec leur raison et la règle utilisée ; aucun modèle éligible répond 422 no_eligible_model. Les modèles restreints ne sont admis que pour tenant_admin et security_officer avec allow_restricted. Demande un rôle de lecteur.

Route : /v1/routes/simulate (POST).

NomTypeDéfautRequisDescription
bodyObjectouiRequête à simuler : model, candidates, strategy, purpose, capabilities, data_classification (internal par défaut), region_allow, provider_allow, model_allow, allow_restricted, fallback_policy (allowed par défaut), route_id facultatif, et tout champ sur lequel portent les règles.

Retour : JsonNode. Réponse JSON décodée de l'opération « Simuler le routage d'une requête ».

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

RoutesClient.simulate​

JsonNode simulate(Object body, RequestOptions options)

Simuler le routage d'une requête. Indique vers quel modèle une requête serait routée, sans l'appeler : la règle donnée par route_id ou la première règle active qui correspond, les listes d'autorisation et d'interdiction du tenant (restreintes par la requête), la classification et la politique de repli. Répond le modèle choisi, les replis, les candidats écartés avec leur raison et la règle utilisée ; aucun modèle éligible répond 422 no_eligible_model. Les modèles restreints ne sont admis que pour tenant_admin et security_officer avec allow_restricted. Demande un rôle de lecteur.

Route : /v1/routes/simulate (POST).

NomTypeDéfautRequisDescription
bodyObjectouiRequête à simuler : model, candidates, strategy, purpose, capabilities, data_classification (internal par défaut), region_allow, provider_allow, model_allow, allow_restricted, fallback_policy (allowed par défaut), route_id facultatif, et tout champ sur lequel portent les règles.
optionsRequestOptionsouiOptions 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 « Simuler le routage d'une requête ».

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