io.enterpriseai.EnterpriseAIClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/EnterpriseAIClient.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 EnterpriseAIClient
Point d'entrée du SDK Java Enterprise AI.
Resources
Constructeur EnterpriseAIClient
EnterpriseAIClient(Transport transport)
Constructeur privé : le client se crée avec EnterpriseAIClient.builder().
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
EnterpriseAIClient.locale
Locale locale()
Langue des messages du client.
Cet élément ne prend aucun paramètre.
Retour : Locale. La Locale configurée, Locale.ENGLISH par défaut.
EnterpriseAIClient.transport
Transport transport()
Transport de bas niveau, pour les points d'accès appelés avec un gabarit brut.
Cet élément ne prend aucun paramètre.
Retour : Transport. Un Transport : couche HTTP partagée par tous les clients de ressources (en-têtes d'authentification et de tenancy, Accept-Language, traceparent W3C, Idempotency-Key, nouvelles tentatives, erreurs et pagination).
Classe EnterpriseAIClient.Builder
Constructeur de la configuration du client.
Builder.apiKey
Builder apiKey(String v)
Clé d'API du tenant envoyée dans X-API-Key.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Clé d'API du tenant. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.baseUrl
Builder baseUrl(String v)
URL de la Control Plane, par exemple <control-plane-url> (sans /v1).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | URL de la Control Plane, en https sauf pour localhost ; une barre oblique finale est retirée. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.build
EnterpriseAIClient build()
Construit le client ; lève IllegalArgumentException sans baseUrl, pour une URL non https hors localhost ou un httpClient qui suit les redirections.
Cet élément ne prend aucun paramètre.
Retour : EnterpriseAIClient. Un EnterpriseAIClient prêt à l'emploi et sûr entre threads.
Builder.caBundle
Builder caBundle(java.nio.file.Path pem)
Fichier PEM de certificats d'autorités supplémentaires ; la vérification des certificats reste active.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
pem | java.nio.file.Path | oui | Chemin du fichier PEM ajouté au magasin de confiance par défaut. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.connectTimeout
Builder connectTimeout(Duration v)
Délai d'établissement de la connexion (10 s par défaut), ignoré avec un httpClient personnalisé.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Durée maximale d'ouverture de la connexion. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.dangerouslyDisableTlsVerificationForLocalhost
Builder dangerouslyDisableTlsVerificationForLocalhost()
Désactive la vérification des certificats TLS. #build() la refuse sauf si l'hôte de l'URL de base est localhost, 127.0.0.1 ou ::1.
Cet élément ne prend aucun paramètre.
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.environment
Builder environment(String v)
Environnement envoyé dans X-Environment (dev, test, staging, prod).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Nom de l'environnement, par exemple prod. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.header
Builder header(String name, String value)
En-tête supplémentaire envoyé sur chaque requête.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom de l'en-tête HTTP. | |
value | String | oui | Valeur de l'en-tête. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.headerSupplier
Builder headerSupplier(Supplier<Map<String, String>> v)
En-têtes calculés pour chaque requête (par exemple X-Project ou X-Environment de la requête entrante courante) ; ils remplacent le projet et l'environnement statiques.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Supplier<Map<String, String>> | oui | Fournisseur appelé avant chaque requête, qui renvoie les en-têtes à ajouter. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.httpClient
Builder httpClient(HttpClient v)
java.net.http.HttpClient personnalisé (proxy, executor) ; il ne doit pas suivre les redirections.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | HttpClient | oui | HttpClient construit avec Redirect.NEVER. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.locale
Builder locale(Locale v)
Langue des messages : Locale.ENGLISH (par défaut) ou Locale.FRENCH ; envoyée dans Accept-Language.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Locale | oui | Langue des messages ; null revient à Locale.ENGLISH. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.project
Builder project(String v)
Slug du projet envoyé dans X-Project.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Slug du projet. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.retries
Builder retries(int v)
Nouvelles tentatives sur les erreurs réseau et les HTTP 408/429/502/503/504 (2 par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | int | oui | Nombre de nouvelles tentatives ; une valeur négative vaut 0. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.retryBaseDelay
Builder retryBaseDelay(Duration v)
Premier délai d'attente, doublé à chaque tentative ; Retry-After l'emporte quand il est présent.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Premier délai d'attente (250 ms par défaut). |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.tenant
Builder tenant(String v)
Slug du tenant. Le serveur résout le tenant d'après l'identifiant ; sans identifiant, le slug est envoyé dans X-Dev-Tenant (mode développement, EAI_AUTH_DEV=1).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Slug du tenant. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.timeout
Builder timeout(Duration v)
Délai d'expiration par requête (60 s par défaut).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Duration | oui | Durée maximale d'une requête. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.toString
String toString()
N'affiche jamais la clé d'API ni le jeton.
Cet élément ne prend aucun paramètre.
Retour : String. Un résumé de la configuration avec la clé d'API et le jeton masqués.
Builder.token
Builder token(String v)
Jeton d'accès OIDC envoyé dans Authorization: Bearer.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | String | oui | Jeton d'accès OIDC. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.
Builder.traceparent
Builder traceparent(Supplier<String> v)
Fournit le traceparent W3C du span courant ; sinon un traceparent aléatoire est généré.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | Supplier<String> | oui | Fournisseur du traceparent W3C du span courant. |
Retour : Builder. Ce même Builder, pour enchaîner les appels.