Repository navigation
Conversation
- 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>
PG-Thomas
force-pushed
the
feat/documents-folder-models
branch
from
October 8, 2026 17:22
eb96c02 to
c259b8a
Compare
…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
force-pushed
the
feat/documents-folder-models
branch
from
October 13, 2026 06:59
c259b8a to
69e8599
Compare
🚨 Heads up:
|
🚨 Heads up:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
DocumentsServicecan 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 noDataProjection.The folder routes accept only the
X-UiPath-FolderKeyheader (X-UiPath-FolderPathreturns400 [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
uipath-platformsuite, ruff and mypy pass.invoices-ixp): sync with a folder key and async withUIPATH_FOLDER_KEYboth returned all seven field groups.These routes exist only in Framework API v2, so they always call v2, whatever the
DocumentsFrameworkV2flag says.Version bumped to 0.2.38, because #1929 takes 0.2.37.