io.enterpriseai.Transport

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/Transport.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 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 avec attente exponentielle respectant Retry-After, conversion de l'enveloppe d'erreur et pagination.

Transport.baseUrl

URI baseUrl()

URL de base de la Control Plane, validée, sans barre oblique finale.

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

Retour : URI. L'URI de base.

Transport.bytes

byte[] bytes(String method, String template, Object body, RequestOptions o, String... params)

Appel binaire (audio, exports).

Nom	Type	Défaut	Requis	Description
method	String		oui	Méthode HTTP, par exemple GET ou POST ; un POST reçoit une Idempotency-Key.
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
body	Object		oui	Corps de la requête, sérialisé en JSON.
o	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes).
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : byte[]. Le corps complet de la réponse en octets.

Transport.environment

String environment()

Environnement fixé sur le builder.

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

Retour : String. L'environnement, ou null.

Transport.exchange

Response<JsonNode> exchange(String method, String template, Object body, Map<String, ?> query, RequestOptions o, String... params)

Appel JSON qui renvoie la réponse avec ses en-têtes.

Nom	Type	Défaut	Requis	Description
method	String		oui	Méthode HTTP, par exemple GET ou POST ; un POST reçoit une Idempotency-Key.
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
body	Object		oui	Corps de la requête, sérialisé en JSON.
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.
o	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes).
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : Response<JsonNode>. Une Response : réponse brute avec statut, en-têtes et corps JSON analysé.

Transport.json

JsonNode json(String method, String template, Object body, Map<String, ?> query, RequestOptions o, String... params)

Appel JSON qui renvoie le corps analysé (NullNode pour les corps vides comme un 204).

Nom	Type	Défaut	Requis	Description
method	String		oui	Méthode HTTP, par exemple GET ou POST ; un POST reçoit une Idempotency-Key.
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
body	Object		oui	Corps de la requête, sérialisé en JSON.
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.
o	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes).
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : JsonNode. Le corps analysé, NullNode quand il est vide.

Transport.locale

Locale locale()

Langue des messages du client.

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

Retour : Locale. La Locale du client.

Transport.page

Page<JsonNode> page(String template, Map<String, ?> query, String... params)

GET paginé par curseur.

Nom	Type	Défaut	Requis	Description
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : Page<JsonNode>. Une Page : la première page ; next() rappelle le même gabarit avec le paramètre cursor.

Transport.project

String project()

Slug du projet fixé sur le builder.

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

Retour : String. Le slug du projet, ou null.

Transport.send

Response<InputStream> send(String method, String path, Map<String, ?> query, Object body, RequestOptions o, String accept)

Envoie une requête avec nouvelles tentatives.

Nom	Type	Défaut	Requis	Description
method	String		oui	Méthode HTTP, par exemple GET ou POST ; un POST reçoit une Idempotency-Key.
path	String		oui	Chemin déjà développé, relatif à l'URL de base.
query	Map<String, ?>		oui	Paramètres de la chaîne de requête de la route.
body	Object		oui	Corps de la requête, sérialisé en JSON.
o	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes).
accept	String		oui	Valeur de l'en-tête Accept.

Retour : Response<InputStream>. La réponse réussie ; l'appelant possède le flux du corps et doit le fermer.

Erreurs levées : EaiException.

Transport.sse

SseStream sse(String method, String template, Object body, RequestOptions o, String... params)

Appel SSE : le flux renvoyé doit être fermé.

Nom	Type	Défaut	Requis	Description
method	String		oui	Méthode HTTP, par exemple GET ou POST ; un POST reçoit une Idempotency-Key.
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
body	Object		oui	Corps de la requête, sérialisé en JSON.
o	RequestOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes).
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : SseStream. Un SseStream : lecteur bloquant de Server-Sent Events, à utiliser avec try-with-resources, comme Iterator, Stream ou Flow.Publisher réactif. Un événement data: [DONE] termine le flux.

Transport.tenant

String tenant()

Slug du tenant fixé sur le builder.

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

Retour : String. Le slug du tenant, ou null.

Transport.toString

String toString()

N'affiche jamais la clé d'API ni le jeton.

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

Retour : String. L'URL de base avec la clé d'API et le jeton masqués.

Transport.websocket

CompletableFuture<WebSocket> websocket(String template, WebSocket.Listener listener, String... params)

Ouvre un WebSocket sur template (URL de base http(s) convertie en ws(s)) avec les en-têtes d'authentification.

Nom	Type	Défaut	Requis	Description
template	String		oui	Gabarit de chemin comme /v1/runs/{run_id} ; les marqueurs {name} sont remplis dans l'ordre par params.
listener	WebSocket.Listener		oui	WebSocket.Listener qui reçoit les trames.
params	String...		oui	Champs supplémentaires fusionnés dans la requête.

Retour : CompletableFuture<WebSocket>. Un CompletableFuture terminé par le WebSocket ouvert.

Modèle Transport.Response

Réponse brute : statut, en-têtes et corps.

Champs :

Nom	Type	Requis	Description
status	int	oui	Statut HTTP de la réponse.
headers	HttpHeaders	oui	En-têtes de l'événement, valeurs textuelles. Le contexte de trace y est ajouté.
body	T	oui	Corps de la réponse : flux d'octets, JsonNode analysé ou autre selon l'appel.

Response.header

String header(String name)

Lit un en-tête de la réponse.

Nom	Type	Défaut	Requis	Description
name	String		oui	Nom de l'en-tête, insensible à la casse.

Retour : String. La première valeur de l'en-tête, ou null quand il est absent.