Repository navigation
feat(uipath-ontology): build ontologies as local solutions [DS-9944] - #4432
diwakar-jha3110 wants to merge 17 commits into
Conversation
|
Consider adding smoke tests before merging. |
skill-lint: 0 new errors, 2 new warnings
What these rules check
Only what this PR adds is listed, compared with the commit it branched from; issues already on the base branch are not. Updated on every push. |
08e587d to
cf84f27
Compare
18a037d to
528ac82
Compare
|
Claude finished @diwakar-jha3110's task in 2m 31s —— View job Review of PR #4432:
|
| Area | Status | Notes |
|---|---|---|
| Frontmatter | OK | Valid; broad Bash grant on the modeler (Low) |
| E2E Tests | OK | smoke + e2e for both skills; blocked on uip ont release |
| Skill Body | Issue | Commands in Updating an existing solution break Critical Rule 1 (#2) |
| References & Assets | Issue | Studio Web flavor points to a nonexistent "Phase 3" (#1); pack-and-deploy.md over the Codex read limit (#4); develop-solution.md contradicts itself (#3) |
| Repo Hygiene | OK | Registries/CODEOWNERS updated; no secrets or personal paths found; one test script has no CODEOWNERS entry |
Issues for Manual Review
- I can't verify the CLI surface:
uip ont *,uip df … --local(choice sets, federated entities,referenceEntityName), and the error codes in the recovery table. It depends on UiPath/cli#5710 and #5798. - Whether
uip solution pack "<SOLUTION_DIR>" "<SOLUTION_DIR>/out"excludes a previousout/folder from the next pack during upgrades. - Self-reference relationships are marked "unverified" at deploy (relationships-guide:82). Confirm whether that should stay in a preview skill or be gated harder.
- Possible trigger overlap between
uipath-ontology-modeleranduipath-platformfor "Data Fabric entity" requests. The boundary activation rows cover it; the activation eval will confirm.
Conclusion
I recommend requesting changes for the Medium items. #1 and #2 are quick fixes, #3 is a contradiction inside uipath-solution that needs a decision, and #4 means moving the new section into its own scenario file. The rest is polish. Once a uip release carries cli#5710 and the CLI-verb and smoke checks go green, the PR looks ready.
|
On the The other review and task-lint items are fixed in 4b1dede, beb25f4, ae84776 and 3291ca0. |
ad7b703 to
2312d4a
Compare
alingherasimuip
left a comment
There was a problem hiding this comment.
Review notes on the ontology skills: two should-fix items, two design questions and one nice-to-have, inline below.
…er [DS-9944] One skill now takes all three inputs: an SDD/PDD or design document, a plain-language domain, or artifact files. Review on #4432 showed the split broke the repo's self-contained rule and cost copied rules, a handoff form and tests that only kept the copies equal. - Document mode: the table-by-table confirmation and the phrase-to-model tables move to references/document-guide.md, which links the type, name and relationship rules instead of copying them. Refused names (Order, Group, C#/VB keywords) are checked while the user approves. - The confirmed model is saved to <WORKDIR>/input/model.md with a CONFIRMED_THROUGH step, every fix goes into it before the next command, and a WORKDIR holding it is resumed. - A FILE field's upgrade cost is told before the user confirms it. - Removed: uipath-ontology-authoring, Delegated mode, the handoff contract and the copy-matching tests. Evals and activation rows move under the modeler; the smoke SDD now names an entity Group and has a file field. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
gabrielavaduva
left a comment
There was a problem hiding this comment.
Approving. Non-blocking follow-ups:
- Artifacts-only mode runs only the per-file check. Tell the user at the end of Stage 5 that the cross-file and service checks run only when the files are built into a solution (Files mode). The Report also assumes a packed solution.
- Artifacts-only still asks for a solution name in Stage 2.
- Rule 17 fires after the solution and entities exist; a one-line
uip ont --helpcheck in Stage 1 would warn before the interview. - Deploy merges into a same-name entity in the target folder; worth telling the deployer to check the folder first.
- The activation baseline (100) was measured before the rename; re-run under
uipath-ontology.
Still needed before merge: rebase on main (conflict in uipath-planner/SKILL.md), green CI once the -dev CLI with uip ont lands, and the PR description could list UiPath/cli#6194 and drop the leftover "modeler" wording.
…lutions [DS-9944] Adds two preview skills over the `uip ont` CLI (UiPath/cli#5710): - uipath-ontology-authoring: turns an SDD, PDD or domain specification into a confirmed domain model (classes, Data Fabric typed properties, relationships, choice sets, federated sources, annotations) and delegates the build to the modeler. - uipath-ontology-modeler: writes the schema (.ofn), SHACL constraints, YARRRML mapping and optional summary/context; authors the entities, choice sets and federated entities locally with `uip df --local`; creates the ontology resource, validates with the ontology service and packs. Also reads a deployed ontology (`uip ont get|list`). The full rule and error recovery table is in references/errors-guide.md. uipath-solution gains the ontology scenario (name conflicts, post-deploy check, install errors) and the local-entity FILE-field upgrade recovery. Registers both skills in skill-status.json, skills.sh.json, CODEOWNERS, the planner skill map and genome checker, with Studio Web flavor stops, activation rows, contract/golden tests and smoke and e2e tasks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…[DS-9944] The CLI now writes ontology entity dependencies as `Entity`, like Data Fabric entities. The assertion already compares kinds lowercased; only the comment described the old spelling. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…facts check [DS-9944] The ontology service retired SHACL constraints (UiPath/ontology a32d5f1ff): it stores them without parsing or using them, and a package needs none. The modeler now writes the schema, mapping and optional summary and context; a constraints file only when the user supplies one or asks. Required, range and value-list rules go in the schema's rdfs:comment, which already lists choice-set values. Follows UiPath/cli#5710: - `uip ont artifacts check <path> [--type]`: the file name decides the type, as in `files add`; --content-type and --file are gone. - SHC-011 (WARNING) and SUM-003 (ERROR) are in the errors guide. - validate's failure Data key is `serviceValidation`. Evals: constraints are no longer required (check_ontology.py, e2e_pack, e2e_sdd_to_pack); smoke_artifacts_only grades the choice-set values in the schema comment and that no constraints file was written. Verified: contract tests (59) pass, and the golden flow passes end to end (service validation and pack included) against a local build of #5710. Merge after #5710: the CLI verb gate needs `uip ont` in the @dev catalog. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…es [DS-9944] Stage 4 showed an inline --body, so agents sometimes skipped the Stage 2 input/entities files; the sdd-handoff smoke task reads them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…pied rules [DS-9944] Authoring kept the approved model only in the conversation, so a compacted or ended session lost it before the modeler wrote anything. It now saves the handoff block to <BASE_DIR>/<ONTOLOGY_NAME>-handoff.md after each confirmed step, resumes from it in Step 1 and delegates from it in Step 5. Authoring's type table lacked the FILE type the modeler supports. Added it, and contract tests now pin every rule authoring restates from the modeler: type tables, name and folder checks, error codes, backing and junction rules. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…er [DS-9944] One skill now takes all three inputs: an SDD/PDD or design document, a plain-language domain, or artifact files. Review on #4432 showed the split broke the repo's self-contained rule and cost copied rules, a handoff form and tests that only kept the copies equal. - Document mode: the table-by-table confirmation and the phrase-to-model tables move to references/document-guide.md, which links the type, name and relationship rules instead of copying them. Refused names (Order, Group, C#/VB keywords) are checked while the user approves. - The confirmed model is saved to <WORKDIR>/input/model.md with a CONFIRMED_THROUGH step, every fix goes into it before the next command, and a WORKDIR holding it is resumed. - A FILE field's upgrade cost is told before the user confirms it. - Removed: uipath-ontology-authoring, Delegated mode, the handoff contract and the copy-matching tests. Evals and activation rows move under the modeler; the smoke SDD now names an entity Group and has a file field. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…odeler [DS-9944]
The planner claims every PDD and SDD ("A PDD always routes here"), so
"build an ontology from this PDD" could stop at the planner, which has no
ontology path yet.
- uipath-planner: redirect an ontology, even from a PDD/SDD, to
uipath-ontology-modeler, and carve ontologies out of the PDD rule, as it
already does for every other build skill.
- uipath-ontology-modeler: its description claims ontology builds and
updates, even from an SDD or PDD.
Both stay inside the 1024-char description and the 1536-char listing cut
(planner 1524, modeler 1037); the contract test pins the wording and the
limits. Invoking /uipath-ontology-modeler directly still works either way.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-only, keep the model current on update [DS-9944] - Being logged out no longer blocks confirming the model: Stage 2 needs no tenant, so login is asked for before Stage 3 instead. - Artifacts-only output takes a document too, confirmed table by table. - An update reads input/model.md, saves each change to it first and marks it built after pack; a built model is updated, not offered for resume. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The activation gate skipped uipath-ontology-modeler ("no baseline"), so CI
never checked that its 25 SDD/PDD/design-document prompts reach it rather
than the planner. Add a provisional baseline of 80 (floor 70%, the suite's
recall.yes threshold); replace it with the measured figure after the first
run.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…easured 100 [DS-9944] The first gate run routed all 52 rows to uipath-ontology-modeler, the 25 SDD/PDD/design-document prompts included (actions/runs/44280682981). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ntology [DS-9944] The skill now covers every way into an ontology (a document, plain words or artifact files), so it takes the product name, as review suggested. Folder, frontmatter, Studio Web flavor, evals, activation rows and gate baseline, planner redirect and genome list, skill status, skills.sh, README and CODEOWNERS follow. The CLI's telemetry list needs the new name too (separate PR in UiPath/cli). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…S-9944] Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…DS-9944] The resource builder still reports Updated when a new remote import also changes resources already in the solution (their dependency links, or hidden resources), so the status line lists all three values again. A resource already in the solution is still never re-imported (Unchanged). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ke create check [DS-9944] The smoke run on a CLI without `uip ont` showed the agent working around "unknown command 'ont'" and packing the solution without the ontology. Critical Rule 17 and the error tables now say: stop, ask the user to update uip, report what is done; never pack, refresh or import to work around it. The check fires on the error, not up front, so Stages 1-4 still run on an older CLI. The smoke task's "created with the local CLI" check needed two matching Bash calls; the agent created the choice set and the entities in one script, so it matched once although every resource existed. It is now two checks, one per kind, each needing one match. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…e [DS-9944] Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…without a solution, warn about same-name entities [DS-9944] From review: Stage 1 runs `uip ont --help` in every mode so an old uip stops before the interview. Artifacts-only no longer asks for a solution, gets its own report saying the cross-file and service checks did not run, and resumes at Stage 5. The deploy handoff tells the user to check the target folder for same-name entities. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
8f8f0ce to
daa024a
Compare
Jira: DS-9944
Summary
Adds one skill,
uipath-ontology, that builds a UiPath ontology as a local solution, driven only by theuipCLI, and teachesuipath-solutionto deploy a solution that carries one.uipath-ontology: from an SDD/PDD or design document, a plain-language domain, or existing artifact files, models the domain and builds the solution: local Data Fabric entities, relationships, choice sets and federated entities (uip df … --local), the ontology artifacts (OWL schema, YARRRML mapping, optional summary and context) checked withuip ont artifacts check <path>, the ontology resource (uip ont create --local), validation (uip ont validate --local), the attached zip (uip ont files add), thenuip solution pack. It stops after pack. Nothing is created on a tenant before deploy.Constraints are optional. The ontology service retired SHACL constraints (UiPath/ontology
a32d5f1ff): it stores them without parsing or using them, and a package needs none. The skill writes a constraints file only when the user supplies one or asks; required, range and value-list rules go in the schema'srdfs:comment. The eval tasks no longer require one.Document mode (
references/document-guide.md): reads an SDD/PDD/design document and confirms the model one table at a time (concepts, properties and relationships, labels). Refused entity names (Order,Group, C#/VB keywords) are caught while the user approves, and aFILEfield's upgrade cost is told before it is confirmed. This was a separateuipath-ontology-authoringskill until review: one skill keeps the repo's self-contained rule and needs no handoff form or copied rules.Saved model: the confirmed model is written to
<WORKDIR>/input/model.mdwith aCONFIRMED_THROUGHstep, every later fix goes into it first, and a folder holding it is resumed in a new session.uipath-solution(pack-and-deploy.md,develop-solution.md): deploying an ontology solution, ontology name conflicts (Replace/RenameInSolution), and which properties a deployer can edit (name,displayName,description). The folder-scoped entity flow for other solutions (uip df entities create --folder-key, thenresources add --source remote) is unchanged.The attached ontology zip lives under
resources/files/(the layout from UiPath/Automation.Solutions#10268); the skill never writes there by hand.Studio Web: not available by design. The Studio Web flavor stops with a "use the local
uipCLI" message before any file or command; ontologies are built only with the local CLI. Non-ontology PDD/SDD requests still go touipath-plannerthere.The skill is
previewinassets/skill-status.json;skills.sh.jsonand CODEOWNERS are updated.Depends on (do not merge before)
uip ont): merged intocli/main. UiPath/cli#5798 (Data Fabric--localchoice sets, reference fields and federated entities) and UiPath/Automation.Solutions#10268 (attached resource files) have merged; #5710 carries the resource builder build that packs the attached zip.uipath-ontologyin CLI telemetry (SKILL_ATTRIBUTION). Not a merge blocker: until it ships,uip ontcalls from this skill carry no SkillName.Remaining blocker
The CLI verb gate (and its per-skill
skills/uipath-ontology/skills/uipath-solutionjobs) and Run skill smoke tests fail untiluip ontis in the@devCLI on GitHub Packages, which both read: the verb gate throughassets/uip-catalog-snapshot.json, the smoke image directly. cli#5710 has merged, butcli/maincan't publish a-devCLI until UiPath/cli#6173 clears the repo-widepicomatchaudit failure. After that, a-devbuild withontology-toolis published, the nightlyrefresh-uip-catalogrun addsuip ontto the snapshot onmain, and a re-run of these checks clears them. No stableuiprelease is needed.Every other check should be green.
Testing
tests/scripts/test_ontology_skill_contract.py: 69 passed. It pins the stage order, the commands each stage runs, the error table, Document mode and the saved model, and that nothing of the old two-skill split is left.tests/scripts/test_ontology_solution_golden.py, run against a build of cli#5710 (published SDK 1.8.4 and resource builder): the golden SalesOrder/Customer flow (choice set with values, aCHOICE_SET_SINGLEfield, aRELATIONSHIP, a federated entity over a native one, the five artifacts (the fixture supplies a constraints file, as Files mode allows), each checked withuip ont artifacts check <path>,XF-019fix loop,files add, service validation on alpha, pack,ont files list --package) passes, and checks the packed resources and theirdependencies[]; a class mapped over the federated entity validates. It needs auipbuild with cli#5710 (stable or preview: everyuip ontcommand ships on stable builds); with an older build, which has nouip ont create, the test skips.uipath-ontology:smoke_artifacts_only,e2e_pack,smoke_sdd_documentande2e_sdd_to_pack. The two SDD tasks check thatinput/model.mdis saved; the smoke SDD names an entityGroup(must be renamed before any create) and has aFILEfield. Not run yet after the merge: they need the@devCLI withuip ont(see Remaining blocker). Besides the CLI checks, three of them grade the schema's classes withcheck_ontology.py classes: each class is declared, labelled, commented and the domain of a property (the smoke task by name, the e2e tasks by count).tests/scripts/test_check_ontology_classes.py: 13 passed, against the golden schema and broken copies of it, plus therelatescheck on entity resources; runs in the ontology CI job.uipath-ontology(runs 44284706628, 44293074603); baseline 100. One row set for the skill, document prompts included, plus boundary rows that keep a tenant entity create (uipath-platform) and deploying a packed ontology solution (uipath-solution) with their own skills.test-helpers.yml(skips withoutUIP_CLI); the skill is registered in the genome checker and the Studio Web browser-command allow list.npm run skills:validateandskills:check-links: clean.skills:test: one local failure incompose-skill-flavor.test.mjs(annpm packpublish-registry check that depends on the local npm setup); it fails the same way on the commit before these changes.check-skill-status,check-skills-sh,check-sensitive-content,check-task-host-paths: clean.🤖 Generated with Claude Code