Aller au contenu principal

enterprise_ai.packs.scaffold

Source : sdks/python/src/enterprise_ai/packs/scaffold.py. Retour à l'index de la référence du SDK Python.

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.

Modèle Domain​

Domaine métier proposé par create_pack (banking, hr, finance...) : titres, entité gérée et système source.

Champs :

NomTypeRequisDescription
slugstrouiIdentifiant du domaine, l'argument domain de create_pack.
title_enstrouiTitre anglais du domaine.
title_frstrouiTitre français du domaine.
entitystrouiIdentifiant pluriel des enregistrements gérés, utilisé dans les portées <name>.<entity>.read et .write, par exemple invoices.
entity_enstrouiNom anglais d'un enregistrement, par exemple invoice.
entity_frstrouiNom français d'un enregistrement, par exemple facture.
systemstrouiSystème source du connecteur simulé, par exemple erp ou crm ; remplace __SYSTEM__ dans les noms de fichiers.
classificationstrnonClassification des données du pack généré (confidential par défaut, internal pour it et marketing).

Fonctions​

template_files​

template_files() -> dict[str, Path]

Chemin cible relatif (avec les jetons NAME, IDENT, SYSTEM) vers le fichier gabarit.

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

Retour : dict[str, Path]. Dict du chemin cible relatif (sans .tmpl) vers le fichier .tmpl du gabarit fourni.

create_pack​

create_pack(domain: str, directory: str | Path, name: str | None = None, owner: str = 'pack-team', version: str = '1.0.0', force: bool = False, lock: str | None = None) -> list[Path]

Écrit les fichiers du pack dans directory. lock : contenu de requirements.txt (épinglé avec empreintes).

NomTypeDéfautRequisDescription
domainstrouiSlug d'un Domain connu (banking, risk-compliance, legal, it, cybersecurity, sales-crm, marketing, procurement, support, document-intelligence, hr, finance).
directorystr | PathouiDossier cible ; s'il existe et n'est pas vide, FileExistsError est levée sauf avec force.
namestr | NoneNonenonNom du pack, lettres minuscules, chiffres et tirets (42 caractères au plus) ; par défaut le slug du domaine.
ownerstr'pack-team'nonÉquipe propriétaire inscrite dans le manifeste (pack-team par défaut).
versionstr'1.0.0'nonVersion du pack (1.0.0 par défaut).
forceboolFalsenonÉcrit dans un dossier non vide en écrasant les fichiers du gabarit (False par défaut).
lockstr | NoneNonenonContenu écrit dans requirements.txt, facultatif.

Retour : list[Path]. Chemins des fichiers écrits.

Erreurs levées : FileExistsError, ValueError.