diff --git a/definitions/du.framework.yaml b/definitions/du.framework.yaml index 83e92c5..320b741 100644 --- a/definitions/du.framework.yaml +++ b/definitions/du.framework.yaml @@ -9,7 +9,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve all available projects from Document Understanding.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve all available projects from Document Understanding.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetProjects parameters: - name: api-version @@ -22,7 +22,7 @@ paths: type: string responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -58,7 +58,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -70,7 +70,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -87,7 +87,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve details about a specific project from Document Understanding.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve details about a specific project from Document Understanding.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetProjectById parameters: - name: api-version @@ -105,9 +105,12 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 + - name: projectVersion + in: query + description: Version of the Project. responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -143,7 +146,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -155,7 +158,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -172,7 +175,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve all document types from a project.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve all document types from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetDocumentTypes parameters: - name: api-version @@ -192,7 +195,7 @@ paths: default: 00000000-0000-0000-0000-000000000000 responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -240,7 +243,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -252,7 +255,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -269,7 +272,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve details about a specific document type from a project.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve details about a specific document type from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetDocumentTypeById parameters: - name: api-version @@ -294,9 +297,12 @@ paths: schema: type: string default: invoices + - name: projectVersion + in: query + description: Version of the Project. responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -344,7 +350,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -356,7 +362,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -373,7 +379,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve all classifiers from a project.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve all classifiers from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetClassifiers parameters: - name: api-version @@ -391,9 +397,12 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 + - name: projectVersion + in: query + description: Version of the Project. responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -441,7 +450,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -453,7 +462,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -470,7 +479,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve details about a specific classifier from a project.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve details about a specific classifier from a project.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetClassifierById parameters: - name: api-version @@ -497,7 +506,7 @@ paths: default: ml-classification responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -545,7 +554,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -557,7 +566,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -574,7 +583,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve all extractors from a project. These can be either Forms AI or deep-learning extraction skills.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve all extractors from a project. These can be either Forms AI or deep-learning extraction skills.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: Extractors parameters: - name: api-version @@ -592,9 +601,12 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 + - name: projectVersion + in: query + description: Version of the Project. responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -642,7 +654,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -654,7 +666,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -671,7 +683,7 @@ paths: tags: - Discovery summary: "" - description: "Retrieve details about a specific extractor from a project. It can be either a Forms AI or a deep-learning extraction skill.\r\n
Required scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + description: "Retrieve details about a specific extractor from a project. It can be either a Forms AI or a deep-learning extraction skill.\r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" operationId: GetExtractorById parameters: - name: api-version @@ -698,7 +710,7 @@ paths: default: invoices responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -758,7 +770,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -770,7 +782,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -782,12 +794,109 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' x-uipathcli-name: extractor-by-id + /projects/{projectId}/tags: + get: + tags: + - Discovery + summary: "" + description: "Retrieve all tags from a project. \r\n\nRequired scopes: Du.Digitization.Api or Du.Classification.Api or Du.Extraction.Api or Du.Validation.Api
" + operationId: Tags + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: ID of the Project. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetTagsResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetTagsResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetTagsResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: tags /projects/{projectId}/digitization/start: post: tags: - Digitization summary: "" - description: "Digitize a document using the OCR settings of the associated Document Understanding project.\r\n
Required scopes: Du.Digitization.Api
" + description: "Digitize a document using the OCR settings of the associated Document Understanding project.\r\n\nRequired scopes: Du.Digitization.Api
" operationId: StartDigitization parameters: - name: api-version @@ -882,7 +991,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "415": - description: Client Error + description: Unsupported Media Type content: text/plain: schema: @@ -894,7 +1003,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -906,7 +1015,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -923,7 +1032,7 @@ paths: tags: - Digitization summary: "" - description: "Get the digitization result of a document.\r\n
Required scopes: Du.Digitization.Api
" + description: "Get the digitization result of a document.\r\n\nRequired scopes: Du.Digitization.Api
" operationId: GetDigitizationResult parameters: - name: api-version @@ -947,17 +1056,17 @@ paths: required: true responses: "200": - description: Success + description: OK content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResponse' "400": description: Bad Request content: @@ -1007,7 +1116,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1019,7 +1128,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1036,7 +1145,7 @@ paths: tags: - Classification summary: "" - description: "Classify a document.\r\n
Required scopes: Du.Classification.Api
" + description: "Classify a document.\r\n\nRequired scopes: Du.Classification.Api
" operationId: Classify parameters: - name: api-version @@ -1069,11 +1178,11 @@ paths: examples: Specialized Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: null Generative Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1085,11 +1194,11 @@ paths: examples: Specialized Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: null Generative Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1101,11 +1210,11 @@ paths: examples: Specialized Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: null Generative Classification: value: - documentId: 49fd166c-e57c-4afa-9c01-66e8e8174963 + documentId: df258d93-3482-4d73-93ae-3825f502a2e9 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1113,7 +1222,7 @@ paths: description: A written acknowledgment of having received a specified amount of money, goods, or services. responses: "200": - description: Success + description: OK content: text/plain: schema: @@ -1173,7 +1282,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1185,7 +1294,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1196,14 +1305,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: Classify - /projects/{projectId}/classifiers/{classifierId}/classification/start: + x-uipathcli-name: classify + /projects/{projectId}/{tag}/classification: post: tags: - Classification summary: "" - description: "Start classification operation. To monitor the status and retrieve the classification result, use the \"Get Classification Result\" route.\r\n
Required scopes: Du.Classification.Api
" - operationId: StartClassification + description: "Classify a document.\r\n\nRequired scopes: Du.Classification.Api
" + operationId: ClassifyByTag parameters: - name: api-version in: query @@ -1220,13 +1329,10 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: classifierId + - name: tag in: path - description: The identifier of the classifier used for classification. + description: The tag associated with the project version to use for the classification. required: true - schema: - type: string - default: ml-classification requestBody: content: application/json: @@ -1235,11 +1341,11 @@ paths: examples: Specialized Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: null Generative Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1251,11 +1357,11 @@ paths: examples: Specialized Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: null Generative Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. @@ -1267,29 +1373,41 @@ paths: examples: Specialized Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: null Generative Classification: value: - documentId: f52bcef5-f09a-450d-97ef-214693ba92ad + documentId: f4587412-1535-4f3c-9da1-018584f63696 prompts: - name: Invoice description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - name: Receipt description: A written acknowledgment of having received a specified amount of money, goods, or services. responses: - "202": - description: Accepted + "200": + description: OK content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.Classification.ClassificationResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.Classification.ClassificationResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.Classification.ClassificationResponse' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "401": description: Unauthorized content: @@ -1314,8 +1432,20 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1327,7 +1457,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1338,14 +1468,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: start - /projects/{projectId}/classifiers/{classifierId}/classification/result/{operationId}: - get: + x-uipathcli-name: classify-by-tag + /projects/{projectId}/classifiers/{classifierId}/classification/start: + post: tags: - Classification summary: "" - description: "Monitor the status and retrieve the classification result once the operation is completed.\r\n
Required scopes: Du.Classification.Api
" - operationId: GetClassificationResult + description: "Start classification operation. To monitor the status and retrieve the classification result, use the \"Get Classification Result\" route.\r\n\nRequired scopes: Du.Classification.Api
" + operationId: StartClassification parameters: - name: api-version in: query @@ -1369,23 +1499,69 @@ paths: schema: type: string default: ml-classification - - name: operationId - in: path - description: The operation identifier obtained from the START classification route. - required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: null + Generative Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: null + Generative Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' + examples: + Specialized Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: null + Generative Classification: + value: + documentId: ae22702d-6471-4442-9ed7-4dbecc9c4fab + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. responses: - "200": - description: Success + "202": + description: Accepted content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' "401": description: Unauthorized content: @@ -1410,20 +1586,8 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "404": - description: Not Found - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1435,7 +1599,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1446,14 +1610,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: get - /projects/{projectId}/extractors/{extractorId}/extraction: + x-uipathcli-name: start + /projects/{projectId}/{tag}/classification/start: post: tags: - - Extraction + - Classification summary: "" - description: "Extract all fields from a document.\r\n
Required scopes: Du.Extraction.Api
" - operationId: Extract + description: "Start classification by tag operation. To monitor the status and retrieve the classification result, use the \"Get Tag Classification Result\" route.\r\n\nRequired scopes: Du.Classification.Api
" + operationId: StartClassificationByTag parameters: - name: api-version in: query @@ -1465,69 +1629,78 @@ paths: type: string - name: projectId in: path - description: The identifier of the project in which the extractor exists. + description: The identifier of the project in which the classifier exists. required: true schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: extractorId + - name: tag in: path - description: The identifier of the extractor used for extraction. + description: The tag associated with the project version to use for the classification. required: true - schema: - type: string - default: invoices requestBody: content: application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' examples: - Specialized Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":null}' - Generative Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' + Specialized Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: null + Generative Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' examples: - Specialized Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":null}' - Generative Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' + Specialized Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: null + Generative Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. application/*+json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.ClassificationRequestBody' examples: - Specialized Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":null}' - Generative Extraction: - value: '{"documentId":"47c826a7-8dd2-469e-a0b8-8442caad04fd","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' - responses: - "200": - description: Success - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' - "400": - description: Bad Request + Specialized Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: null + Generative Classification: + value: + documentId: 2929a0d4-a86a-49d5-88d9-00f3a58b1eef + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + responses: + "202": + description: Accepted content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.StartClassificationResponse' "401": description: Unauthorized content: @@ -1552,32 +1725,8 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "404": - description: Not Found - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "413": - description: Client Error - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1589,7 +1738,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1600,14 +1749,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: extract - /projects/{projectId}/extractors/{extractorId}/extraction/start: - post: + x-uipathcli-name: start-by-tag + /projects/{projectId}/classifiers/{classifierId}/classification/result/{operationId}: + get: tags: - - Extraction + - Classification summary: "" - description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n
Required scopes: Du.Extraction.Api
" - operationId: StartExtraction + description: "Monitor the status and retrieve the classification result once the operation is completed.\r\n\nRequired scopes: Du.Classification.Api
" + operationId: GetClassificationResult parameters: - name: api-version in: query @@ -1619,57 +1768,35 @@ paths: type: string - name: projectId in: path - description: The identifier of the project in which the extractor exists. + description: The identifier of the project in which the classifier exists. required: true schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: extractorId + - name: classifierId in: path - description: The identifier of the extractor used for extraction. + description: The identifier of the classifier used for classification. required: true schema: type: string - default: invoices - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' - examples: - Specialized Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":null}' - Generative Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' - examples: - Specialized Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":null}' - Generative Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' - application/*+json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' - examples: - Specialized Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":null}' - Generative Extraction: - value: '{"documentId":"56469f43-f9c8-4598-ad9f-c550c0ffde7d","prompts":[{"id":"Invoice Number","question":"Extract the invoice number from the provided document."},{"id":"Date","question":"What is the invoice date mentioned in the document?"},{"id":"Total","question":"Extract the total amount from the invoice."}]}' + default: ml-classification + - name: operationId + in: path + description: The operation identifier obtained from the START classification route. + required: true responses: - "202": - description: Accepted + "200": + description: OK content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' "401": description: Unauthorized content: @@ -1694,8 +1821,20 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1707,7 +1846,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1718,14 +1857,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: start - /projects/{projectId}/extractors/{extractorId}/extraction/result/{operationId}: + x-uipathcli-name: get + /projects/{projectId}/{tag}/classification/result/{operationId}: get: tags: - - Extraction + - Classification summary: "" - description: "Monitor the status and retrieve the extraction result once the operation is completed.\r\n
Required scopes: Du.Extraction.Api
" - operationId: GetExtractionResult + description: "Monitor the status and retrieve the classification result once the operation is completed.\r\n\nRequired scopes: Du.Classification.Api
" + operationId: GetClassificationResultByTag parameters: - name: api-version in: query @@ -1737,35 +1876,32 @@ paths: type: string - name: projectId in: path - description: The identifier of the project in which the extractor exists. + description: The identifier of the project in which the classifier exists. required: true schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: extractorId + - name: tag in: path - description: The identifier of the extractor used for extraction. + description: The tag associated with the project version to use for the classification. required: true - schema: - type: string - default: invoices - name: operationId in: path - description: The operation identifier obtained from the START extraction route. + description: The operation identifier obtained from the START classification route. required: true responses: "200": - description: Success + description: OK content: text/plain: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Classification.SwaggerGetClassificationResultResponse' "401": description: Unauthorized content: @@ -1803,7 +1939,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -1815,7 +1951,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -1826,14 +1962,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: get - /projects/{projectId}/classifiers/{classifierId}/validation/start: + x-uipathcli-name: get-by-tag + /projects/{projectId}/extractors/{extractorId}/extraction: post: tags: - - Validation + - Extraction summary: "" - description: "Start classification validation operation. To monitor the status and retrieve the validation result, use the \"Get Classification Validation Result\" route.\r\n
Required scopes: Du.Validation.Api
" - operationId: StartClassificationValidation + description: "Extract all fields from a document.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: Extract parameters: - name: api-version in: query @@ -1845,170 +1981,2627 @@ paths: type: string - name: projectId in: path - description: The identifier of the project in which the classifier exists. + description: The identifier of the project in which the extractor exists. required: true schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: classifierId + - name: extractorId in: path - description: The identifier of the classifier used for classification. + description: The identifier of the extractor used for extraction. required: true schema: type: string - default: ml-classification + default: invoices requestBody: content: application/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' examples: - Specialized Classification Validation: + Specialized Extraction: value: - classificationResults: - - DocumentTypeId: invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: - TextStartIndex: 0 - TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: - StartPage: 0 - PageCount: 1 - TextStartIndex: 0 - TextLength: 1 - ClassifierName: ML Classification + documentId: d1925eb0-1431-4521-96f9-5996818ff52e prompts: null - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - actionTitle: Title of the action in action center - actionPriority: Low - actionCatalog: default_du_actions - actionFolder: Shared - storageBucketName: du_storage_bucket - storageBucketDirectoryPath: du_storage_bucket - Generative Classification Validation: + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: value: - classificationResults: - - DocumentTypeId: Invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: - TextStartIndex: 0 - TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: - StartPage: 0 - PageCount: 0 - TextStartIndex: 0 - TextLength: 0 - ClassifierName: Generative Classifier + documentId: d1925eb0-1431-4521-96f9-5996818ff52e prompts: - - name: Invoice - description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - - name: Receipt - description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - actionTitle: Title of the action in action center - actionPriority: Low - actionCatalog: default_du_actions - actionFolder: Shared - storageBucketName: du_storage_bucket - storageBucketDirectoryPath: du_storage_bucket + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null text/json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' examples: - Specialized Classification Validation: + Specialized Extraction: value: - classificationResults: - - DocumentTypeId: invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: - TextStartIndex: 0 - TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: - StartPage: 0 - PageCount: 1 - TextStartIndex: 0 - TextLength: 1 - ClassifierName: ML Classification + documentId: d1925eb0-1431-4521-96f9-5996818ff52e prompts: null - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - actionTitle: Title of the action in action center - actionPriority: Low + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: d1925eb0-1431-4521-96f9-5996818ff52e + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: d1925eb0-1431-4521-96f9-5996818ff52e + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: d1925eb0-1431-4521-96f9-5996818ff52e + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "413": + description: Content Too Large + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: extract + /projects/{projectId}/extractors/{extractorId}/extraction/start: + post: + tags: + - Extraction + summary: "" + description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: StartExtraction + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: extractorId + in: path + description: The identifier of the extractor used for extraction. + required: true + schema: + type: string + default: invoices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: b9b447b7-0042-44b6-b509-9d7634b33ce3 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + responses: + "202": + description: Accepted + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: start + /projects/{projectId}/{tag}/document-types/{documentTypeId}/extraction: + post: + tags: + - Extraction + summary: "" + description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: ExtractByDocumentType + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: tag + in: path + description: The tag associated with the project version to use for the extraction. + required: true + - name: documentTypeId + in: path + description: Extraction will be performed using the extractor associated with the document type with this identifier. + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 5a872f69-c09c-47ca-870c-d36851aadd61 + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "413": + description: Content Too Large + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: extract-by-doc-type + /projects/{projectId}/{tag}/document-types/{documentTypeId}/extraction/start: + post: + tags: + - Extraction + summary: "" + description: "Start extraction operation. To monitor the status and retrieve the extraction result, use the \"Get Extraction Result\" route.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: StartByDocumentType + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: tag + in: path + description: The tag associated with the project version to use for the extraction. + required: true + - name: documentTypeId + in: path + description: Extraction will be performed using the extractor associated with the document type with this identifier. + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody' + examples: + Specialized Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: null + configuration: + autoValidationConfidenceThreshold: 70 + Generative Extraction: + value: + documentId: 3b02e6dc-98cd-4a68-a62f-673e36c8625c + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + configuration: null + responses: + "202": + description: Accepted + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.StartExtractionResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: start-by-doc-type + /projects/{projectId}/extractors/{extractorId}/extraction/result/{operationId}: + get: + tags: + - Extraction + summary: "" + description: "Monitor the status and retrieve the extraction result once the operation is completed.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: GetExtractionResult + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: extractorId + in: path + description: The identifier of the extractor used for extraction. + required: true + schema: + type: string + default: invoices + - name: operationId + in: path + description: The operation identifier obtained from the START extraction route. + required: true + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: get + /projects/{projectId}/{tag}/document-types/{documentTypeId}/extraction/result/{operationId}: + get: + tags: + - Extraction + summary: "" + description: "Monitor the status and retrieve the extraction result once the operation is completed.\r\n\nRequired scopes: Du.Extraction.Api
" + operationId: GetDocTypeExtractionResult + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: operationId + in: path + description: The operation identifier obtained from the START extraction route. + required: true + - name: tag + in: path + description: The tag associated with the project version to use for the extraction. + required: true + - name: documentTypeId + in: path + description: Extraction will be performed using the extractor associated with the document type with this identifier. + required: true + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.SwaggerGetExtractionResultResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: get-doc-type + /projects/{projectId}/classifiers/{classifierId}/validation/start: + post: + tags: + - Validation + summary: "" + description: "Start classification validation operation. To monitor the status and retrieve the validation result, use the \"Get Classification Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: StartClassificationValidation + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the classifier exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: classifierId + in: path + description: The identifier of the classifier used for classification. + required: true + schema: + type: string + default: ml-classification + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: 663940ee-68ac-4290-bb12-b6fb5067f3f4 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + responses: + "202": + description: Accepted + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "424": + description: Failed Dependency + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: start-classification-validation + /projects/{projectId}/{tag}/classifiers/validation/start: + post: + tags: + - Validation + summary: "" + description: "Start classification validation operation. To monitor the status and retrieve the validation result, use the \"Get Classification Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: StartClassificationValidation + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the classifier exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: tag + in: path + description: The tag associated with the project version to use for the classification. + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + application/*+json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + examples: + Specialized Classification Validation: + value: + classificationResults: + - DocumentTypeId: invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 1 + TextStartIndex: 0 + TextLength: 1 + ClassifierName: ML Classification + prompts: null + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Classification Validation: + value: + classificationResults: + - DocumentTypeId: Invoice + DocumentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + Confidence: 0.0 + OcrConfidence: 0.0 + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DocumentBounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + ClassifierName: Generative Classifier + prompts: + - name: Invoice + description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. + - name: Receipt + description: A written acknowledgment of having received a specified amount of money, goods, or services. + documentId: d720f613-e5cc-4a76-ae9d-e1378b240dc8 + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + responses: + "202": + description: Accepted + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse' + "400": + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "424": + description: Failed Dependency + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: start-classification-validation-by-tag + /projects/{projectId}/classifiers/{classifierId}/validation/result/{operationId}: + get: + tags: + - Validation + summary: "" + description: "Monitor the status and retrieve the classification validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: GetClassificationValidationResult + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the classifier exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: classifierId + in: path + description: The identifier of the classifier used for classification. + required: true + schema: + type: string + default: ml-classification + - name: operationId + in: path + description: The operation identifier obtained from the START classification validation route. + required: true + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "424": + description: Failed Dependency + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: get-classification-validation + /projects/{projectId}/{tag}/classifiers/validation/result/{operationId}: + get: + tags: + - Validation + summary: "" + description: "Monitor the status and retrieve the classification validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: GetClassificationValidationResultByTag + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the classifier exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: tag + in: path + description: The tag associated with the project version to use for the classification. + required: true + - name: operationId + in: path + description: The operation identifier obtained from the START classification validation route. + required: true + responses: + "200": + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "424": + description: Failed Dependency + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: get-classification-validation-by-tag + /projects/{projectId}/extractors/{extractorId}/validation/start: + post: + tags: + - Validation + summary: "" + description: "Start extraction validation operation. To monitor the status and retrieve the validation result, use the \"Get Extraction Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: StartExtractionValidation + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: extractorId + in: path + description: The identifier of the extractor used for extraction. + required: true + schema: + type: string + default: invoices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' + examples: + Specialized Extraction Validation: + value: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: null + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Extraction Validation: + value: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 + TextStartIndex: 0 + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + actionTitle: Title of the action in action center + actionPriority: Low actionCatalog: default_du_actions actionFolder: Shared storageBucketName: du_storage_bucket storageBucketDirectoryPath: du_storage_bucket - Generative Classification Validation: + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' + examples: + Specialized Extraction Validation: value: - classificationResults: - - DocumentTypeId: Invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: + StartPage: 0 + PageCount: 0 TextStartIndex: 0 TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string + prompts: null + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e + actionTitle: Title of the action in action center + actionPriority: Low + actionCatalog: default_du_actions + actionFolder: Shared + storageBucketName: du_storage_bucket + storageBucketDirectoryPath: du_storage_bucket + Generative Extraction Validation: + value: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: StartPage: 0 PageCount: 0 TextStartIndex: 0 TextLength: 0 - ClassifierName: Generative Classifier + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string prompts: - - name: Invoice - description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - - name: Receipt - description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2017,76 +4610,376 @@ paths: storageBucketDirectoryPath: du_storage_bucket application/*+json: schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartClassificationValidationTaskRequest' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartExtractionValidationTaskRequest' examples: - Specialized Classification Validation: + Specialized Extraction Validation: value: - classificationResults: - - DocumentTypeId: invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: - TextStartIndex: 0 - TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: StartPage: 0 - PageCount: 1 + PageCount: 0 TextStartIndex: 0 - TextLength: 1 - ClassifierName: ML Classification + TextLength: 0 + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string prompts: null - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions actionFolder: Shared storageBucketName: du_storage_bucket storageBucketDirectoryPath: du_storage_bucket - Generative Classification Validation: + Generative Extraction Validation: value: - classificationResults: - - DocumentTypeId: Invoice - DocumentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 - Confidence: 0.0 - OcrConfidence: 0.0 - Reference: - TextStartIndex: 0 - TextLength: 0 - Tokens: - - TextStartIndex: 0 - TextLength: 0 - Page: 0 - PageWidth: 0.0 - PageHeight: 0.0 - Boxes: - - - 0.0 - - 0.0 - - 0.0 - - 0.0 - DocumentBounds: + extractionResult: + DocumentId: caa4f462-2d71-41ae-affb-8695cff1c79e + ResultsVersion: 0 + ResultsDocument: + Bounds: StartPage: 0 PageCount: 0 TextStartIndex: 0 TextLength: 0 - ClassifierName: Generative Classifier + Language: string + DocumentGroup: string + DocumentCategory: string + DocumentTypeId: string + DocumentTypeName: string + DocumentTypeDataVersion: 0 + DataVersion: 0 + DocumentTypeSource: Automatic + DocumentTypeField: + Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: true + DataSource: Automatic + Values: [] + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + Fields: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: true + ValidatorNotes: "" + Tables: + - FieldId: string + FieldName: string + IsMissing: false + DataSource: Automatic + DataVersion: 0 + OperatorConfirmed: true + Values: + - OperatorConfirmed: true + Confidence: 0.0 + OcrConfidence: 0.0 + Cells: + - RowIndex: 0 + ColumnIndex: 0 + IsHeader: true + IsMissing: false + OperatorConfirmed: true + DataSource: Automatic + DataVersion: 0 + Values: + - Components: + - FieldId: string + FieldName: string + FieldType: Text + IsMissing: false + DataSource: Automatic + Values: + - Components: [] + Value: string + UnformattedValue: "" + Reference: null + DerivedFields: [] + Confidence: 0.0 + OperatorConfirmed: false + OcrConfidence: 0.0 + TextType: Unknown + DataVersion: 0 + OperatorConfirmed: false + ValidatorNotes: "" + Value: string + UnformattedValue: string + Reference: + TextStartIndex: 0 + TextLength: 0 + Tokens: + - TextStartIndex: 0 + TextLength: 0 + Page: 0 + PageWidth: 0.0 + PageHeight: 0.0 + Boxes: + - - 0.0 + - 0.0 + - 0.0 + - 0.0 + DerivedFields: + - FieldId: string + Value: string + Confidence: 0.0 + OperatorConfirmed: true + OcrConfidence: 0.0 + TextType: Unknown + ColumnInfo: + - FieldId: string + FieldName: string + FieldType: Text + NumberOfRows: 1 + ExtractorPayloads: + - Id: string + Payload: string + SavedPayloadId: string + TaxonomySchemaMapping: null + BusinessRulesResults: + - FieldId: string + FieldType: Text + Criticality: Must + IsValid: true + Results: + - Value: + Value: string + DerivedValue: null + IsValid: true + Rules: + - Rule: + Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + IsValid: false + BrokenRules: + - Name: string + Type: Mandatory + LogicalOperator: AND + ComparisonOperator: Equals + Expression: string + SetValues: + - string + RowIndex: 0 + TableFieldId: string prompts: - - name: Invoice - description: A detailed statement of goods or services provided, with individual prices, the total charge, and payment terms. - - name: Receipt - description: A written acknowledgment of having received a specified amount of money, goods, or services. - documentId: 87773eee-68b7-43ca-9e04-43f6da9c6cf5 + - id: Invoice Number + question: Extract the invoice number from the provided document. + - id: Date + question: What is the invoice date mentioned in the document? + - id: Total + question: Extract the total amount from the invoice. + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: caa4f462-2d71-41ae-affb-8695cff1c79e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2143,127 +5036,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "424": - description: Client Error - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "500": - description: Server Error - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "503": - description: Server Error - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: start-classification-validation - /projects/{projectId}/classifiers/{classifierId}/validation/result/{operationId}: - get: - tags: - - Validation - summary: "" - description: "Monitor the status and retrieve the classification validation result once the operation is completed.\r\n
Required scopes: Du.Validation.Api
" - operationId: GetClassificationValidationResult - parameters: - - name: api-version - in: query - description: Version of the APIs. - required: true - schema: - enum: - - "1" - type: string - - name: projectId - in: path - description: The identifier of the project in which the classifier exists. - required: true - schema: - type: string - default: 00000000-0000-0000-0000-000000000000 - - name: classifierId - in: path - description: The identifier of the classifier used for classification. - required: true - schema: - type: string - default: ml-classification - - name: operationId - in: path - description: The operation identifier obtained from the START classification validation route. - required: true - responses: - "200": - description: Success - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetClassificationValidationTaskResponse' - "401": - description: Unauthorized - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "403": - description: Forbidden - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "404": - description: Not Found - content: - text/plain: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - application/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - text/json: - schema: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - "424": - description: Client Error + description: Failed Dependency content: text/plain: schema: @@ -2275,7 +5048,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -2287,7 +5060,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -2298,14 +5071,14 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: get-classification-validation - /projects/{projectId}/extractors/{extractorId}/validation/start: + x-uipathcli-name: start-extraction-validation + /projects/{projectId}/{tag}/document-types/{documentTypeId}/validation/start: post: tags: - Validation summary: "" - description: "Start extraction validation operation. To monitor the status and retrieve the validation result, use the \"Get Extraction Validation Result\" route.\r\n
Required scopes: Du.Validation.Api
" - operationId: StartExtractionValidation + description: "Start extraction validation by document type operation. To monitor the status and retrieve the validation result, use the \"Get Document Type Extraction Validation Result\" route.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: StartDocTypeExtractionValidation parameters: - name: api-version in: query @@ -2322,13 +5095,14 @@ paths: schema: type: string default: 00000000-0000-0000-0000-000000000000 - - name: extractorId + - name: tag in: path - description: The identifier of the extractor used for extraction. + description: The tag associated with the project version to use for the extraction. + required: true + - name: documentTypeId + in: path + description: Extraction will be performed using the extractor associated with the document type with this identifier. required: true - schema: - type: string - default: invoices requestBody: content: application/json: @@ -2338,7 +5112,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -2364,6 +5138,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2405,6 +5180,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -2443,6 +5219,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2475,6 +5252,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -2483,6 +5261,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -2505,7 +5284,9 @@ paths: RowIndex: 0 TableFieldId: string prompts: null - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2515,7 +5296,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -2541,6 +5322,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2582,6 +5364,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -2620,6 +5403,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2652,6 +5436,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -2660,6 +5445,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -2688,7 +5474,9 @@ paths: question: What is the invoice date mentioned in the document? - id: Total question: Extract the total amount from the invoice. - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2702,7 +5490,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -2728,6 +5516,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2769,6 +5558,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -2807,6 +5597,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2839,6 +5630,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -2847,6 +5639,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -2869,7 +5662,9 @@ paths: RowIndex: 0 TableFieldId: string prompts: null - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -2879,7 +5674,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -2905,6 +5700,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -2946,6 +5742,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -2984,6 +5781,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -3016,6 +5814,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -3024,6 +5823,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -3052,7 +5852,9 @@ paths: question: What is the invoice date mentioned in the document? - id: Total question: Extract the total amount from the invoice. - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3066,7 +5868,7 @@ paths: Specialized Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -3092,6 +5894,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -3133,6 +5936,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -3171,6 +5975,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -3203,6 +6008,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -3211,6 +6017,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -3233,7 +6040,9 @@ paths: RowIndex: 0 TableFieldId: string prompts: null - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3243,7 +6052,7 @@ paths: Generative Extraction Validation: value: extractionResult: - DocumentId: 0be44160-750e-4b23-ad59-23e25689960a + DocumentId: 170f421c-efc3-42c0-b093-3453b0d3c71e ResultsVersion: 0 ResultsDocument: Bounds: @@ -3269,6 +6078,7 @@ paths: Values: [] DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -3310,6 +6120,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: true + ValidatorNotes: "" Tables: - FieldId: string FieldName: string @@ -3348,6 +6159,7 @@ paths: TextType: Unknown DataVersion: 0 OperatorConfirmed: false + ValidatorNotes: "" Value: string UnformattedValue: string Reference: @@ -3380,6 +6192,7 @@ paths: - Id: string Payload: string SavedPayloadId: string + TaxonomySchemaMapping: null BusinessRulesResults: - FieldId: string FieldType: Text @@ -3388,6 +6201,7 @@ paths: Results: - Value: Value: string + DerivedValue: null IsValid: true Rules: - Rule: @@ -3416,7 +6230,9 @@ paths: question: What is the invoice date mentioned in the document? - id: Total question: Extract the total amount from the invoice. - documentId: 0be44160-750e-4b23-ad59-23e25689960a + fieldsValidationConfidence: null + allowChangeOfDocumentType: null + documentId: 170f421c-efc3-42c0-b093-3453b0d3c71e actionTitle: Title of the action in action center actionPriority: Low actionCatalog: default_du_actions @@ -3473,7 +6289,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "424": - description: Client Error + description: Failed Dependency content: text/plain: schema: @@ -3485,7 +6301,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -3497,7 +6313,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -3508,13 +6324,13 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: start-extraction-validation + x-uipathcli-name: start-extraction-validation-by-doc-type /projects/{projectId}/extractors/{extractorId}/validation/result/{operationId}: get: tags: - Validation summary: "" - description: "Monitor the status and retrieve the extraction validation result once the operation is completed.\r\n
Required scopes: Du.Validation.Api
" + description: "Monitor the status and retrieve the extraction validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" operationId: GetExtractionValidationResult parameters: - name: api-version @@ -3545,7 +6361,128 @@ paths: required: true responses: "200": - description: Success + description: OK + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetExtractionValidationTaskResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetExtractionValidationTaskResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.GetExtractionValidationTaskResponse' + "401": + description: Unauthorized + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "403": + description: Forbidden + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "404": + description: Not Found + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "424": + description: Failed Dependency + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "500": + description: Internal Server Error + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + "503": + description: Service Unavailable + content: + text/plain: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' + x-uipathcli-name: get-extraction-validation + /projects/{projectId}/{tag}/document-types/{documentTypeId}/validation/result/{operationId}: + get: + tags: + - Validation + summary: "" + description: "Monitor the status and retrieve the extraction validation result once the operation is completed.\r\n\nRequired scopes: Du.Validation.Api
" + operationId: GetDocTypeExtractionValidationResult + parameters: + - name: api-version + in: query + description: Version of the APIs. + required: true + schema: + enum: + - "1" + type: string + - name: projectId + in: path + description: The identifier of the project in which the extractor exists. + required: true + schema: + type: string + default: 00000000-0000-0000-0000-000000000000 + - name: tag + in: path + description: The tag associated with the project version to use for the extraction. + required: true + - name: documentTypeId + in: path + description: Extraction will be performed using the extractor associated with the document type with this identifier. + required: true + - name: operationId + in: path + description: The operation identifier obtained from the START extraction validation route. + required: true + responses: + "200": + description: OK content: text/plain: schema: @@ -3593,7 +6530,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "424": - description: Client Error + description: Failed Dependency content: text/plain: schema: @@ -3605,7 +6542,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "500": - description: Server Error + description: Internal Server Error content: text/plain: schema: @@ -3617,7 +6554,7 @@ paths: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' "503": - description: Server Error + description: Service Unavailable content: text/plain: schema: @@ -3628,9 +6565,22 @@ paths: text/json: schema: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' - x-uipathcli-name: get-extraction-validation + x-uipathcli-name: get-docType-extraction-validation components: schemas: + System.Drawing.PointF: + type: object + properties: + isEmpty: + type: boolean + readOnly: true + x: + type: number + format: float + "y": + type: number + format: float + additionalProperties: false UiPath.DocumentProcessing.Contracts.Actions.DocumentActionPriority: enum: - Low @@ -3666,6 +6616,9 @@ components: value: type: string nullable: true + derivedValue: + type: string + nullable: true additionalProperties: false UiPath.DocumentProcessing.Contracts.BusinessRules.FieldValueResult: type: object @@ -3718,6 +6671,125 @@ components: type: string nullable: true additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.Document: + type: object + properties: + documentId: + type: string + nullable: true + contentType: + type: string + nullable: true + length: + type: integer + format: int32 + pages: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Page' + nullable: true + documentMetadata: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Metadata' + nullable: true + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.Metadata: + type: object + properties: + key: + type: string + nullable: true + value: + type: string + nullable: true + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.Page: + type: object + properties: + pageIndex: + type: integer + format: int32 + size: + maxItems: 4 + minItems: 4 + type: array + items: + type: number + example: '[23.2, 723.3, 41.5, 18.2]' + sections: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.PageSection' + nullable: true + processingSource: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.ProcessingSource' + indexInText: + type: integer + format: int32 + textLength: + type: integer + format: int32 + skewAngle: + type: number + format: float + rotation: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Rotation' + pageMetadata: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Metadata' + nullable: true + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.PageSection: + type: object + properties: + indexInText: + type: integer + format: int32 + language: + type: string + nullable: true + length: + type: integer + format: int32 + rotation: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Rotation' + skewAngle: + type: number + format: float + type: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.SectionType' + wordGroups: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.WordGroup' + nullable: true + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.ProcessingSource: + enum: + - Unknown + - Ocr + - Pdf + - PlainText + - PdfAndOcr + type: string + UiPath.DocumentProcessing.Contracts.Dom.Rotation: + enum: + - None + - Rotated90 + - Rotated180 + - Rotated270 + - Other + type: string + UiPath.DocumentProcessing.Contracts.Dom.SectionType: + enum: + - Vertical + - Paragraph + - Header + - Footer + - Table + type: string UiPath.DocumentProcessing.Contracts.Dom.TextType: enum: - Unknown @@ -3729,6 +6801,67 @@ components: - Stamp - Logo type: string + UiPath.DocumentProcessing.Contracts.Dom.Word: + type: object + properties: + box: + maxItems: 4 + minItems: 4 + type: array + items: + type: number + example: '[23.2, 723.3, 41.5, 18.2]' + polygon: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Polygon' + indexInText: + type: integer + format: int32 + ocrConfidence: + type: number + format: float + text: + type: string + nullable: true + visualLineNumber: + type: integer + format: int32 + textType: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.TextType' + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.WordGroup: + type: object + properties: + indexInText: + type: integer + format: int32 + length: + type: integer + format: int32 + type: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.WordGroupType' + words: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Word' + nullable: true + additionalProperties: false + UiPath.DocumentProcessing.Contracts.Dom.WordGroupType: + enum: + - Sentence + - TableCell + - TableRowEnd + - Heading + - Other + type: string + UiPath.DocumentProcessing.Contracts.Polygon: + type: object + properties: + points: + type: array + items: + $ref: '#/components/schemas/System.Drawing.PointF' + nullable: true + additionalProperties: false UiPath.DocumentProcessing.Contracts.Results.ClassificationResult: type: object properties: @@ -3786,6 +6919,9 @@ components: savedPayloadId: type: string nullable: true + taxonomySchemaMapping: + type: string + nullable: true additionalProperties: false UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference: type: object @@ -3828,6 +6964,9 @@ components: format: int32 operatorConfirmed: type: boolean + validatorNotes: + type: string + nullable: true additionalProperties: false UiPath.DocumentProcessing.Contracts.Results.ResultsDataSource: enum: @@ -4121,6 +7260,7 @@ components: - Contains - Expression - TableExpression + - IsEmpty type: string UiPath.DocumentUnderstanding.Common.Clients.Orchestrator.Model.ActionStatus: enum: @@ -4191,7 +7331,16 @@ components: result: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.Classification.ClassificationResponse' additionalProperties: false - UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResponse: + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.StartDigitizationResponse: + type: object + properties: + documentId: + type: string + description: The Document ID + format: uuid + example: ID of the document that is being digitized. + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResponse: type: object properties: status: @@ -4206,7 +7355,7 @@ components: error: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse' result: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResult' + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResult' createdAt: type: string description: The time the operation was created @@ -4218,24 +7367,15 @@ components: format: date-time example: "2022-06-21T13:49:10.1105179Z" additionalProperties: false - UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.GetDigitizeJobResult: + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.SwaggerGetDigitizeJobResult: type: object properties: documentObjectModel: - $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.SerializedResult' + $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Dom.Document' documentText: type: string nullable: true additionalProperties: false - UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Digitization.StartDigitizationResponse: - type: object - properties: - documentId: - type: string - description: The Document ID - format: uuid - example: ID of the document that is being digitized. - additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Classifier: type: object properties: @@ -4264,6 +7404,31 @@ components: type: string format: uri nullable: true + projectVersion: + type: integer + format: int32 + nullable: true + projectVersionName: + type: string + nullable: true + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredProjectVersionResponse: + type: object + properties: + version: + type: integer + format: int32 + versionName: + type: string + nullable: true + tag: + type: string + nullable: true + date: + type: string + format: date-time + deployed: + type: boolean additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredResourceSummaryResponse: type: object @@ -4278,6 +7443,13 @@ components: type: string format: uri nullable: true + projectVersion: + type: integer + format: int32 + nullable: true + projectVersionName: + type: string + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DocumentType: type: object @@ -4319,6 +7491,13 @@ components: type: string format: uri nullable: true + projectVersion: + type: integer + format: int32 + nullable: true + projectVersionName: + type: string + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ExtractorField: type: object @@ -4384,6 +7563,13 @@ components: type: string format: uri nullable: true + projectVersion: + type: integer + format: int32 + nullable: true + projectVersionName: + type: string + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetClassifiersResponse: type: object @@ -4393,7 +7579,6 @@ components: items: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Classifier' nullable: true - readOnly: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypeDetailsResponse: type: object @@ -4446,6 +7631,13 @@ components: projectId: type: string format: uuid + projectVersion: + type: integer + format: int32 + nullable: true + projectVersionName: + type: string + nullable: true documentTypeName: type: string nullable: true @@ -4506,6 +7698,11 @@ components: items: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredResourceSummaryResponse' nullable: true + projectVersions: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredProjectVersionResponse' + nullable: true createdOn: type: string format: date-time @@ -4520,6 +7717,15 @@ components: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Project' nullable: true additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetTagsResponse: + type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Tag' + nullable: true + additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Project: type: object properties: @@ -4566,6 +7772,73 @@ components: - Error - Deleting type: string + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ResourceType: + enum: + - Specialized + - Generative + - Custom + - Unknown + type: string + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.Tag: + type: object + properties: + name: + type: string + nullable: true + projectVersion: + type: integer + format: int32 + projectVersionName: + type: string + nullable: true + extractors: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.TaggedExtractor' + nullable: true + classifiers: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.TaggedClassifier' + nullable: true + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.TaggedClassifier: + type: object + properties: + name: + type: string + nullable: true + documentTypes: + type: array + items: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DocumentType' + nullable: true + syncUrl: + type: string + format: uri + nullable: true + asyncUrl: + type: string + format: uri + nullable: true + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.TaggedExtractor: + type: object + properties: + name: + type: string + nullable: true + documentType: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DocumentType' + syncUrl: + type: string + format: uri + nullable: true + asyncUrl: + type: string + format: uri + nullable: true + additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBody: type: object properties: @@ -4579,6 +7852,16 @@ components: items: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ExtractionPrompt' nullable: true + configuration: + $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBodyConfiguration' + additionalProperties: false + UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractRequestBodyConfiguration: + type: object + properties: + autoValidationConfidenceThreshold: + type: integer + format: int32 + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult: type: object @@ -4628,13 +7911,6 @@ components: result: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Extraction.ExtractSyncResult' additionalProperties: false - UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.SerializedResult: - type: object - properties: - result: - type: string - nullable: true - additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.ClassificationValidationResult: type: object properties: @@ -4804,6 +8080,16 @@ components: items: $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ExtractionPrompt' nullable: true + fieldsValidationConfidence: + type: integer + description: The confidence percentage threshold between [0-100] used by Validation Station + format: int32 + nullable: true + example: 50 + allowChangeOfDocumentType: + type: boolean + description: Flag indicating whether the validator user can change the type associated to the Document in the Validation Station with another one from the used Document Understanding project. Not applicable for the generative extraction. + nullable: true additionalProperties: false UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Validation.StartValidationTaskResponse: type: object diff --git a/definitions/identity.yaml b/definitions/identity.yaml index 1142975..9f90174 100644 --- a/definitions/identity.yaml +++ b/definitions/identity.yaml @@ -1,8 +1,8 @@ openapi: 3.0.1 info: title: IdentityServer External API - version: 3.0.23 - x-uipath-version: 3.0.23 + version: 3.1.10 + x-uipath-version: 3.1.10 servers: - url: https://cloud.uipath.com/identity_ paths: @@ -1114,19 +1114,19 @@ components: properties: objectType: type: string - identifier: + source: type: string nullable: true - name: + identifier: type: string nullable: true - displayName: + name: type: string nullable: true - source: + email: type: string nullable: true - email: + displayName: type: string nullable: true discriminator: diff --git a/definitions/orchestrator.yaml b/definitions/orchestrator.yaml index 56b835e..fb4c6fc 100644 --- a/definitions/orchestrator.yaml +++ b/definitions/orchestrator.yaml @@ -88,6 +88,77 @@ paths: $ref: '#/components/schemas/DomainDto' security: - OAuth2: [] + /api/DirectoryService/GetDomainUserId: + get: + tags: + - DirectoryService + summary: Gets an orchestrator user Id by searching for the domain user information. + description: |- + OAuth required scopes: OR.Users or OR.Users.Read. + + Required permissions: (Users.View or Units.Edit or SubFolders.Edit). + operationId: DirectoryService_GetDomainUserId + parameters: + - name: domain + in: query + schema: + type: string + - name: directoryIdentifier + in: query + schema: + type: string + - name: userName + in: query + schema: + type: string + - name: userType + in: query + schema: + type: string + enum: + - User + - Robot + - DirectoryUser + - DirectoryGroup + - DirectoryRobot + - DirectoryExternalApplication + x-ms-enum: + name: UserType + modelAsString: false + x-enum-varnames: + - User + - Robot + - DirectoryUser + - DirectoryGroup + - DirectoryRobot + - DirectoryExternalApplication + x-ms-enum: + name: UserType + modelAsString: false + x-enum-varnames: + - User + - Robot + - DirectoryUser + - DirectoryGroup + - DirectoryRobot + - DirectoryExternalApplication + responses: + "200": + description: Success + content: + application/json: + schema: + type: integer + format: int64 + "404": + description: Not Found + content: + application/json: + schema: + type: integer + format: int64 + security: + - OAuth2: [] /api/DirectoryService/SearchForUsersAndGroups: get: tags: @@ -378,6 +449,79 @@ paths: $ref: '#/components/schemas/PageResultDtoOfPathAwareFolderDto' security: - OAuth2: [] + /api/JobTriggers/DeliverPayload/{inboxId}: + post: + tags: + - JobTriggers + summary: Deliver payload for trigger inboxId. + description: |- + OAuth required scopes: OR.Jobs or OR.Jobs.Write. + + Required permissions: Jobs.Edit. + operationId: JobTriggers_DeliverPayloadByInboxid + parameters: + - name: inboxId + in: path + required: true + schema: + type: string + format: uuid + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + requestBody: + content: + application/json: + schema: + maxLength: 4000 + type: object + required: false + responses: + "202": + description: Accepted + content: {} + "208": + description: Success + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body + /api/JobTriggers/GetPayload/{inboxId}: + get: + tags: + - JobTriggers + summary: Get payload for trigger inboxId. + operationId: JobTriggers_GetPayloadByInboxid + parameters: + - name: inboxId + in: path + required: true + schema: + type: string + format: uuid + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Success + content: + application/json: + schema: + type: object + "404": + description: Not Found + content: {} /api/Licensing/Acquire: post: tags: @@ -6252,6 +6396,76 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body + /odata/Folders({key})/UiPath.Server.Configuration.OData.RemoveUserFromFolderByKey: + post: + tags: + - Folders + summary: Remove user assignment from a folder. + description: |- + OAuth required scopes: OR.Folders or OR.Folders.Write. + + Required permissions: (Units.Edit or SubFolders.Edit - Remove user from any folder or only if caller has SubFolders.Edit permission on provided folder). + operationId: Folders_RemoveUserFromFolderByKey + parameters: + - name: key + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + description: userId - The Id of the user to remove from the folder + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + application/*+json: + schema: + $ref: '#/components/schemas/RemoveUserByKeyFromFolderRequest' + required: false + responses: + "204": + description: No Content + content: {} + security: + - OAuth2: [] + x-codegen-request-body-name: body /odata/Folders/UiPath.Server.Configuration.OData.AssignDomainUser: post: tags: @@ -13042,27 +13256,60 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body - /odata/QueueItems/UiPathODataSvc.SetItemReviewer: - post: + /odata/QueueItems/UiPathODataSvc.GetItemLastRetryByKey(key={key}): + get: tags: - QueueItems - summary: Sets the reviewer for multiple queue items + summary: Returns the last retry of a queue item by key. description: |- - OAuth required scopes: OR.Queues or OR.Queues.Write. + OAuth required scopes: OR.Queues or OR.Queues.Read. - Required permissions: Queues.View and Transactions.Edit. - operationId: QueueItems_SetItemReviewer + Required permissions: Queues.View and Transactions.View. + operationId: QueueItems_GetItemLastRetryByKey parameters: + - name: key + in: path + required: true + schema: + type: string + format: uuid - name: $expand in: query description: Indicates the related entities to be represented inline. The maximum depth is 2. schema: type: string + - name: $filter + in: query + description: Restricts the set of items returned. The maximum number of expressions is 100. + schema: + type: string - name: $select in: query description: Limits the properties returned in the result. schema: type: string + - name: $orderby + in: query + description: Specifies the order in which items are returned. The maximum number of expressions is 5. + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. The maximum value is 1000. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean - name: X-UIPATH-OrganizationUnitId in: header description: Folder/OrganizationUnit Id @@ -13071,72 +13318,113 @@ paths: format: int64 x-uipathcli-name: folder-id required: true - requestBody: - description: "UserId - The ID of the user to be set as the reviewer. If not set, the reviewer is cleared.\r\n QueueItems - The collection of ids of queue items for which the reviewer is set." - content: - application/json;odata.metadata=minimal;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=minimal;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=minimal: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=full;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=full;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=full: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=none;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=none;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.metadata=none: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.streaming=true: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json;odata.streaming=false: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/json-patch+json: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - application/*+json: - schema: - $ref: '#/components/schemas/QueueSetItemReviewerRequest' - required: false responses: "200": description: Success content: application/json: schema: - $ref: '#/components/schemas/BulkOperationResponseDtoOfInt64' + $ref: '#/components/schemas/QueueItemDto' + "404": + description: Not Found + content: {} security: - OAuth2: [] - x-codegen-request-body-name: body - /odata/QueueItems/UiPathODataSvc.SetItemReviewStatus: + /odata/QueueItems/UiPathODataSvc.SetItemReviewer: post: tags: - QueueItems - summary: Updates the review status of the specified queue items to an indicated state. + summary: Sets the reviewer for multiple queue items description: |- OAuth required scopes: OR.Queues or OR.Queues.Write. Required permissions: Queues.View and Transactions.Edit. - operationId: QueueItems_SetItemReviewStatus + operationId: QueueItems_SetItemReviewer + parameters: + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + requestBody: + description: "UserId - The ID of the user to be set as the reviewer. If not set, the reviewer is cleared.\r\n QueueItems - The collection of ids of queue items for which the reviewer is set." + content: + application/json;odata.metadata=minimal;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=minimal;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=minimal: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=full;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=full;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=full: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=none;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=none;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.metadata=none: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.streaming=true: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json;odata.streaming=false: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + application/*+json: + schema: + $ref: '#/components/schemas/QueueSetItemReviewerRequest' + required: false + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BulkOperationResponseDtoOfInt64' + security: + - OAuth2: [] + x-codegen-request-body-name: body + /odata/QueueItems/UiPathODataSvc.SetItemReviewStatus: + post: + tags: + - QueueItems + summary: Updates the review status of the specified queue items to an indicated state. + description: |- + OAuth required scopes: OR.Queues or OR.Queues.Write. + + Required permissions: Queues.View and Transactions.Edit. + operationId: QueueItems_SetItemReviewStatus parameters: - name: $expand in: query @@ -20084,6 +20372,81 @@ paths: security: - OAuth2: [] x-codegen-request-body-name: body + /odata/Tasks/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier}): + get: + tags: + - Tasks + summary: Gets a Task with the given guid. + description: |- + OAuth required scopes: OR.Tasks or OR.Tasks.Read. + + Requires authentication. + operationId: Tasks_GetByKeyByIdentifier + parameters: + - name: identifier + in: path + description: The guid of the Task to be retrieved. + required: true + schema: + type: string + format: uuid + - name: $expand + in: query + description: Indicates the related entities to be represented inline. The maximum depth is 2. + schema: + type: string + - name: $filter + in: query + description: Restricts the set of items returned. The maximum number of expressions is 100. + schema: + type: string + - name: $select + in: query + description: Limits the properties returned in the result. + schema: + type: string + - name: $orderby + in: query + description: Specifies the order in which items are returned. The maximum number of expressions is 5. + schema: + type: string + - name: $top + in: query + description: Limits the number of items returned from a collection. The maximum value is 1000. + schema: + type: integer + format: int32 + - name: $skip + in: query + description: Excludes the specified number of items of the queried collection from the result. + schema: + type: integer + format: int32 + - name: $count + in: query + description: Indicates whether the total count of items within a collection are returned in the result. + schema: + type: boolean + - name: X-UIPATH-OrganizationUnitId + in: header + description: Folder/OrganizationUnit Id + schema: + type: integer + format: int64 + x-uipathcli-name: folder-id + required: true + responses: + "200": + description: Ok result of Task object. + content: + application/json: + schema: + $ref: '#/components/schemas/TaskDto' + "404": + description: Not found result. + content: {} + security: + - OAuth2: [] /odata/Tasks/UiPath.Server.Configuration.OData.GetTaskPermissions: get: tags: @@ -23982,6 +24345,102 @@ components: TotalFoldersCount: type: integer format: int32 + ActionableMessageAction: + type: object + properties: + id: + type: string + description: Unique Identifier of the field + name: + type: string + description: Name of the command + title: + type: string + description: Title of the command + type: + type: string + description: Type of the field (e.g. Input.Text) + isPrimary: + type: boolean + description: Indicates if the action is primary or secondary + description: Type definition for Actionable Message Command. + ActionableMessageActionSet: + type: object + properties: + id: + type: string + description: Unique Identifier of the field + type: + type: string + description: Action Set Type + readOnly: true + actions: + maxItems: 5 + type: array + description: Set of Actions + items: + $ref: '#/components/schemas/ActionableMessageAction' + description: Set of Commands for Actionable Message + ActionableMessageField: + type: object + properties: + id: + type: string + description: Unique Identifier of the field + name: + type: string + description: Name of the field + title: + type: string + description: Name of the field + type: + type: string + description: Type of the field (e.g. Input.Text) + placeHolderText: + type: string + description: Placeholder text for the field + value: + type: string + description: Value of the field + isHeader: + type: boolean + description: Is the field header + isRequired: + type: boolean + description: Is the field Required + sequence: + type: integer + description: Sequence of the field + format: int32 + horizontalAlignment: + type: string + description: Defines horizontal alignment of the field + description: Type definition for Actionable Message Field. + ActionableMessageFieldSet: + type: object + properties: + id: + type: string + description: Unique Identifier of the field + type: + type: string + description: Action Set Type + readOnly: true + fields: + maxItems: 10 + type: array + description: Set of fields + items: + $ref: '#/components/schemas/ActionableMessageField' + description: Set of Fields for Actionable Message + ActionableMessageMetaData: + type: object + properties: + fieldSet: + $ref: '#/components/schemas/ActionableMessageFieldSet' + actionSet: + $ref: '#/components/schemas/ActionableMessageActionSet' + description: Type definition for Actionable Message Schema. ActivitySettingsDto: type: object properties: @@ -24044,6 +24503,7 @@ components: - ConnectedTriggers - Serverless - Export + - RateLimits x-enum-varnames: - Robots - Transactions @@ -24060,6 +24520,7 @@ components: - ConnectedTriggers - Serverless - Export + - RateLimits x-ms-enum: name: AlertDtoComponent modelAsString: false @@ -24138,6 +24599,8 @@ components: Timestamp: type: string format: date-time + IsEmailDisabled: + type: boolean UserKey: type: string format: uuid @@ -24216,7 +24679,6 @@ components: required: - appId - appVersion - - taskDefinitionId - title type: object properties: @@ -24237,6 +24699,11 @@ components: type: integer description: Version of App for AppTask format: int32 + isActionableMessageEnabled: + type: boolean + description: Is Acionable Message enabled + actionableMessageMetaData: + $ref: '#/components/schemas/ActionableMessageMetaData' type: type: string description: Gets or sets type of this task, allowed type is 'ExternalTask'. @@ -24303,6 +24770,10 @@ components: AppTasksDataDto: type: object properties: + taskDefinitionPropertiesId: + type: integer + description: Task Definition Properties for App Task + format: int64 appTasksMetadata: $ref: '#/components/schemas/AppTasksMetadataDto' actionLabel: @@ -24354,6 +24825,11 @@ components: $ref: '#/components/schemas/TagDto' assignedToUser: $ref: '#/components/schemas/UserLoginInfoDto' + taskSlaDetails: + type: array + description: Gets or sets the expiry time of Actionable Task Schedule + items: + $ref: '#/components/schemas/TaskSlaDetailDto' title: type: string description: Gets or sets title of this task. @@ -24423,6 +24899,10 @@ components: parentOperationId: type: string description: Operation id which created the task. + key: + type: string + description: The unique Task identifier. + format: uuid isDeleted: type: boolean deleterUserId: @@ -24476,16 +24956,33 @@ components: AssetCreatedEvent: type: object properties: + key: + type: string + format: uuid + readOnly: true name: type: string + readOnly: true description: type: string - key: + readOnly: true + valueScope: type: string - format: uuid - assetType: + description: Defines the visibility level of an asset. + readOnly: true + enum: + - Global + - PerRobot + x-enum-varnames: + - Global + - PerRobot + x-ms-enum: + name: AssetCreatedEventValueScope + modelAsString: false + valueType: type: string description: Defines what type of value is stored by an asset. + readOnly: true enum: - DBConnectionString - HttpConnectionString @@ -24505,22 +25002,11 @@ components: - WindowsCredential - KeyValueList x-ms-enum: - name: AssetCreatedEventAssetType - modelAsString: false - assetScope: - type: string - description: Defines the visibility level of an asset. - enum: - - Global - - PerRobot - x-enum-varnames: - - Global - - PerRobot - x-ms-enum: - name: AssetCreatedEventAssetScope + name: AssetCreatedEventValueType modelAsString: false tags: type: array + readOnly: true items: $ref: '#/components/schemas/TagDto' folderKeys: @@ -24539,11 +25025,30 @@ components: key: type: string format: uuid + readOnly: true name: type: string - assetType: + readOnly: true + description: + type: string + readOnly: true + valueScope: + type: string + description: Defines the visibility level of an asset. + readOnly: true + enum: + - Global + - PerRobot + x-enum-varnames: + - Global + - PerRobot + x-ms-enum: + name: AssetDeletedEventValueScope + modelAsString: false + valueType: type: string description: Defines what type of value is stored by an asset. + readOnly: true enum: - DBConnectionString - HttpConnectionString @@ -24563,19 +25068,7 @@ components: - WindowsCredential - KeyValueList x-ms-enum: - name: AssetDeletedEventAssetType - modelAsString: false - assetScope: - type: string - description: Defines the visibility level of an asset. - enum: - - Global - - PerRobot - x-enum-varnames: - - Global - - PerRobot - x-ms-enum: - name: AssetDeletedEventAssetScope + name: AssetDeletedEventValueType modelAsString: false folderKeys: type: array @@ -24814,16 +25307,33 @@ components: AssetUpdatedEvent: type: object properties: + key: + type: string + format: uuid + readOnly: true name: type: string + readOnly: true description: type: string - key: + readOnly: true + valueScope: type: string - format: uuid - assetType: + description: Defines the visibility level of an asset. + readOnly: true + enum: + - Global + - PerRobot + x-enum-varnames: + - Global + - PerRobot + x-ms-enum: + name: AssetUpdatedEventValueScope + modelAsString: false + valueType: type: string description: Defines what type of value is stored by an asset. + readOnly: true enum: - DBConnectionString - HttpConnectionString @@ -24843,22 +25353,11 @@ components: - WindowsCredential - KeyValueList x-ms-enum: - name: AssetUpdatedEventAssetType - modelAsString: false - assetScope: - type: string - description: Defines the visibility level of an asset. - enum: - - Global - - PerRobot - x-enum-varnames: - - Global - - PerRobot - x-ms-enum: - name: AssetUpdatedEventAssetScope + name: AssetUpdatedEventValueType modelAsString: false tags: type: array + readOnly: true items: $ref: '#/components/schemas/TagDto' folderKeys: @@ -25197,7 +25696,6 @@ components: - Folders - DirectoryService - Buckets - - TenantMove - Secrets - PersonalWorkspaces - CloudSubscriptions @@ -25244,7 +25742,6 @@ components: - Folders - DirectoryService - Buckets - - TenantMove - Secrets - PersonalWorkspaces - CloudSubscriptions @@ -25472,19 +25969,51 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string + readOnly: true + storageProvider: + type: string + readOnly: true + storageParameters: + type: string + readOnly: true + storageContainer: + type: string + readOnly: true + options: + type: string + readOnly: true + enum: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-enum-varnames: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-ms-enum: + name: BucketCreatedEventOptions + modelAsString: false + externalName: + type: string + readOnly: true + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' folderKeys: type: array items: type: string format: uuid - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' eventTime: type: string format: date-time @@ -25496,10 +26025,46 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string + readOnly: true + storageProvider: + type: string + readOnly: true + storageParameters: + type: string + readOnly: true + storageContainer: + type: string + readOnly: true + options: + type: string + readOnly: true + enum: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-enum-varnames: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-ms-enum: + name: BucketDeletedEventOptions + modelAsString: false + externalName: + type: string + readOnly: true + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' folderKeys: type: array items: @@ -25602,12 +26167,44 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string + readOnly: true + storageProvider: + type: string + readOnly: true + storageParameters: + type: string + readOnly: true + storageContainer: + type: string + readOnly: true + options: + type: string + readOnly: true + enum: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-enum-varnames: + - None + - ReadOnly + - AuditReadAccess + - AccessDataThroughOrchestrator + x-ms-enum: + name: BucketUpdatedEventOptions + modelAsString: false + externalName: + type: string + readOnly: true tags: type: array + readOnly: true items: $ref: '#/components/schemas/TagDto' folderKeys: @@ -26277,6 +26874,50 @@ components: items: type: integer format: int64 + DeploymentSettingUpdatedEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + TenantKey: + type: string + AccountKey: + type: string + EventTime: + type: string + format: date-time + EventSourceId: + type: integer + format: int64 + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + x-webhook-event: deploymentsetting.updated DirectoryObjectDto: type: object properties: @@ -26600,12 +27241,18 @@ components: - Queues - Logs - Jobs + - Privileges + - RateLimitsReportQueueItems + - RateLimitsReportJobs x-enum-varnames: - OrchestratorAudit - TestAutomationAudit - Queues - Logs - Jobs + - Privileges + - RateLimitsReportQueueItems + - RateLimitsReportJobs x-ms-enum: name: ExportModelType modelAsString: false @@ -27166,6 +27813,7 @@ components: - QueueItemOutputDataSizeExceeded - QueueItemAnalyticsDataSizeExceeded - QueueProcessingExceptionFieldSizeExceeded + - QueueItemProgressDataSizeExceeded - LicenseNotFound - LicenseExpired - LicenseAlreadyInUse @@ -27272,6 +27920,7 @@ components: - TaskFormLayoutIdNotFound - TaskFormLayoutOutOfSize - TaskCatalogHaveActiveTasks + - TaskMetadataSaveError - TasksBulkFormLayoutIdsNotSameOrNull - EmptyTasksBulkOperationRequest - TaskMaximumBulkOperationLimitExceeded @@ -27301,6 +27950,11 @@ components: - TaskDefintionVersionHaveActiveTasks - TaskDefintionVersionHaveActiveApps - FailedToRetrieveAssociatedApps + - TaskSlaNotEnabled + - AppTaskDataViolatesAppsActionSchema + - FailedToRetrieveActiondApps + - AppTaskDataViolatesExpectedJsonParsing + - ActionDefinitionReplacedbyActionApps - InvalidSecureStoreContext - MailSmtpSettingsError - CannotDeleteCalendarWhenUsedBySchedule @@ -27392,9 +28046,6 @@ components: - TestCaseDefinitionInUse - TestSetScheduleInvalidScheduleKey - TestSetExecutionTriggerFailed - - InvalidTenantMoveStatus - - TenantMoveIdConflict - - TenantMoveMigrationConflict - MediaFileNotFound - MediaFileNotFoundForKey - InvalidMediaFilesUpload @@ -27449,6 +28100,7 @@ components: - VirtualTriggerCanNotHaveUser - EventTriggerCreateFailedConnectionNotAvailable - UserHasNoRobotToFireUserEventTrigger + - ConnectedEventTriggerStatePatchFail - CredentialsProxyNotFound - CannotDeleteCredentialsProxyInUse - CredentialsProxyUrlMustBeHttps @@ -27465,7 +28117,6 @@ components: - CredentialsProxyRequestFailedUnhandledError - CredentialsProxyRequestFailedBadRequest - CredentialsProxyTypeCannotBeCreated - - CredentialsProxyGetAssetFromDisconnectedProxyNotEnabled - CredentialsProxyGetAssetFromDisconnectedProxyNotAllowedForThisActivityVersion - CredentialsProxyRequestFailedWithTimeout - ServerlessCreateMachineTemplateErrorCode @@ -27499,6 +28150,8 @@ components: - SolutionLibraryUrlIsInvalid - TenantLibraryFeedNotEnabled - SolutionsCannotInstallInPWFolder + - InvalidMerge + - SolutionConnectionInfoInvalid - ExportTimeout - InvalidMessageReceived - IntegrationServiceApiFailure @@ -27511,6 +28164,8 @@ components: - CallbackIsRequired - CalendarNotFound - EntitlementConsumationFailure + - LimitExceeded + - ReportsLimitsExceeded - ContentLengthTooLarge x-enum-varnames: - Unknown @@ -27738,6 +28393,7 @@ components: - QueueItemOutputDataSizeExceeded - QueueItemAnalyticsDataSizeExceeded - QueueProcessingExceptionFieldSizeExceeded + - QueueItemProgressDataSizeExceeded - LicenseNotFound - LicenseExpired - LicenseAlreadyInUse @@ -27844,6 +28500,7 @@ components: - TaskFormLayoutIdNotFound - TaskFormLayoutOutOfSize - TaskCatalogHaveActiveTasks + - TaskMetadataSaveError - TasksBulkFormLayoutIdsNotSameOrNull - EmptyTasksBulkOperationRequest - TaskMaximumBulkOperationLimitExceeded @@ -27873,6 +28530,11 @@ components: - TaskDefintionVersionHaveActiveTasks - TaskDefintionVersionHaveActiveApps - FailedToRetrieveAssociatedApps + - TaskSlaNotEnabled + - AppTaskDataViolatesAppsActionSchema + - FailedToRetrieveActiondApps + - AppTaskDataViolatesExpectedJsonParsing + - ActionDefinitionReplacedbyActionApps - InvalidSecureStoreContext - MailSmtpSettingsError - CannotDeleteCalendarWhenUsedBySchedule @@ -27964,9 +28626,6 @@ components: - TestCaseDefinitionInUse - TestSetScheduleInvalidScheduleKey - TestSetExecutionTriggerFailed - - InvalidTenantMoveStatus - - TenantMoveIdConflict - - TenantMoveMigrationConflict - MediaFileNotFound - MediaFileNotFoundForKey - InvalidMediaFilesUpload @@ -28021,6 +28680,7 @@ components: - VirtualTriggerCanNotHaveUser - EventTriggerCreateFailedConnectionNotAvailable - UserHasNoRobotToFireUserEventTrigger + - ConnectedEventTriggerStatePatchFail - CredentialsProxyNotFound - CannotDeleteCredentialsProxyInUse - CredentialsProxyUrlMustBeHttps @@ -28037,7 +28697,6 @@ components: - CredentialsProxyRequestFailedUnhandledError - CredentialsProxyRequestFailedBadRequest - CredentialsProxyTypeCannotBeCreated - - CredentialsProxyGetAssetFromDisconnectedProxyNotEnabled - CredentialsProxyGetAssetFromDisconnectedProxyNotAllowedForThisActivityVersion - CredentialsProxyRequestFailedWithTimeout - ServerlessCreateMachineTemplateErrorCode @@ -28071,6 +28730,8 @@ components: - SolutionLibraryUrlIsInvalid - TenantLibraryFeedNotEnabled - SolutionsCannotInstallInPWFolder + - InvalidMerge + - SolutionConnectionInfoInvalid - ExportTimeout - InvalidMessageReceived - IntegrationServiceApiFailure @@ -28083,6 +28744,8 @@ components: - CallbackIsRequired - CalendarNotFound - EntitlementConsumationFailure + - LimitExceeded + - ReportsLimitsExceeded - ContentLengthTooLarge x-ms-enum: name: FailedQueueItemDtoErrorCode @@ -28849,6 +29512,7 @@ components: enum: - RobotJob - StudioWebDesigner + - PublishStudioProject x-ms-enum: name: JobDtoServerlessJobType modelAsString: false @@ -29108,14 +29772,14 @@ components: - Job - Task - Timer - - Integration + - Inbox x-enum-varnames: - None - QueueItem - Job - Task - Timer - - Integration + - Inbox x-ms-enum: name: JobTriggerDtoTriggerType modelAsString: false @@ -29133,6 +29797,10 @@ components: x-ms-enum: name: JobTriggerDtoStatus modelAsString: false + ItemKey: + type: string + description: item Key (queue item key, task key, job key etc) + format: uuid ItemId: type: integer description: item Id (queue item id, task id, job id etc) @@ -29168,14 +29836,14 @@ components: - Job - Task - Timer - - Integration + - Inbox x-enum-varnames: - None - QueueItem - Job - Task - Timer - - Integration + - Inbox x-ms-enum: name: JobTriggerWaitEventModelTriggerType modelAsString: false @@ -29193,6 +29861,10 @@ components: x-ms-enum: name: JobTriggerWaitEventModelStatus modelAsString: false + ItemKey: + type: string + description: The resume item Key (queue item, task, job) + format: uuid ItemId: type: integer description: item Id (queue item id, task id, job id etc) @@ -29648,12 +30320,16 @@ components: - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: LicenseRuntimeDtoMachineScope modelAsString: false @@ -29798,7 +30474,7 @@ components: ListResultDtoOfNameValueDto: type: object properties: - items: + Items: type: array items: $ref: '#/components/schemas/NameValueDto' @@ -29928,15 +30604,26 @@ components: MachineCreatedEvent: type: object properties: - key: + id: + type: integer + format: int64 + readOnly: true + tenantId: + type: integer + format: int32 + entityKey: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string + readOnly: true type: type: string + readOnly: true enum: - Standard - Template @@ -29948,23 +30635,94 @@ components: modelAsString: false scope: type: string + readOnly: true enum: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: MachineCreatedEventScope modelAsString: false + nonProductionSlots: + type: integer + format: int32 + readOnly: true + unattendedSlots: + type: integer + format: int32 + readOnly: true + headlessSlots: + type: integer + format: int32 + readOnly: true + testAutomationSlots: + type: integer + format: int32 + readOnly: true + developmentSlots: + type: integer + format: int32 + readOnly: true + automationCloudSlots: + type: integer + format: int32 + readOnly: true + automationCloudTestAutomationSlots: + type: integer + format: int32 + readOnly: true + automationType: + type: string + readOnly: true + enum: + - Any + - Foreground + - Background + x-enum-varnames: + - Any + - Foreground + - Background + x-ms-enum: + name: MachineCreatedEventAutomationType + modelAsString: false + targetFramework: + type: string + readOnly: true + enum: + - Any + - Windows + - Portable + x-enum-varnames: + - Any + - Windows + - Portable + x-ms-enum: + name: MachineCreatedEventTargetFramework + modelAsString: false + serverlessLicensingModel: + type: string + readOnly: true + enum: + - RobotUnits + - LicenseSlots + x-ms-enum: + name: MachineCreatedEventServerlessLicensingModel + modelAsString: false tags: type: array + readOnly: true items: $ref: '#/components/schemas/TagDto' eventTime: @@ -29983,15 +30741,26 @@ components: MachineDeletedEvent: type: object properties: - key: + id: + type: integer + format: int64 + readOnly: true + tenantId: + type: integer + format: int32 + entityKey: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string - machineType: + readOnly: true + type: type: string + readOnly: true enum: - Standard - Template @@ -29999,25 +30768,100 @@ components: - Standard - Template x-ms-enum: - name: MachineDeletedEventMachineType + name: MachineDeletedEventType modelAsString: false - machineScope: + scope: type: string + readOnly: true enum: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot + x-ms-enum: + name: MachineDeletedEventScope + modelAsString: false + nonProductionSlots: + type: integer + format: int32 + readOnly: true + unattendedSlots: + type: integer + format: int32 + readOnly: true + headlessSlots: + type: integer + format: int32 + readOnly: true + testAutomationSlots: + type: integer + format: int32 + readOnly: true + developmentSlots: + type: integer + format: int32 + readOnly: true + automationCloudSlots: + type: integer + format: int32 + readOnly: true + automationCloudTestAutomationSlots: + type: integer + format: int32 + readOnly: true + automationType: + type: string + readOnly: true + enum: + - Any + - Foreground + - Background + x-enum-varnames: + - Any + - Foreground + - Background + x-ms-enum: + name: MachineDeletedEventAutomationType + modelAsString: false + targetFramework: + type: string + readOnly: true + enum: + - Any + - Windows + - Portable + x-enum-varnames: + - Any + - Windows + - Portable x-ms-enum: - name: MachineDeletedEventMachineScope + name: MachineDeletedEventTargetFramework modelAsString: false + serverlessLicensingModel: + type: string + readOnly: true + enum: + - RobotUnits + - LicenseSlots + x-ms-enum: + name: MachineDeletedEventServerlessLicensingModel + modelAsString: false + tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' eventTime: type: string format: date-time @@ -30063,12 +30907,16 @@ components: - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: MachineDtoScope modelAsString: false @@ -30152,6 +31000,16 @@ components: x-ms-enum: name: MachineDtoTargetFramework modelAsString: false + ServerlessLicensingModel: + type: string + description: The type of serverless licensing model + readOnly: true + enum: + - RobotUnits + - LicenseSlots + x-ms-enum: + name: MachineDtoServerlessLicensingModel + modelAsString: false UpdatePolicy: $ref: '#/components/schemas/UpdatePolicyDto' ClientSecret: @@ -30485,12 +31343,16 @@ components: - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: MachineSessionRuntimeDtoMachineScope modelAsString: false @@ -30550,15 +31412,26 @@ components: MachineUpdatedEvent: type: object properties: - key: + id: + type: integer + format: int64 + readOnly: true + tenantId: + type: integer + format: int32 + entityKey: type: string format: uuid + readOnly: true name: type: string + readOnly: true description: type: string + readOnly: true type: type: string + readOnly: true enum: - Standard - Template @@ -30570,23 +31443,94 @@ components: modelAsString: false scope: type: string + readOnly: true enum: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-enum-varnames: - Default - Shared - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: MachineUpdatedEventScope modelAsString: false + nonProductionSlots: + type: integer + format: int32 + readOnly: true + unattendedSlots: + type: integer + format: int32 + readOnly: true + headlessSlots: + type: integer + format: int32 + readOnly: true + testAutomationSlots: + type: integer + format: int32 + readOnly: true + developmentSlots: + type: integer + format: int32 + readOnly: true + automationCloudSlots: + type: integer + format: int32 + readOnly: true + automationCloudTestAutomationSlots: + type: integer + format: int32 + readOnly: true + automationType: + type: string + readOnly: true + enum: + - Any + - Foreground + - Background + x-enum-varnames: + - Any + - Foreground + - Background + x-ms-enum: + name: MachineUpdatedEventAutomationType + modelAsString: false + targetFramework: + type: string + readOnly: true + enum: + - Any + - Windows + - Portable + x-enum-varnames: + - Any + - Windows + - Portable + x-ms-enum: + name: MachineUpdatedEventTargetFramework + modelAsString: false + serverlessLicensingModel: + type: string + readOnly: true + enum: + - RobotUnits + - LicenseSlots + x-ms-enum: + name: MachineUpdatedEventServerlessLicensingModel + modelAsString: false tags: type: array + readOnly: true items: $ref: '#/components/schemas/TagDto' eventTime: @@ -31555,9 +32499,14 @@ components: type: string IsActive: type: boolean + description: 'DEPRECATED. ' + x-deprecated: true OwnerId: type: integer format: int64 + OwnerKey: + type: string + format: uuid OwnerName: type: string LastLogin: @@ -31771,10 +32720,32 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true + description: + type: string + readOnly: true + enabled: + type: boolean + readOnly: true + releaseName: + type: string + readOnly: true + packageName: + type: string + readOnly: true + environmentName: + type: string + readOnly: true + specificPriorityValue: + type: integer + format: int32 + readOnly: true runtimeType: type: string + readOnly: true enum: - NonProduction - Attended @@ -31797,22 +32768,88 @@ components: x-ms-enum: name: ProcessScheduleCreatedEventRuntimeType modelAsString: false - triggerType: + stopProcessExpression: type: string - folderKeys: + readOnly: true + stopStrategy: + type: string + readOnly: true + enum: + - SoftStop + - Kill + x-ms-enum: + name: ProcessScheduleCreatedEventStopStrategy + modelAsString: false + killProcessExpression: + type: string + readOnly: true + timeZoneId: + type: string + readOnly: true + stopProcessDate: + type: string + format: date-time + readOnly: true + inputArguments: + type: string + readOnly: true + queueDefinitionName: + type: string + readOnly: true + activateOnJobComplete: + type: boolean + readOnly: true + itemsActivationThreshold: + type: integer + format: int64 + readOnly: true + itemsPerJobActivationTarget: + type: integer + format: int64 + readOnly: true + maxJobsForActivation: + type: integer + format: int64 + readOnly: true + resumeOnSameContext: + type: boolean + readOnly: true + tags: type: array + readOnly: true items: - type: string - format: uuid - dependencies: + $ref: '#/components/schemas/TagDto' + alertPendingExpression: + type: string + readOnly: true + alertRunningExpression: + type: string + readOnly: true + runAsMe: + type: boolean + readOnly: true + consecutiveJobFailuresThreshold: + type: integer + format: int32 + readOnly: true + jobFailuresGracePeriodInHours: + type: integer + format: int32 + readOnly: true + isConnected: + type: boolean + readOnly: true + releaseKey: + type: string + format: uuid + queueDefinitionKey: + type: string + format: uuid + folderKeys: type: array items: type: string format: uuid - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' eventTime: type: string format: date-time @@ -31824,10 +32861,32 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true + description: + type: string + readOnly: true + enabled: + type: boolean + readOnly: true + releaseName: + type: string + readOnly: true + packageName: + type: string + readOnly: true + environmentName: + type: string + readOnly: true + specificPriorityValue: + type: integer + format: int32 + readOnly: true runtimeType: type: string + readOnly: true enum: - NonProduction - Attended @@ -31850,12 +32909,84 @@ components: x-ms-enum: name: ProcessScheduleDeletedEventRuntimeType modelAsString: false - folderKeys: + stopProcessExpression: + type: string + readOnly: true + stopStrategy: + type: string + readOnly: true + enum: + - SoftStop + - Kill + x-ms-enum: + name: ProcessScheduleDeletedEventStopStrategy + modelAsString: false + killProcessExpression: + type: string + readOnly: true + timeZoneId: + type: string + readOnly: true + stopProcessDate: + type: string + format: date-time + readOnly: true + inputArguments: + type: string + readOnly: true + queueDefinitionName: + type: string + readOnly: true + activateOnJobComplete: + type: boolean + readOnly: true + itemsActivationThreshold: + type: integer + format: int64 + readOnly: true + itemsPerJobActivationTarget: + type: integer + format: int64 + readOnly: true + maxJobsForActivation: + type: integer + format: int64 + readOnly: true + resumeOnSameContext: + type: boolean + readOnly: true + tags: type: array + readOnly: true items: - type: string - format: uuid - dependencies: + $ref: '#/components/schemas/TagDto' + alertPendingExpression: + type: string + readOnly: true + alertRunningExpression: + type: string + readOnly: true + runAsMe: + type: boolean + readOnly: true + consecutiveJobFailuresThreshold: + type: integer + format: int32 + readOnly: true + jobFailuresGracePeriodInHours: + type: integer + format: int32 + readOnly: true + isConnected: + type: boolean + readOnly: true + releaseKey: + type: string + format: uuid + queueDefinitionKey: + type: string + format: uuid + folderKeys: type: array items: type: string @@ -32134,10 +33265,32 @@ components: key: type: string format: uuid + readOnly: true name: type: string + readOnly: true + description: + type: string + readOnly: true + enabled: + type: boolean + readOnly: true + releaseName: + type: string + readOnly: true + packageName: + type: string + readOnly: true + environmentName: + type: string + readOnly: true + specificPriorityValue: + type: integer + format: int32 + readOnly: true runtimeType: type: string + readOnly: true enum: - NonProduction - Attended @@ -32160,22 +33313,88 @@ components: x-ms-enum: name: ProcessScheduleUpdatedEventRuntimeType modelAsString: false - triggerType: + stopProcessExpression: type: string - folderKeys: + readOnly: true + stopStrategy: + type: string + readOnly: true + enum: + - SoftStop + - Kill + x-ms-enum: + name: ProcessScheduleUpdatedEventStopStrategy + modelAsString: false + killProcessExpression: + type: string + readOnly: true + timeZoneId: + type: string + readOnly: true + stopProcessDate: + type: string + format: date-time + readOnly: true + inputArguments: + type: string + readOnly: true + queueDefinitionName: + type: string + readOnly: true + activateOnJobComplete: + type: boolean + readOnly: true + itemsActivationThreshold: + type: integer + format: int64 + readOnly: true + itemsPerJobActivationTarget: + type: integer + format: int64 + readOnly: true + maxJobsForActivation: + type: integer + format: int64 + readOnly: true + resumeOnSameContext: + type: boolean + readOnly: true + tags: type: array + readOnly: true items: - type: string - format: uuid - dependencies: + $ref: '#/components/schemas/TagDto' + alertPendingExpression: + type: string + readOnly: true + alertRunningExpression: + type: string + readOnly: true + runAsMe: + type: boolean + readOnly: true + consecutiveJobFailuresThreshold: + type: integer + format: int32 + readOnly: true + jobFailuresGracePeriodInHours: + type: integer + format: int32 + readOnly: true + isConnected: + type: boolean + readOnly: true + releaseKey: + type: string + format: uuid + queueDefinitionKey: + type: string + format: uuid + folderKeys: type: array items: type: string format: uuid - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' eventTime: type: string format: date-time @@ -32211,6 +33430,8 @@ components: type: boolean AlwaysRunning: type: boolean + EnableAutopilotHealing: + type: boolean ProcessesSetArgumentsRequest: required: - arguments @@ -32251,30 +33472,6 @@ components: description: Time when the exception occurred format: date-time description: Stores information about exceptions thrown while processing failed queue items. - QueueCreatedEvent: - type: object - properties: - key: - type: string - format: uuid - name: - type: string - description: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' - folderKeys: - type: array - items: - type: string - format: uuid - eventTime: - type: string - format: date-time - eventSource: - type: object QueueCreatedEventDto: required: - EventId @@ -32349,6 +33546,9 @@ components: AcceptAutomaticallyRetry: type: boolean description: States whether a robot should retry to process an item if, after processing, it failed with application exception. + RetryAbandonedItems: + type: boolean + description: States whether a robot should retry to process an abandoned item EnforceUniqueReference: type: boolean description: States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule. @@ -32440,6 +33640,10 @@ components: type: boolean description: States whether a robot should retry to process an item if, after processing, it failed with application exception. readOnly: true + RetryAbandonedItems: + type: boolean + description: States whether a robot should retry to process an abandoned item + readOnly: true EnforceUniqueReference: type: boolean description: States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule. @@ -32455,26 +33659,6 @@ components: format: int32 readOnly: true description: The definition of a work queue. A work queue contains work items that are processed by robots. - QueueDeletedEvent: - type: object - properties: - key: - type: string - format: uuid - name: - type: string - description: - type: string - folderKeys: - type: array - items: - type: string - format: uuid - eventTime: - type: string - format: date-time - eventSource: - type: object QueueDeletedEventDto: required: - EventId @@ -32842,6 +34026,14 @@ components: RobotId: type: integer format: int64 + CreatorJobKey: + type: string + description: The unique identifier for the job that created the queue item + format: uuid + ExecutorJobKey: + type: string + description: The unique identifier for the job that processed the queue item + format: uuid DeferDate: type: string description: The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible. @@ -33456,6 +34648,9 @@ components: QueueDefinitionAcceptAutomaticallyRetry: type: boolean description: States whether the queue accepts automatic item retry or not. + QueueDefinitionRetryAbandonedItems: + type: boolean + description: States whether the queue accepts automatic abandoned item retry or not. QueueDefinitionMaxNumberOfRetries: type: integer description: The maximum number of retries allowed for any item of the queue. @@ -33607,33 +34802,6 @@ components: type: array items: $ref: '#/components/schemas/LongVersionedEntity' - QueueUpdatedEvent: - type: object - properties: - key: - type: string - format: uuid - name: - type: string - description: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' - folderKeys: - type: array - items: - type: string - format: uuid - retentionBucketId: - type: integer - format: int64 - eventTime: - type: string - format: date-time - eventSource: - type: object QueueUpdatedEventDto: required: - EventId @@ -34144,6 +35312,14 @@ components: items: type: integer format: int64 + RemoveUserByKeyFromFolderRequest: + required: + - userKey + type: object + properties: + userKey: + type: string + format: uuid RemoveUserFromFolderRequest: required: - userId @@ -34236,6 +35412,8 @@ components: jobId: type: integer format: int64 + enableAutopilotHealing: + type: boolean ResumeJobRequest: required: - jobKey @@ -35542,6 +36720,10 @@ components: type: integer format: int32 readOnly: true + ProjectKey: + type: string + format: uuid + readOnly: true RuntimeType: type: string enum: @@ -35598,6 +36780,16 @@ components: $ref: '#/components/schemas/SimpleMachineDto' Release: $ref: '#/components/schemas/SimpleReleaseEventDto' + ServerlessJobType: + type: string + readOnly: true + enum: + - RobotJob + - StudioWebDesigner + - PublishStudioProject + x-ms-enum: + name: SimpleJobEventDtoServerlessJobType + modelAsString: false SimpleMachineDto: type: object properties: @@ -35627,6 +36819,8 @@ components: - PersonalWorkspace - Cloud - Serverless + - AutomationCloudRobot + - ElasticRobot x-ms-enum: name: SimpleMachineDtoScope modelAsString: false @@ -36093,7 +37287,8 @@ components: format: email IsEmailConfirmed: type: boolean - description: States if the email address is valid or not. + description: DEPRECATED. States if the email address is valid or not. + x-deprecated: true LastLoginTime: type: string description: The date and time when the user last logged in, or null if the user never logged in. @@ -36232,6 +37427,8 @@ components: $ref: '#/components/schemas/UpdatePolicyDto' AccountId: type: string + HasOnlyInheritedPrivileges: + type: boolean LastModificationTime: type: string format: date-time @@ -36550,6 +37747,8 @@ components: minLength: 0 type: string description: Operation id which started the job. + EnableAutopilotHealing: + type: boolean description: The Start Process transfers information from client to the server during JobsController.StartJobs custom action. StopJobRequest: required: @@ -36637,6 +37836,10 @@ components: type: integer description: Gets or sets the Id of Task to which this Note belongs to. format: int64 + TaskKey: + type: string + description: The Key of a the Task that the current item belongs to + format: uuid ActivityType: type: string description: Gets or sets the activity type performed on Task. @@ -37008,47 +38211,6 @@ components: minLength: 0 type: string description: Operation id which created the task. - TaskCreatedEvent: - type: object - properties: - key: - type: string - format: uuid - name: - type: string - type: - type: string - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-enum-varnames: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-ms-enum: - name: TaskCreatedEventType - modelAsString: false - folderKeys: - type: array - items: - type: string - format: uuid - tags: - type: array - items: - $ref: '#/components/schemas/TagDto' - eventTime: - type: string - format: date-time - eventSource: - type: object TaskCreatedEventDto: required: - EventId @@ -37144,6 +38306,11 @@ components: $ref: '#/components/schemas/TagDto' assignedToUser: $ref: '#/components/schemas/UserLoginInfoDto' + taskSlaDetails: + type: array + description: Gets or sets the expiry time of Actionable Task Schedule + items: + $ref: '#/components/schemas/TaskSlaDetailDto' title: type: string description: Gets or sets title of this task. @@ -37213,6 +38380,10 @@ components: parentOperationId: type: string description: Operation id which created the task. + key: + type: string + description: The unique Task identifier. + format: uuid isDeleted: type: boolean deleterUserId: @@ -37371,43 +38542,6 @@ components: type: array items: $ref: '#/components/schemas/TaskDefintionAssociatedVersionsDto' - TaskDeletedEvent: - type: object - properties: - key: - type: string - format: uuid - name: - type: string - type: - type: string - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-enum-varnames: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-ms-enum: - name: TaskDeletedEventType - modelAsString: false - folderKeys: - type: array - items: - type: string - format: uuid - eventTime: - type: string - format: date-time - eventSource: - type: object TaskDeletedEventDto: required: - EventId @@ -37506,6 +38640,8 @@ components: description: Gets the associated task activities for the task items: $ref: '#/components/schemas/TaskActivityDto' + TaskSlaDetail: + $ref: '#/components/schemas/TaskSlaDetailDto' Title: type: string description: Gets or sets title of this task. @@ -37575,6 +38711,10 @@ components: ParentOperationId: type: string description: Operation id which created the task. + Key: + type: string + description: The unique Task identifier. + format: uuid IsDeleted: type: boolean DeleterUserId: @@ -37662,6 +38802,11 @@ components: $ref: '#/components/schemas/TagDto' assignedToUser: $ref: '#/components/schemas/UserLoginInfoDto' + taskSlaDetails: + type: array + description: Gets or sets the expiry time of Actionable Task Schedule + items: + $ref: '#/components/schemas/TaskSlaDetailDto' title: type: string description: Gets or sets title of this task. @@ -37731,6 +38876,10 @@ components: parentOperationId: type: string description: Operation id which created the task. + key: + type: string + description: The unique Task identifier. + format: uuid isDeleted: type: boolean deleterUserId: @@ -37973,6 +39122,165 @@ components: format: int64 description: Dto for UiPath.Orchestrator.LedgerEvents.TaskSaved. Gets raised when task is Saved x-webhook-event: task.saved + TaskSlaDetailDto: + type: object + properties: + expiryTime: + type: string + format: date-time + startCriteria: + type: string + enum: + - TaskCreated + - TaskAssigned + - TaskCompleted + x-enum-varnames: + - TaskCreated + - TaskAssigned + - TaskCompleted + x-ms-enum: + name: TaskSlaDetailDtoStartCriteria + modelAsString: false + endCriteria: + type: string + enum: + - TaskCreated + - TaskAssigned + - TaskCompleted + x-enum-varnames: + - TaskCreated + - TaskAssigned + - TaskCompleted + x-ms-enum: + name: TaskSlaDetailDtoEndCriteria + modelAsString: false + status: + type: string + enum: + - OverdueLater + - OverdueSoon + - Overdue + - CompletedInTime + x-enum-varnames: + - OverdueLater + - OverdueSoon + - Overdue + - CompletedInTime + x-ms-enum: + name: TaskSlaDetailDtoStatus + modelAsString: false + TaskSlaEvaluateEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + TaskId: + type: integer + format: int64 + TaskSlaConfigId: + type: integer + format: int64 + IsActionable: + type: boolean + ExpiryTime: + type: string + format: date-time + LedgerId: + type: integer + format: int64 + EventTime: + type: string + format: date-time + EventSourceId: + type: integer + format: int64 + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: Dto for UiPath.Orchestrator.LedgerEvents.TaskSlaEvaluate. Gets raised when sla schedule is expired + x-webhook-event: task.sla.evaluate + TaskSlaUpdateEventDto: + required: + - EventId + - Timestamp + - Type + type: object + properties: + Type: + minLength: 1 + type: string + EventId: + maxLength: 50 + minLength: 0 + type: string + EntityKey: + type: string + format: uuid + Timestamp: + type: string + format: date-time + TaskIds: + type: array + items: + type: integer + format: int64 + TaskStatus: + type: string + enum: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: TaskSlaUpdateEventDtoTaskStatus + modelAsString: false + IsDeleted: + type: boolean + EventTime: + type: string + format: date-time + EventSourceId: + type: integer + format: int64 + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + description: Dto for UiPath.Orchestrator.LedgerEvents.TaskSlaUpdate. Gets raised when tasks with sla configs are deleted + x-webhook-event: task.sla.update TaskTagsSaveRequest: required: - taskId @@ -37987,47 +39295,51 @@ components: description: Tags collection items: $ref: '#/components/schemas/TagDto' - TaskUpdatedEvent: + TaskUpdatedEventDto: + required: + - EventId + - Timestamp + - Type type: object properties: - key: + Type: + minLength: 1 type: string - format: uuid - name: + EventId: + maxLength: 50 + minLength: 0 type: string - type: + EntityKey: type: string - enum: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-enum-varnames: - - FormTask - - ExternalTask - - DocumentValidationTask - - DocumentClassificationTask - - DataLabelingTask - - AppTask - x-ms-enum: - name: TaskUpdatedEventType - modelAsString: false - folderKeys: - type: array - items: - type: string - format: uuid - tags: + format: uuid + Timestamp: + type: string + format: date-time + Tasks: type: array + readOnly: true items: - $ref: '#/components/schemas/TagDto' - eventTime: + $ref: '#/components/schemas/WrappedTaskUpdatedDto' + EventTime: type: string format: date-time - eventSource: - type: object + EventSourceId: + type: integer + format: int64 + readOnly: true + TenantId: + type: integer + format: int32 + OrganizationUnitId: + type: integer + format: int64 + OrganizationUnitKey: + type: string + format: uuid + UserId: + type: integer + format: int64 + x-webhook-event: task.updated TasksAssignRequest: required: - taskAssignments @@ -38095,16 +39407,6 @@ components: IsActive: type: boolean description: Specifies if the tenant is active or not. - AcceptedDomainsList: - type: array - description: DEPRECATED. Accepted DNS list. - items: - type: string - x-deprecated: true - HasConnectionString: - type: boolean - description: DEPRECATED. Specifies if the the tenant has a connection string defined - x-deprecated: true ConnectionString: maxLength: 1024 minLength: 0 @@ -39273,7 +40575,8 @@ components: format: email IsEmailConfirmed: type: boolean - description: States if the email address is valid or not. + description: DEPRECATED. States if the email address is valid or not. + x-deprecated: true LastLoginTime: type: string description: The date and time when the user last logged in, or null if the user never logged in. @@ -39412,6 +40715,8 @@ components: $ref: '#/components/schemas/UpdatePolicyDto' AccountId: type: string + HasOnlyInheritedPrivileges: + type: boolean LastModificationTime: type: string format: date-time @@ -39537,6 +40842,14 @@ components: type: boolean description: 'DEPRECATED. ' x-deprecated: true + RateLimitsDaily: + type: boolean + description: 'DEPRECATED. ' + x-deprecated: true + RateLimitsRealTime: + type: boolean + description: 'DEPRECATED. ' + x-deprecated: true UserOrganizationUnitDto: type: object properties: @@ -40112,6 +41425,15 @@ components: type: string description: The operation id which created the Task readOnly: true + Key: + type: string + format: uuid + readOnly: true + Tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' Title: type: string readOnly: true @@ -40413,6 +41735,17 @@ components: type: string description: The project key which the job is part of readOnly: true + ServerlessJobType: + type: string + description: The serverless job type for this job + readOnly: true + enum: + - RobotJob + - StudioWebDesigner + - PublishStudioProject + x-ms-enum: + name: WrappedJobDtoServerlessJobType + modelAsString: false ParentOperationId: type: string description: The operation id which created the job @@ -40610,6 +41943,10 @@ components: type: object properties: {} readOnly: true + PackageDefinitionKey: + type: string + format: uuid + readOnly: true WrappedRobotDto: type: object properties: @@ -40788,6 +42125,10 @@ components: WrappedTaskDeletedDto: type: object properties: + Key: + type: string + format: uuid + readOnly: true Title: type: string readOnly: true @@ -41032,6 +42373,90 @@ components: format: int64 readOnly: true description: This class defines DTO for Tasks Collection for webhook event Task.Saved + WrappedTaskUpdatedDto: + type: object + properties: + Key: + type: string + format: uuid + readOnly: true + Tags: + type: array + readOnly: true + items: + $ref: '#/components/schemas/TagDto' + Title: + type: string + readOnly: true + Type: + type: string + readOnly: true + enum: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-enum-varnames: + - FormTask + - ExternalTask + - DocumentValidationTask + - DocumentClassificationTask + - DataLabelingTask + - AppTask + x-ms-enum: + name: BaseWebhookTaskDtoType + modelAsString: false + Priority: + type: string + readOnly: true + enum: + - Low + - Medium + - High + - Critical + x-enum-varnames: + - Low + - Medium + - High + - Critical + x-ms-enum: + name: BaseWebhookTaskDtoPriority + modelAsString: false + Status: + type: string + readOnly: true + enum: + - Unassigned + - Pending + - Completed + x-enum-varnames: + - Unassigned + - Pending + - Completed + x-ms-enum: + name: BaseWebhookTaskDtoStatus + modelAsString: false + CreationTime: + type: string + format: date-time + readOnly: true + TaskCatalogName: + type: string + readOnly: true + Id: + type: integer + format: int64 + readOnly: true + OrganizationUnitId: + type: integer + format: int64 + readOnly: true + AssignedToUserId: + type: integer + format: int64 + readOnly: true securitySchemes: OAuth2: type: oauth2