document-understanding
2024.10
true
- Démarrage
- Exemples d’utilisation de l’API Document Understanding™
- Exécution d’appels API
- Créer un nouveau projet et une application externe
- Utiliser les API de découverte
- utiliser les API de numérisation
- Licences
- Résolution des problèmes
Utiliser les API de découverte
Guide de l’API Document Understanding
Last updated 11 nov. 2024
Utiliser les API de découverte
Envoyez une requête GET à l'itinéraire du projet (aucun ID n'est requis) à l'aide du service de découverte pour récupérer les informations sur le projet nouvellement créé. L'URL nécessite le chemin org/tenant et /du_/dpi/framework/projects. Une fois que vous avez reçu la réponse, chaque autre appel qui suit nécessite des informations (
projectID
, classifierID
, extractionID
, etc.) qui sont disponibles dans les réponses des Appels de découverte.
Récupère tous les projets disponibles dans Document UnderstandingTM.
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs***Q'
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs***Q'
Fournit des détails sur le projet prédéfini utilisé.
{
"projects": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Predefined",
"description": "Predefined models to be used for standard scenarios. For custom extractors, create a Project in the Document Understanding app in Automation Cloud",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1.0",
"createdOn": "2023-05-01T19:10:04.8751081Z"
},
{
"id": "0884c3e4-5064-ed11-ac20-cc60c8b14803",
"name": "DU Bootcamp",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/classifiers?api-version=1.0",
"createdOn": "2022-11-14T19:16:52.6658079Z"
},
{
"id": "15895968-855e-ed11-ade6-cc60c85b4740",
"name": "Documentation",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/classifiers?api-version=1.0",
"createdOn": "2022-11-07T10:17:40.2729322Z"
},
{
"id": "64b8c43f-2046-ec11-981f-0050f281975f",
"name": "ACORD",
"description": "",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/classifiers?api-version=1.0",
"createdOn": "2021-11-15T14:28:07.4366667Z"
},
]
}
{
"projects": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Predefined",
"description": "Predefined models to be used for standard scenarios. For custom extractors, create a Project in the Document Understanding app in Automation Cloud",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1.0",
"createdOn": "2023-05-01T19:10:04.8751081Z"
},
{
"id": "0884c3e4-5064-ed11-ac20-cc60c8b14803",
"name": "DU Bootcamp",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/classifiers?api-version=1.0",
"createdOn": "2022-11-14T19:16:52.6658079Z"
},
{
"id": "15895968-855e-ed11-ade6-cc60c85b4740",
"name": "Documentation",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/classifiers?api-version=1.0",
"createdOn": "2022-11-07T10:17:40.2729322Z"
},
{
"id": "64b8c43f-2046-ec11-981f-0050f281975f",
"name": "ACORD",
"description": "",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f?api-version=1.0",
"digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/digitization/start?api-version=1.0",
"extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/extractors?api-version=1.0",
"classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/classifiers?api-version=1.0",
"createdOn": "2021-11-15T14:28:07.4366667Z"
},
]
}
Récupérez tous les extracteurs d'un projet.
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer e***ik5-CinKm6A'
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer e***ik5-CinKm6A'
Fournit des informations sur les extracteurs disponibles pour le projet mentionné.
Cet exemple a été réduit, pour des raisons de lisibilité.
{
"extractors": [
{
"id": "invoices",
"name": "Invoices",
"documentTypeId": "invoices",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction/start?api-version=1.0"
},
{
"id": "acord140",
"name": "ACORD 140",
"documentTypeId": "acord140",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction/start?api-version=1.0"
},
{
"id": "vehicle_titles",
"name": "Vehicle Titles",
"documentTypeId": "vehicle_titles",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction/start?api-version=1.0"
}
]
}
{
"extractors": [
{
"id": "invoices",
"name": "Invoices",
"documentTypeId": "invoices",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction/start?api-version=1.0"
},
{
"id": "acord140",
"name": "ACORD 140",
"documentTypeId": "acord140",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction/start?api-version=1.0"
},
{
"id": "vehicle_titles",
"name": "Vehicle Titles",
"documentTypeId": "vehicle_titles",
"status": "Available",
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction/start?api-version=1.0"
}
]
}
Récupère tous les classifieurs d'un projet.
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbG***UZik5-CinKm6A'
curl -X 'GET' \
'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer eyJhbG***UZik5-CinKm6A'
Fournit des informations sur les classifieurs disponibles pour le projet mentionné.
{
"classifiers": [
{
"id": "ml-classification",
"name": "ML Classification (Preview)",
"status": "Available",
"documentTypeIds": [
"1040",
"4506t",
"990",
"acord125",
"acord126",
"acord131",
"acord140",
"acord25",
"bank_statements",
"bills_of_lading",
"checks",
"financial_statements",
"fm1003",
"i9",
"id_cards",
"invoices",
"packing_lists",
"passports",
"purchase_orders",
"receipts",
"remittance_advices",
"utility_bills",
"vehicle_titles",
"w2",
"w9"
],
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification/start?api-version=1.0"
}
]
}
{
"classifiers": [
{
"id": "ml-classification",
"name": "ML Classification (Preview)",
"status": "Available",
"documentTypeIds": [
"1040",
"4506t",
"990",
"acord125",
"acord126",
"acord131",
"acord140",
"acord25",
"bank_statements",
"bills_of_lading",
"checks",
"financial_statements",
"fm1003",
"i9",
"id_cards",
"invoices",
"packing_lists",
"passports",
"purchase_orders",
"receipts",
"remittance_advices",
"utility_bills",
"vehicle_titles",
"w2",
"w9"
],
"detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification?api-version=1.0",
"syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification?api-version=1.0",
"asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification/start?api-version=1.0"
}
]
}
- Obtenir les informations du projet
- Réponse lors de la récupération des informations du projet
- Commencer à récupérer les informations des extracteurs
- Réponse de la récupération des informations des extracteurs
- Obtenir les informations des classifieurs
- Réponse lors de l'obtention des informations des classifieurs