enterprise_ai.prompts
Source : sdks/python/src/enterprise_ai/prompts/__init__.py. Retour à l'index de la référence du SDK Python.
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é.
Resource
PromptsClient.create
create(name: str, template: str, **extra: Any) -> Any
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 |
|---|---|---|---|---|
name | str | oui | Nom du prompt : minuscules, chiffres, ., _, -, 1 à 128 caractères, commençant et finissant par une lettre ou un chiffre. | |
template | str | oui | Texte du modèle avec des emplacements {{ variable }} (au moins 1 caractère). | |
**extra | Any | non | Champs supplémentaires fusionnés dans le corps de la requête. |
Retour : Any. 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
list(**page: Any) -> Any
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 |
|---|---|---|---|---|
**page | Any | non | Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs. |
Retour : Any. 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
render(name: str, variables: dict[str, Any], version: str | None = None) -> Any
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 | str | oui | Nom du prompt. | |
variables | dict[str, Any] | oui | Valeur de chaque variable, par nom. | |
version | str | None | None | non | Numéro de version à rendre. Par défaut : la dernière. |
Retour : Any. 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
versions(name: str) -> Any
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 | str | oui | Nom du prompt. |
Retour : Any. 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).
Fonctions
variables
variables(template: str) -> list[str]
Noms des variables utilisées sous la forme {{ name }} dans un gabarit.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
template | str | oui | Texte du gabarit. |
Retour : list[str]. Noms triés sans doublons, chemins pointés conservés entiers.
render
render(template: str, values: dict[str, Any], strict: bool = True) -> str
Remplace les marqueurs {{ name }} (chemins pointés autorisés). Les valeurs manquantes lèvent une erreur en mode strict.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
template | str | oui | Texte du gabarit avec des marqueurs {{ name }} ou {{ user.name }}. | |
values | dict[str, Any] | oui | Valeurs par nom ; un chemin pointé parcourt les dicts imbriqués. | |
strict | bool | True | non | Lève KeyError sur une valeur manquante (True par défaut) ; sinon le marqueur est conservé. |
Retour : str. Le texte rendu, chaque valeur convertie avec str.
Erreurs levées : KeyError.