Skip to content

feat(documents): extract with IXP models deployed to a folder - #1933

Draft
PG-Thomas wants to merge 10 commits into
mainfrom
feat/documents-folder-models
Draft

PG-Thomas wants to merge 10 commits into
mainfrom
feat/documents-folder-models

Conversation

@PG-Thomas

@PG-Thomas PG-Thomas commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

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.

alexandrujircan and others added 2 commits October 7, 2026 12:43
- send api-version=2.0 and use the v2 tags/{tag} routes
- read PascalCase responses, which v2 returns for orgs with
  du-enable-v2-pascal-case-responses on
- percent-encode URL path segments, so a tag cannot change the route
- send allowChangeOfDocumentType inside the validation configuration
- add the FieldGroup and MonetaryQuantity field types returned by IXP v2

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

- pick versioned or tagged routes in one helper per route family instead of
  repeating the branch in every sync and async method
- share the operation status check between the sync and async retrieve
- regenerate the uipath lockfile for uipath-platform 0.2.35
- document that field IDs are prefixed by document type and field group

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
alexandrujircan and others added 8 commits October 12, 2026 12:10
…kV2 flag

- call Framework API v1.1 by default, and v2 when the DocumentsFrameworkV2
  feature flag is on, e.g. UIPATH_FEATURE_DocumentsFrameworkV2=true
- read the flag once per service instance, so one operation and the resume of
  a suspended one use the same API version
- route tags and allowChangeOfDocumentType per API version

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
0.2.35 was released from main in the meantime.

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

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- 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
@PG-Thomas
PG-Thomas force-pushed the feat/documents-folder-models branch from c259b8a to 69e8599 Compare October 13, 2026 06:59
@github-actions

Copy link
Copy Markdown

🚨 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 →

@github-actions

Copy link
Copy Markdown

🚨 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 →

Base automatically changed from feat/documents-framework-v2 to main November 17, 2026 14:12

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test:uipath-integrations test:uipath-langchain Triggers tests in the uipath-langchain-python repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants