From 89d2aa825bd478c2c72aeb5b81881671224e0bcf Mon Sep 17 00:00:00 2001 From: mesellings Date: Tue, 17 Dec 2024 08:46:18 +0000 Subject: [PATCH] Wording edits --- .../web-modeler/idp/idp-applications.md | 14 ++++++---- .../idp/idp-document-automation.md | 4 +-- .../idp/idp-document-extraction.md | 5 ++-- .../modeler/web-modeler/idp/idp-reference.md | 18 ++++++++---- .../idp/idp-unstructured-extraction.md | 28 ++++++++++--------- 5 files changed, 40 insertions(+), 29 deletions(-) diff --git a/docs/components/modeler/web-modeler/idp/idp-applications.md b/docs/components/modeler/web-modeler/idp/idp-applications.md index 64e12c3a0d..b5b8b0c9b2 100644 --- a/docs/components/modeler/web-modeler/idp/idp-applications.md +++ b/docs/components/modeler/web-modeler/idp/idp-applications.md @@ -10,11 +10,6 @@ Create and manage your IDP projects in an **IDP application** folder. IDP application screen -- IDP applications and projects are only fully operational when linked to a healthy, active cluster. You can select an unstable or unhealthy cluster when first creating an IDP application, and change to a stable cluster when required. -- You can only select a cluster that supports Camunda document handling (8.7+). -- You cannot change the selected cluster of an IDP application after it has been created. -- Camunda recommends using a development cluster as best practice. - ## Create an IDP application To create an IDP application: @@ -28,4 +23,11 @@ To create an IDP application: ::: 1. Click **Create** to create the IDP application. -1. You can now add and create [document extraction](idp-document-extraction.md) and [document automation](idp-document-automation.md) projects in your IDP application. +1. You can now create [document extraction](idp-document-extraction.md) and [document automation](idp-document-automation.md) projects in your IDP application. + +## IDP application clusters + +- IDP applications and projects are only fully operational when linked to a healthy, active cluster. You can select an unstable or unhealthy cluster when first creating an IDP application, and change to a stable cluster when required. +- You can only select a cluster that supports Camunda document handling (8.7+). +- You cannot change the cluster of an IDP application after it has been created. +- Camunda recommends using a development cluster for your IDP applications. diff --git a/docs/components/modeler/web-modeler/idp/idp-document-automation.md b/docs/components/modeler/web-modeler/idp/idp-document-automation.md index e7b97ee53f..3097b31c9d 100644 --- a/docs/components/modeler/web-modeler/idp/idp-document-automation.md +++ b/docs/components/modeler/web-modeler/idp/idp-document-automation.md @@ -4,7 +4,7 @@ title: Document automation description: "You can import a BPMN or DMN diagram at any time with Web Modeler." --- -Create a document automation project to automatically classify and extract data based on linked document extraction models. +Extract data from complex documents based on one or more linked [document extraction](idp-document-extraction.md) projects. ## About document automation @@ -13,7 +13,7 @@ Document automation allows you to automatically extract data from complex PDF do For example, if you want to process large multi-page PDFs containing multiple document types (invoices, reports, forms), you can create a document automation project to extract the specific data you want. - You must link at least one [document extraction](idp-document-extraction.md) project so the LLM can accurately analyze, classify, and extract document data. -- You can choose the LLM you want to use, allowing you to test different models until you find the one that best suits your budget and accuracy requirements. +- Choose and test different LLM models to find the one that best suits your budget and accuracy requirements. - Document classification involves automatically categorizing documents into predefined classes/types, based on their content. ## Create document automation project diff --git a/docs/components/modeler/web-modeler/idp/idp-document-extraction.md b/docs/components/modeler/web-modeler/idp/idp-document-extraction.md index fb82e9c9c5..372618ba44 100644 --- a/docs/components/modeler/web-modeler/idp/idp-document-extraction.md +++ b/docs/components/modeler/web-modeler/idp/idp-document-extraction.md @@ -6,14 +6,15 @@ description: "You can import a BPMN or DMN diagram at any time with Web Modeler. import IdpExtractionProjectModalImg from './img/idp-create-extraction-project-modal.png'; -Create a document extraction project to identify and extract specific data from your structured and unstructured documents. +Extract data from a single type of structured or unstructured document. ## About document extraction Document extraction projects form the basis for using IDP in your end-to-end processes. - Create a separate document extraction project for each type of document you want to categorize and extract data from, such as an invoice, a report, identity document, and so on. -- Once published, extraction projects can be added to your processes, or linked to a [document automation](idp-document-automation.md) project. + +- Once published, extraction projects can be [integrated into your processes](idp-integrate.md) or linked to a [document automation](idp-document-automation.md) project. ## Create document extraction project diff --git a/docs/components/modeler/web-modeler/idp/idp-reference.md b/docs/components/modeler/web-modeler/idp/idp-reference.md index 5397ba55bf..2530b5685d 100644 --- a/docs/components/modeler/web-modeler/idp/idp-reference.md +++ b/docs/components/modeler/web-modeler/idp/idp-reference.md @@ -6,16 +6,22 @@ description: "You can import a BPMN or DMN diagram at any time with Web Modeler. The following technical reference information is provided for IDP. -## Supported document types +## Document file formats -IDP currently supports processing and data extraction for the following types of document. +IDP currently only supports data extraction from the following document file formats. -| Document Type | Description | -| :------------ | :----------------------------------------------------------------------------------------------------------------------- | -| PDF |

| +| File format | Description | +| :---------- | :---------------------------------------------------------------------------------------------------------------- | +| PDF |

| ## Document storage -Uploaded documents are stored in Web Modeler, not your cluster. +For SaaS, uploaded documents are stored in Web Modeler itself, not your cluster. ## Extraction field types + +You can use any of the following field types when creating an extraction field. + +| Field type | Description | +| :--------- | :---------- | +| Number | ... | diff --git a/docs/components/modeler/web-modeler/idp/idp-unstructured-extraction.md b/docs/components/modeler/web-modeler/idp/idp-unstructured-extraction.md index 8cff2e0b0e..5ca970c95c 100644 --- a/docs/components/modeler/web-modeler/idp/idp-unstructured-extraction.md +++ b/docs/components/modeler/web-modeler/idp/idp-unstructured-extraction.md @@ -22,8 +22,8 @@ Complete the following steps to configure and publish an unstructured data extra 1. [Upload documents](#step-1-upload-documents): Upload a set of sample documents to use for training the extraction model. 1. [Extract fields](#step-2-extract-fields): Add and configure the [extraction fields](idp-key-concepts.md#extraction-fields) you want to use to extract data. -1. [Validate extraction](#step-3-validate-extraction): Test the data extraction using your uploaded document(s) and evaluate the extraction results. -1. [Publish](#step-4-publish): Publish the project to make it available for use in your processes and [document automation](idp-document-automation.md) projects. +1. [Validate extraction](#step-3-validate-extraction): Test and evaluate the data extraction results using your uploaded documents. +1. [Publish](#step-4-publish): Publish the project to make it available for use [in your processes](idp-integrate.md) and [document automation](idp-document-automation.md) projects.