Document Understanding

Service for the Document Understanding validation-station flow.

Starts a human validation action for an extraction result and reads back the long-running operation until the validator submits. Validation activities

Usage¶

Prerequisites: Initialize the SDK first - see Getting Started

import { DocumentUnderstanding } from '@uipath/uipath-typescript/document-understanding';

const validation = new DocumentUnderstanding(sdk);

Methods¶

getExtractionValidationResult()¶

getExtractionValidationResult(projectId: string, tag: string, documentTypeId: string, operationId: string, options?: DuValidationRequestOptions): Promise<DuValidationGetResponse>

Reads the current state of a validation operation started by startExtractionValidation.

Poll this until status leaves NotStarted/Running; a Succeeded operation carries the validated extraction result in result.

Parameters¶

Parameter	Type	Description
`projectId`	`string`	DU project (modern project) identifier.
`tag`	`string`	Project version tag the document type belongs to.
`documentTypeId`	`string`	Document type identifier within the project.
`operationId`	`string`	Operation id returned by startExtractionValidation.
`options?`	`DuValidationRequestOptions`	Optional framework API version override.

Returns¶

Promise<DuValidationGetResponse>

Promise resolving to the DuValidationGetResponse operation snapshot.

Example¶

const result = await validation.getExtractionValidationResult(
  '<projectId>',
  '<tag>',
  '<documentTypeId>',
  operationId,
);
// Poll until result.status is no longer 'NotStarted' or 'Running'

startExtractionValidation()¶

startExtractionValidation(projectId: string, tag: string, documentTypeId: string, request: DuValidationStartRequest, options?: DuValidationRequestOptions): Promise<DuValidationStartResponse>

Starts a validation action for an extraction result.

Parameters¶

Parameter	Type	Description
`projectId`	`string`	DU project (modern project) identifier.
`tag`	`string`	Project version tag the document type belongs to.
`documentTypeId`	`string`	Document type identifier within the project.
`request`	`DuValidationStartRequest`	Extraction result plus the action metadata (title, catalog, storage).
`options?`	`DuValidationRequestOptions`	Optional framework API version override.

Returns¶

Promise<DuValidationStartResponse>

Promise resolving to a DuValidationStartResponse carrying the operationId to poll.

Example¶

const { operationId } = await validation.startExtractionValidation(
  '<projectId>',
  '<tag>',
  '<documentTypeId>',
  { documentId: '<documentId>', actionTitle: 'Review invoice', extractionResult: result },
);