enterprise_ai.packs.scaffold
Source: sdks/python/src/enterprise_ai/packs/scaffold.py. Back to the Python SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Model Domain
Business domain offered by create_pack (banking, hr, finance...): titles, managed entity and source system.
Fields:
| Name | Type | Required | Description |
|---|---|---|---|
slug | str | yes | Identifier of the domain, the domain argument of create_pack. |
title_en | str | yes | English title of the domain. |
title_fr | str | yes | French title of the domain. |
entity | str | yes | Plural identifier of the managed records, used in the scopes <name>.<entity>.read and .write, for example invoices. |
entity_en | str | yes | English name of one record, for example invoice. |
entity_fr | str | yes | French name of one record, for example facture. |
system | str | yes | Source system of the simulated connector, for example erp or crm; replaces __SYSTEM__ in file names. |
classification | str | no | Data classification of the generated pack (default confidential, internal for it and marketing). |
Functions
template_files
template_files() -> dict[str, Path]
Relative target path (with NAME, IDENT, SYSTEM tokens) -> template file.
This element takes no parameter.
Returns: dict[str, Path]. Dict relative target path (without .tmpl) to the .tmpl file of the bundled template.
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]
Write the pack files into directory. lock: content of requirements.txt (pinned with hashes).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
domain | str | yes | Slug of a known Domain (banking, risk-compliance, legal, it, cybersecurity, sales-crm, marketing, procurement, support, document-intelligence, hr, finance). | |
directory | str | Path | yes | Target folder; when it exists and is not empty, FileExistsError is raised unless force. | |
name | str | None | None | no | Pack name, lowercase letters, digits and dashes (at most 42 characters); default the domain slug. |
owner | str | 'pack-team' | no | Owner team written in the manifest (default pack-team). |
version | str | '1.0.0' | no | Version of the pack (default 1.0.0). |
force | bool | False | no | Write into a folder that is not empty, overwriting the template files (default False). |
lock | str | None | None | no | Content written to requirements.txt, optional. |
Returns: list[Path]. Paths of the written files.
Raises: FileExistsError, ValueError.