feat(agent): add ontology binding to Data Fabric context config by sankalp-uipath · Pull Request #1728 · UiPath/uipath-python

sankalp-uipath · 2026-06-17T09:22:00Z

What

Adds Data Fabric ontology binding to the agent context model: a context can carry one or more ontologies that the runtime fetches to ground Text2SQL.

agent/models/agent.py — AgentContextResourceConfig.ontology_set (alias ontologySet), a list of DataFabricOntologyItem nested in the context alongside entitySet.
platform/entities/entities.py — DataFabricOntologyItem ({name, folderId, referenceKey?, description?}), mirroring DataFabricEntityItem; exported from platform.entities.
platform/entities/_entities_service.py — get_ontology_file_async(ontology_name, file_type="owl", folder_key=None): validates name and file_type, hits GET datafabric_/api/ontologies/{name}/files/{type} on the authenticated, folder-scoped client.

Why

An ontology is part of a Data Fabric context — domain knowledge over the same entities — so it is configured inline on the context (a sibling of entitySet), mirroring how entities are bound. Each ontology carries its own folderId so it can live in a different folder from the entities.

Notes

Additive + backward compatible: ontology_set defaults to None.
Path-injection guard: ontology name (^[a-z][a-z0-9-]{0,63}$) and file_type (owl/r2rml/shacl/summary/context) are allowlisted before entering the URL.
Tests: nested ontologySet parse/dump, required folderId per item, backward-compat default, full-AgentDefinition normalization; get_ontology_file_async covered for spec, folder header, file types, rejected name/type.
Consumed by uipath-langchain PR feat: add integration service invocation support #911.
Release: uipath → 2.11.13, uipath-platform → 0.1.77, pin uipath-platform>=0.1.77; lockfiles relocked.

Development Packages

uipath-platform

[project]
dependencies = [
  # Exact version (copy-paste ready):
  "uipath-platform==0.1.80.dev1017286987",

  # Any version from this PR (uncomment to use a range instead):
  # "uipath-platform>=0.1.80.dev1017280000,<0.1.80.dev1017290000",
]

[[tool.uv.index]]
name = "testpypi"
url = "https://test.pypi.org/simple/"
publish-url = "https://test.pypi.org/legacy/"
explicit = true

[tool.uv.sources]
uipath-platform = { index = "testpypi" }

uipath

[project]
dependencies = [
  # Exact version (copy-paste ready):
  "uipath==2.11.15.dev1017286987",

  # Any version from this PR (uncomment to use a range instead):
  # "uipath>=2.11.15.dev1017280000,<2.11.15.dev1017290000",
]

[[tool.uv.index]]
name = "testpypi"
url = "https://test.pypi.org/simple/"
publish-url = "https://test.pypi.org/legacy/"
explicit = true

[tool.uv.sources]
uipath = { index = "testpypi" }
uipath-platform = { index = "testpypi" }

[tool.uv]
override-dependencies = ["uipath-platform==0.1.80.dev1017286987"]

…ic service

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

…-ontology-binding # Conflicts: # packages/uipath-platform/src/uipath/platform/entities/_entities_service.py

…older_key_headers

…verage

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

+    async def get_ontology_file_async(
+        self,


Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-06-23T06:34:39Z

🚨 Heads up: `uipath-integrations` cross-tests are FAILING 🚨

Your changes may break one or more integrations in uipath-integrations-python:

uipath-openai-agents
uipath-google-adk
uipath-agent-framework
uipath-llamaindex
uipath-pydantic-ai

⚠️ These checks are NOT enforced by branch protection rules. Please review the failures before merging.

🔍 Inspect the failed run →

…-ontology-binding # Conflicts: # packages/uipath-platform/pyproject.toml # packages/uipath-platform/uv.lock # packages/uipath/pyproject.toml # packages/uipath/uv.lock

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 8 changed files in this pull request and generated no new comments.

… platform 0.1.78)

UIPath-Harshit · 2026-06-26T06:04:43Z

+# with a letter, max 64 chars. The name becomes a URL path segment.
+_ONTOLOGY_NAME_RE = re.compile(r"^[a-z][a-z0-9-]{0,63}$")
+# Allowed ontology component file types (also URL path segments).
+_ONTOLOGY_FILE_TYPES = frozenset({"owl", "r2rml", "shacl", "summary", "context"})


Whats the rationale here?

removed them , my bad, QE already does these validations , so this was redundant.

UIPath-Harshit · 2026-06-26T06:05:47Z

+            This method is currently experimental. Behavior and parameters are
+            subject to change in future versions.
+
+        Ontologies are served by the same QueryEngine service as entity SQL


Remove this implementation detail from the doc

UIPath-Harshit · 2026-06-26T06:06:44Z

+        self._validate_ontology_name(ontology_name)
+        self._validate_file_type(file_type)
+        spec = self._ontology_file_spec(ontology_name, file_type)
+        headers = {"Accept": "application/json", **header_folder(folder_key, None)}


Do you need this? Generally its handled by the spec method through base class.

Agreed, removed the redundant accept, and moved folder headers to request spec. please review again.

UIPath-Harshit · 2026-06-26T06:07:37Z

+        return response.json()
+
+    @staticmethod
+    def _validate_ontology_name(ontology_name: str) -> None:


All these helper methods needs to move away from this file. I would suggest to create entities_ontology_service separately and consume just the ontology methods from this class.

agreed
Among the helpers method validate name and filetype are deleted as per the previous comment, I have moved spec method to _entity_ontology_service and also added fetch logic there
Now get_ontology_file_async is a just thin method calling method from _entity_ontology_service.

UIPath-Harshit · 2026-06-26T06:08:04Z

    description: Optional[str] = None


+class DataFabricOntologyItem(BaseModel):


Same for this. Move it to entities_ontology_service

UIPath-Harshit · 2026-06-26T06:08:52Z

+    )
+
+    name: str
+    ontology_key: Optional[str] = Field(None, alias="referenceKey")


Ontology is not solution aware at this point. Does it make sense for this to come from here?

Sorry I didn't get you why ontology not being solution aware will cause issue, currently folder id is just for scoping and coming from agent.json

UIPath-Harshit · 2026-06-26T06:09:56Z

        None, description="Context settings"
    )
    entity_set: Optional[List[DataFabricEntityItem]] = Field(None, alias="entitySet")
+    ontology_set: Optional[List[DataFabricOntologyItem]] = Field(


Is the plan to add set of ontologies or single ontology ? Set doesnt make sense to me , but let me know if that decision has already been settled. cc: @milind-jain-uipath

Please correct me if am wrong @milind-jain-uipath
Yes plan is to allow users to add set of ontologies

github-actions · 2026-06-27T18:01:39Z

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨

Your changes may break the uipath-langchain-python integration.

⚠️ These checks are NOT enforced by branch protection rules. Please review the failures before merging.

🔍 Inspect the failed run →

sonarqubecloud · 2026-06-27T21:27:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

feat(agent): add ontology binding to Data Fabric context config

8badd70

Copilot AI review requested due to automatic review settings June 17, 2026 09:22

github-actions Bot added test:uipath-langchain Triggers tests in the uipath-langchain-python repository test:uipath-integrations labels Jun 17, 2026

Copilot started reviewing on behalf of sankalp-uipath June 17, 2026 09:22 View session

This comment was marked as outdated.

Sign in to view

milind-jain-uipath reviewed Jun 17, 2026

View reviewed changes

Comment thread packages/uipath/src/uipath/agent/models/agent.py Outdated

milind-jain-uipath requested changes Jun 17, 2026

View reviewed changes

sankalp-uipath and others added 4 commits June 17, 2026 15:22

feat(entities): add ontology binding + get_ontology_file to Data Fabr…

906d618

…ic service

feat(agent): allow multiple ontologies per context (ontologySet)

cd4ff88

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Merge remote-tracking branch 'origin/main' into feat/agent-datafabric…

8175316

…-ontology-binding # Conflicts: # packages/uipath-platform/src/uipath/platform/entities/_entities_service.py

fix(entities): scope ontology fetch via header_folder, not missing _f…

2048c56

…older_key_headers

sankalp-uipath requested a review from Copilot June 22, 2026 08:13

Copilot started reviewing on behalf of sankalp-uipath June 22, 2026 08:13 View session

This comment was marked as outdated.

Sign in to view

sankalp-uipath added 2 commits June 22, 2026 18:05

feat(entities): validate ontology file_type; require folderId; add co…

28d3c0c

…verage

Merge branch 'main' into feat/agent-datafabric-ontology-binding

33f76f0

sankalp-uipath added the build:dev Create a dev build from the pr label Jun 22, 2026

sankalp-uipath requested a review from Copilot June 22, 2026 20:15

Copilot started reviewing on behalf of sankalp-uipath June 22, 2026 20:16 View session

Copilot AI reviewed Jun 22, 2026

View reviewed changes

Comment thread packages/uipath-platform/src/uipath/platform/entities/_entities_service.py

Comment on lines +1112 to +1113

async def get_ontology_file_async(

self,

Comment thread packages/uipath-platform/src/uipath/platform/entities/_entities_service.py

sankalp-uipath and others added 4 commits June 23, 2026 02:45

chore: bump uipath to 2.11.8 and uipath-platform to 0.1.72

d4ccd79

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

docs(entities): mark get_ontology_file_async as Preview Feature

f22074c

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Merge branch 'main' into feat/agent-datafabric-ontology-binding

74d47bb

chore: bump uipath to 2.11.9 (main advanced to 2.11.8)

bcbf2dd

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

sankalp-uipath requested a review from milind-jain-uipath June 23, 2026 07:39

sankalp-uipath and others added 3 commits June 23, 2026 18:18

feat(agent): ontology as standalone resource (ontologyRefs)

75aaab5

Merge remote-tracking branch 'origin/main' into feat/agent-datafabric…

336bfb3

…-ontology-binding # Conflicts: # packages/uipath-platform/pyproject.toml # packages/uipath-platform/uv.lock # packages/uipath/pyproject.toml # packages/uipath/uv.lock

test: annotate parsed for mypy (var-annotated)

c231702

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

sankalp-uipath requested a review from Copilot June 23, 2026 14:06

Copilot started reviewing on behalf of sankalp-uipath June 23, 2026 14:07 View session

Copilot AI reviewed Jun 23, 2026

View reviewed changes

sankalp-uipath added 4 commits June 24, 2026 12:21

Merge branch 'main' into feat/agent-datafabric-ontology-binding

2fe9114

chore: bump uipath to 2.11.11 (above main)

6877f6a

refactor(agent): nest ontology as ontologySet on context

69d42df

chore: merge main; bump uipath 2.11.13 / platform 0.1.77

1ce9049

sankalp-uipath force-pushed the feat/agent-datafabric-ontology-binding branch from 9ee4757 to 1ce9049 Compare June 25, 2026 08:30

sankalp-uipath added 3 commits June 25, 2026 14:46

Merge branch 'main' into feat/agent-datafabric-ontology-binding

9e22841

refactor(agent): model ontology as a datafabricontology context (bump…

b6f0c9a

… platform 0.1.78)

chore: merge main; bump uipath 2.11.14 / platform 0.1.79 (above main)

56ac4a4

UIPath-Harshit reviewed Jun 26, 2026

View reviewed changes

Merge branch 'main' into feat/agent-datafabric-ontology-binding

ee66ada

sankalp-uipath force-pushed the feat/agent-datafabric-ontology-binding branch from 70606dc to 941a175 Compare June 27, 2026 12:57

sankalp-uipath force-pushed the feat/agent-datafabric-ontology-binding branch from 941a175 to 9b6f320 Compare June 27, 2026 20:55

refactor(entities): extract ontology fetch into EntityOntologyService

e98f5a1

sankalp-uipath force-pushed the feat/agent-datafabric-ontology-binding branch from 9b6f320 to e98f5a1 Compare June 27, 2026 21:22

		description: Optional[str] = None


		class DataFabricOntologyItem(BaseModel):

Uh oh!

Conversation

sankalp-uipath commented Jun 17, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

Notes

Development Packages

uipath-platform

uipath

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

github-actions Bot commented Jun 23, 2026

🚨 Heads up: uipath-integrations cross-tests are FAILING 🚨

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sankalp-uipath Jun 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sankalp-uipath Jun 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 27, 2026

🚨 Heads up: uipath-langchain cross-tests are FAILING 🚨

Uh oh!

sonarqubecloud Bot commented Jun 27, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sankalp-uipath commented Jun 17, 2026 •

edited by github-actions Bot

Loading

🚨 Heads up: `uipath-integrations` cross-tests are FAILING 🚨

sankalp-uipath Jun 27, 2026 •

edited

Loading

sankalp-uipath Jun 27, 2026 •

edited

Loading

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨