GeezerVison is showing github.com — feat(documents): extract with IXP models deployed to a folder by PG-Thomas · Pull Request #1933 · UiPath/uipath-python
Conversation
PG-Thomas
commented
Oct 8, 2026
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
What
DocumentsService can only reach IXP projects by name and tag. IXP models that a solution deploys into an Orchestrator folder have their own Document Understanding routes (du_/api/framework/models/{name}/...), and the SDK can't call them. This PR adds:
extract_with_model(model_name, file | file_path, folder_key=None) (and _async): digitize, extract, and wait for the result.
ModelExtractionResponse, which carries the model name and the extraction result. Folder models have no project id or tag, and their results have no DataProjection.
The folder routes accept only the X-UiPath-FolderKey header (X-UiPath-FolderPath returns 400 [RequestMissingRequiredField]), so the method takes a folder key and defaults to the current job's folder (UIPATH_FOLDER_KEY). The existing project code is unchanged.
How it was tested
- Unit tests: sync and async, the folder key argument, the current-folder default, an encoded model name, and the error without any folder. The
uipath-platform suite, ruff and mypy pass.
- Live run against a tenant with folder-deployed models (
invoices-ixp): sync with a folder key and async with UIPATH_FOLDER_KEY both returned all seven field groups.
These routes exist only in Framework API v2, so they always call v2, whatever the DocumentsFrameworkV2 flag says.
Version bumped to 0.2.38, because #1929 takes 0.2.37.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
- add extract_with_model on the du_/api/framework/models/{name} routes
- address the model's folder by key, as these routes reject a folder path
header; default to the current folder's key
🚨 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 →
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
🚨 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 →
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This branch has not been deployed
No deployments
Reviewers
Copilot will automatically review once the pull request is marked ready for review
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|