io.enterpriseai.resources.GatewayClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/GatewayClient.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 GatewayClient
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 GatewayClient
GatewayClient(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. |
GatewayClient.audioSpeech
byte[] audioSpeech(Object body)
Synthétiser de la parole à partir d'un texte. Synthèse vocale par l'adaptateur TTS, au format OpenAI audio/speech ; l'audio est renvoyé tel quel (audio/*). Le kill switch du tenant, la classification des données et l'habilitation de l'appelant, l'isolation des secrets et l'audit s'appliquent, et le coût est réservé sur les quotas selon le nombre de caractères. Demande un principal de tenant avec le scope models:invoke. Sans adaptateur configuré : 501 adapter_not_available ; adaptateur injoignable : 502 upstream_error.
Route : /v1/gateway/audio/speech (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de synthèse OpenAI (model, input, voice, response_format...) plus l'objet facultatif eai (data_classification, agent_id, run_id). |
Retour : byte[]. Réponse JSON décodée de l'opération « Synthétiser de la parole à partir d'un texte ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.audioTranscriptions
JsonNode audioTranscriptions(Object body)
Transcrire un fichier audio. Transcription par l'adaptateur STT, au format OpenAI audio/transcriptions. Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/audio/transcriptions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Multipart file plus model, language, prompt, response_format (json, text, srt, verbose_json, vtt), temperature (de 0 à 1), timestamp_granularities (word, segment) et eai (un objet JSON sous forme de texte) ; ou JSON avec content_base64, mime_type, filename et les mêmes champs. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Transcrire un fichier audio ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.audioTranscriptions
JsonNode audioTranscriptions(Object body, RequestOptions options)
Transcrire un fichier audio. Transcription par l'adaptateur STT, au format OpenAI audio/transcriptions. Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/audio/transcriptions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Multipart file plus model, language, prompt, response_format (json, text, srt, verbose_json, vtt), temperature (de 0 à 1), timestamp_granularities (word, segment) et eai (un objet JSON sous forme de texte) ; ou JSON avec content_base64, mime_type, filename et les mêmes champs. | |
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 « Transcrire un fichier audio ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletions
ChatResponse chatCompletions(ChatRequest request)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
request | ChatRequest | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). |
Retour : ChatResponse. Réponse JSON décodée de l'opération « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletions
ChatResponse chatCompletions(ChatRequest request, RequestOptions options)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
request | ChatRequest | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : ChatResponse. Réponse JSON décodée de l'opération « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletionsRaw
JsonNode chatCompletionsRaw(Object body)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletionsRaw
JsonNode chatCompletionsRaw(Object body, RequestOptions options)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). | |
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 « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletionsStream
ChatStream chatCompletionsStream(ChatRequest request)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
request | ChatRequest | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). |
Retour : ChatStream. Réponse JSON décodée de l'opération « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.chatCompletionsStream
ChatStream chatCompletionsStream(ChatRequest request, RequestOptions options)
Appeler un modèle de conversation. Complétion de conversation compatible OpenAI à travers chaque contrôle de la passerelle ; avec stream: true la réponse est en Server-Sent Events, et les garde-fous de coût sont vérifiés pendant le flux. Demande un principal de tenant (403 platform_only) dont l'identifiant porte le scope models:invoke.
Route : /v1/gateway/chat/completions (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
request | ChatRequest | oui | Requête de conversation OpenAI (model est l'identifiant du registre, messages, stream, max_tokens, tools...) plus l'objet facultatif eai : data_classification (public, internal par défaut, confidential, restricted, secret), agent_id, session_id, run_id, purpose, project_id, effort, max_cost, fallback_policy et des listes d'autorisation qui ne peuvent que restreindre celles du tenant (provider_allow, model_allow, region_allow). | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : ChatStream. Réponse JSON décodée de l'opération « Appeler un modèle de conversation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.embeddings
JsonNode embeddings(Object body)
Calculer des embeddings. Embeddings compatibles OpenAI à travers les mêmes contrôles que la conversation (kill switches, listes d'autorisation, classification, DLP sur chaque entrée, garde-fous de coût, décision de politique, audit). Le modèle doit déclarer la capacité embeddings et, si dimensions est fourni, la prendre en charge (422 capability_not_supported, 422 embedding_dimensions_invalid). Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/embeddings (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête d'embeddings OpenAI (model, input sous forme de texte ou de liste, dimensions facultatif) plus l'objet facultatif eai. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Calculer des embeddings ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.embeddings
JsonNode embeddings(Object body, RequestOptions options)
Calculer des embeddings. Embeddings compatibles OpenAI à travers les mêmes contrôles que la conversation (kill switches, listes d'autorisation, classification, DLP sur chaque entrée, garde-fous de coût, décision de politique, audit). Le modèle doit déclarer la capacité embeddings et, si dimensions est fourni, la prendre en charge (422 capability_not_supported, 422 embedding_dimensions_invalid). Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/embeddings (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête d'embeddings OpenAI (model, input sous forme de texte ou de liste, dimensions facultatif) plus l'objet facultatif eai. | |
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 « Calculer des embeddings ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.estimate
JsonNode estimate(Object body)
Estimer un appel à la passerelle. Exécute chaque contrôle préalable de la passerelle sans appeler le modèle et renvoie le modèle résolu, l'identifiant de décision, les jetons d'entrée, les jetons de sortie maximaux, l'estimateur, le coût estimé, la limite de coût, les replis, les avertissements et le plan de contexte. Une requête refusée par un contrôle répond la même erreur que l'appel réel. Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/estimate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Le corps de l'appel à estimer, avec kind facultatif (chat, embeddings ou rerank) ; sans kind, il est déduit de input (embeddings) ou query (rerank), sinon conversation. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Estimer un appel à la passerelle ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.estimate
JsonNode estimate(Object body, RequestOptions options)
Estimer un appel à la passerelle. Exécute chaque contrôle préalable de la passerelle sans appeler le modèle et renvoie le modèle résolu, l'identifiant de décision, les jetons d'entrée, les jetons de sortie maximaux, l'estimateur, le coût estimé, la limite de coût, les replis, les avertissements et le plan de contexte. Une requête refusée par un contrôle répond la même erreur que l'appel réel. Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/estimate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Le corps de l'appel à estimer, avec kind facultatif (chat, embeddings ou rerank) ; sans kind, il est déduit de input (embeddings) ou query (rerank), sinon conversation. | |
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 « Estimer un appel à la passerelle ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.imageGenerations
JsonNode imageGenerations(Object body)
Générer des images. Génération d'images par l'adaptateur d'images au format OpenAI. Le prompt passe par la DLP du tenant (422 dlp_blocked), le kill switch, la classification, l'isolation des secrets et l'audit s'appliquent, et le coût est réservé selon le nombre d'images ; les champs texte de la réponse (revised_prompt) sont aussi analysés. Demande un principal de tenant avec le scope models:invoke. Sans adaptateur configuré : 501 adapter_not_available.
Route : /v1/gateway/images/generations (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête d'image OpenAI (model, prompt, n, size...) plus l'objet facultatif eai. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Générer des images ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.imageGenerations
JsonNode imageGenerations(Object body, RequestOptions options)
Générer des images. Génération d'images par l'adaptateur d'images au format OpenAI. Le prompt passe par la DLP du tenant (422 dlp_blocked), le kill switch, la classification, l'isolation des secrets et l'audit s'appliquent, et le coût est réservé selon le nombre d'images ; les champs texte de la réponse (revised_prompt) sont aussi analysés. Demande un principal de tenant avec le scope models:invoke. Sans adaptateur configuré : 501 adapter_not_available.
Route : /v1/gateway/images/generations (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête d'image OpenAI (model, prompt, n, size...) plus l'objet facultatif eai. | |
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 « Générer des images ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.rerank
JsonNode rerank(Object body)
Réordonner des documents. Réordonne des documents par rapport à une query à travers les mêmes contrôles que la conversation (DLP sur la requête, garde-fous de coût, décision de politique, audit). Le modèle doit déclarer la capacité rerank (422 capability_not_supported). Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/rerank (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de réordonnancement : model, query, documents (textes ou objets), top_n facultatif, plus l'objet facultatif eai. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Réordonner des documents ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.rerank
JsonNode rerank(Object body, RequestOptions options)
Réordonner des documents. Réordonne des documents par rapport à une query à travers les mêmes contrôles que la conversation (DLP sur la requête, garde-fous de coût, décision de politique, audit). Le modèle doit déclarer la capacité rerank (422 capability_not_supported). Demande un principal de tenant avec le scope models:invoke.
Route : /v1/gateway/rerank (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de réordonnancement : model, query, documents (textes ou objets), top_n facultatif, plus l'objet facultatif eai. | |
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éordonner des documents ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.videoGeneration
JsonNode videoGeneration(String id)
Lire une tâche de génération de vidéo. État et résultat d'une tâche de génération de vidéo, lus auprès de l'adaptateur vidéo avec le même kill switch et le même audit que les autres appels d'adaptateur. Demande un principal de tenant (403 platform_only sinon) dont l'identifiant porte le scope models:invoke. Sans adaptateur vidéo configuré : 501 adapter_not_available.
Route : /v1/gateway/video/generations/{job_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Identifiant de la tâche renvoyé par POST /v1/gateway/video/generations. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire une tâche de génération de vidéo ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.videoGenerations
JsonNode videoGenerations(Object body)
Lancer une génération de vidéo. Lance une tâche de génération de vidéo sur l'adaptateur vidéo, avec le même kill switch, la même classification, la même DLP du prompt, la même réservation de coût et le même audit que les autres adaptateurs ; lisez la tâche avec GET /v1/gateway/video/generations/{job_id}. Demande un principal de tenant avec le scope models:invoke. Sans adaptateur configuré : 501 adapter_not_available.
Route : /v1/gateway/video/generations (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de génération de vidéo de l'adaptateur (model, prompt et ses options) plus l'objet facultatif eai. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer une génération de vidéo ».
Erreurs levées : les erreurs typées du transport (Erreurs).
GatewayClient.videoGenerations
JsonNode videoGenerations(Object body, RequestOptions options)
Lancer une génération de vidéo. Lance une tâche de génération de vidéo sur l'adaptateur vidéo, avec le même kill switch, la même classification, la même DLP du prompt, la même réservation de coût et le même audit que les autres adaptateurs ; lisez la tâche avec GET /v1/gateway/video/generations/{job_id}. Demande un principal de tenant avec le scope models:invoke. Sans adaptateur configuré : 501 adapter_not_available.
Route : /v1/gateway/video/generations (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Requête de génération de vidéo de l'adaptateur (model, prompt et ses options) plus l'objet facultatif eai. | |
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 « Lancer une génération de vidéo ».
Erreurs levées : les erreurs typées du transport (Erreurs).