io.enterpriseai.resources.ProvidersClient

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

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 ProvidersClient

ProvidersClient(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.

ProvidersClient.catalog

JsonNode catalog()

Lire le catalogue des fournisseurs. Chaque type de fournisseur pris en charge par la plateforme, avec les champs et identifiants nécessaires, les libellés dans la langue de la requête, les fournisseurs configurés de chaque type, et la façon de trouver ses modèles (api : API de liste, manual_only : saisie par l'administrateur). Demande un rôle de lecteur.

Route : /v1/providers/catalog (GET).

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

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le catalogue des fournisseurs ».

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

ProvidersClient.create

JsonNode create(Object body)

Créer un fournisseur de modèles. Crée un fournisseur pour le tenant, ou un fournisseur partagé avec scope: platform (platform_admin seulement), et répond 201 sans les identifiants. Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	provider_type (ou type, un type du catalogue ou un alias), name facultatif (le type par défaut), api_base (ou base_url), config, credentials (champs secrets), regions, retention, scope (platform pour un fournisseur partagé).

Retour : JsonNode. Réponse JSON décodée de l'opération « Créer un fournisseur de modèles ».

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

ProvidersClient.create

JsonNode create(Object body, RequestOptions options)

Créer un fournisseur de modèles. Crée un fournisseur pour le tenant, ou un fournisseur partagé avec scope: platform (platform_admin seulement), et répond 201 sans les identifiants. Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	provider_type (ou type, un type du catalogue ou un alias), name facultatif (le type par défaut), api_base (ou base_url), config, credentials (champs secrets), regions, retention, scope (platform pour un fournisseur partagé).
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 « Créer un fournisseur de modèles ».

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

ProvidersClient.delete

void delete(String id)

Supprimer un fournisseur de modèles. Supprime le fournisseur et répond 204 ; un fournisseur partagé demande platform_admin (403 platform_only). Audité (provider.delete). Fournisseur inconnu ou invisible : 404 provider_not_found. Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

Retour : void.

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

ProvidersClient.disable

JsonNode disable(String id)

Désactiver un fournisseur (kill switch). Kill switch du fournisseur : la passerelle refuse immédiatement ses modèles (403 provider_disabled) et la découverte est refusée (409). Un fournisseur partagé demande platform_admin. Audité (provider.disable). Demande tenant_admin, platform_admin, ai_platform_engineer ou security_officer.

Route : /v1/providers/{pid}/disable (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

Retour : JsonNode. Réponse JSON décodée de l'opération « Désactiver un fournisseur (kill switch) ».

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

ProvidersClient.discoverModels

JsonNode discoverModels(String id)

Découvrir les modèles d'un fournisseur. Modèles que le fournisseur configuré sert réellement, d'après sa propre API de liste avec les identifiants enregistrés et à travers la garde sortante (jamais une liste inventée). Chaque candidat porte ce que le fournisseur renvoie (fenêtre de contexte, sortie maximale, modalités, prix) complété par des indications de la plateforme, un identifiant de registre et une catégorie suggérés, et s'il est déjà enregistré ; 1000 candidats au plus. Les fournisseurs sans API de liste répondent manual_only. Un fournisseur désactivé répond 409 provider_disabled. Audité (provider.discover). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid}/models/discover (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

Retour : JsonNode. Réponse JSON décodée de l'opération « Découvrir les modèles d'un fournisseur ».

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

ProvidersClient.enable

JsonNode enable(String id)

Réactiver un fournisseur désactivé. Lève le kill switch du fournisseur. Un fournisseur partagé demande platform_admin. Audité (provider.enable). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid}/enable (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

Retour : JsonNode. Réponse JSON décodée de l'opération « Réactiver un fournisseur désactivé ».

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

ProvidersClient.get

JsonNode get(String id)

Lire un fournisseur configuré. Un fournisseur sans ses identifiants. Un fournisseur d'un autre tenant, ou un identifiant qui n'est pas un UUID, répond 404 provider_not_found. Demande un rôle de lecteur.

Route : /v1/providers/{pid} (GET).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

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

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

ProvidersClient.list

Page<JsonNode> list()

Lister les fournisseurs configurés. Fournisseurs partagés et fournisseurs du tenant de l'appelant, avec leur type, leur adresse, leur configuration, leurs régions, leur rétention, leur état et leur dernier test ; les identifiants ne sont jamais renvoyés (seulement les noms des champs renseignés). Demande un rôle de lecteur.

Route : /v1/providers (GET).

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

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

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

ProvidersClient.test

JsonNode test(String id)

Tester la connexion d'un fournisseur. Appelle le point de liste du fournisseur avec ses identifiants enregistrés (pour les protocoles signés comme Bedrock et Vertex, vérifie que le jeu d'identifiants est complet) et répond ok, le statut HTTP, un détail et les modèles vus. Le résultat est enregistré comme état de connexion et audité (provider.test). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid}/test (POST).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.

Retour : JsonNode. Réponse JSON décodée de l'opération « Tester la connexion d'un fournisseur ».

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

ProvidersClient.update

JsonNode update(String id, Object body)

Modifier un fournisseur de modèles. Modifie la configuration, l'adresse, les régions, la rétention ou les identifiants d'un fournisseur. Les nouveaux identifiants sont écrits dans le magasin de secrets et remettent à zéro l'état de connexion jusqu'au prochain test. Une adresse distante doit utiliser TLS (422 tls_required) et respecter les règles d'adresses sortantes ; un champ d'identifiant inconnu répond 422. Un fournisseur partagé demande platform_admin. Audité (provider.update, sans les valeurs). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.
body	Object		oui	Champs à modifier : config, api_base (ou base_url), credentials (champs secrets ; un champ secret envoyé dans config y est déplacé), regions, retention.

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

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

ProvidersClient.update

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

Modifier un fournisseur de modèles. Modifie la configuration, l'adresse, les régions, la rétention ou les identifiants d'un fournisseur. Les nouveaux identifiants sont écrits dans le magasin de secrets et remettent à zéro l'état de connexion jusqu'au prochain test. Une adresse distante doit utiliser TLS (422 tls_required) et respecter les règles d'adresses sortantes ; un champ d'identifiant inconnu répond 422. Un fournisseur partagé demande platform_admin. Audité (provider.update, sans les valeurs). Demande tenant_admin, platform_admin ou ai_platform_engineer.

Route : /v1/providers/{pid} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du fournisseur.
body	Object		oui	Champs à modifier : config, api_base (ou base_url), credentials (champs secrets ; un champ secret envoyé dans config y est déplacé), regions, retention.
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 fournisseur de modèles ».

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