io.enterpriseai.resources.PromptsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/PromptsClient.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 PromptsClient
Prompts. Registre de prompts : modèles de prompt versionnés avec variables typées et rendu validé.
Constructeur PromptsClient
PromptsClient(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. |
PromptsClient.create
JsonNode create(Object body)
Publier une version de prompt. Crée un prompt, ou publie une nouvelle version quand le nom existe ; un modèle et des variables identiques ne sont pas dupliqués (la version courante est renvoyée). Le nom est en minuscules, chiffres, ., _, - (1 à 128 caractères, 400 invalid_request sinon). Un emplacement mal fermé, un type de variable inconnu ou un emplacement non déclaré dans variables répond 422 template_error. Demande tenant_admin ou developer. Audité sous prompt.publish.
Route : /v1/prompts (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nom, modèle, description, variables et indication de modèle. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Publier une version de prompt ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.create
JsonNode create(Object body, RequestOptions options)
Publier une version de prompt. Crée un prompt, ou publie une nouvelle version quand le nom existe ; un modèle et des variables identiques ne sont pas dupliqués (la version courante est renvoyée). Le nom est en minuscules, chiffres, ., _, - (1 à 128 caractères, 400 invalid_request sinon). Un emplacement mal fermé, un type de variable inconnu ou un emplacement non déclaré dans variables répond 422 template_error. Demande tenant_admin ou developer. Audité sous prompt.publish.
Route : /v1/prompts (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Nom, modèle, description, variables et indication de modèle. | |
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 « Publier une version de prompt ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.list
Page<JsonNode> list()
Lister les prompts. Prompts du tenant dans l'ordre des noms avec leur dernier numéro de version, paginés avec cursor.
Route : /v1/prompts (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les prompts ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.list
Page<JsonNode> list(Map<String, ?> query)
Lister les prompts. Prompts du tenant dans l'ordre des noms avec leur dernier numéro de version, paginés avec cursor.
Route : /v1/prompts (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les prompts ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.render
JsonNode render(String name, Object body)
Rendre un prompt. Remplit le modèle d'une version (par défaut : la dernière) avec les valeurs données et renvoie text, chars et estimated_tokens (nombre de caractères divisé par 4). Des valeurs obligatoires absentes, de mauvais types, des valeurs hors enum, au-delà de max_length et, avec strict, des variables inconnues répondent 422 missing_variables avec une entrée par problème. 404 not_found pour un prompt ou une version inconnus. Rien n'est enregistré.
Route : /v1/prompts/{name}/render (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du prompt. | |
body | Object | oui | Valeurs des variables, version et mode strict. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Rendre un prompt ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.render
JsonNode render(String name, Object body, RequestOptions options)
Rendre un prompt. Remplit le modèle d'une version (par défaut : la dernière) avec les valeurs données et renvoie text, chars et estimated_tokens (nombre de caractères divisé par 4). Des valeurs obligatoires absentes, de mauvais types, des valeurs hors enum, au-delà de max_length et, avec strict, des variables inconnues répondent 422 missing_variables avec une entrée par problème. 404 not_found pour un prompt ou une version inconnus. Rien n'est enregistré.
Route : /v1/prompts/{name}/render (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du prompt. | |
body | Object | oui | Valeurs des variables, version et mode strict. | |
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 « Rendre un prompt ».
Erreurs levées : les erreurs typées du transport (Erreurs).
PromptsClient.versions
Page<JsonNode> versions(String name)
Lister les versions d'un prompt. Le prompt et toutes ses versions, de la plus récente à la plus ancienne, avec modèle, variables, indication de modèle, empreinte et auteur. 404 not_found.
Route : /v1/prompts/{name}/versions (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du prompt. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les versions d'un prompt ».
Erreurs levées : les erreurs typées du transport (Erreurs).