Utilizar las API de detección

Realiza una solicitud GET a la ruta del proyecto (no se requiere ID) mediante el servicio de detección para recuperar información sobre el proyecto recién creado. La URL necesita la ruta org / tenant y / du_ / dpi / framework / project. Una vez que recibes la respuesta, cada dos llamadas siguientes requieren cierta información (projectID, classifierID, extractionID, etc.) que está disponible en las respuestas de las llamadas de Discovery.

Obtener la información del proyecto

Recupera todos los proyectos disponibles de Document Understanding^TM.

curl -X 'GET' \
  'https://cloud.uipath.com/uipathstgss/UiPathDefault/du_/api/framework/projects?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs***Q'

Respuesta de recuperar la información del proyecto

Proporciona detalles sobre el proyecto predefinido utilizado.

{
  "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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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"
    },
    
  ]
}

Iniciar la recuperación de información de los extractores

Recuperar todos los extractores de un proyecto.

curl -X 'GET' \
  'https://cloud.uipath.com/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'

Respuesta de recuperar información de los extractores

Proporciona información sobre los extractores disponibles para el proyecto mencionado.

Este ejemplo se ha recortado para facilitar la lectura.

{
  "extractors": [
     {
      "id": "generative_extractor",
      "name": "Generative Extractor",
      "documentTypeId": "",
      "status": "Available",
      "detailsUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/generative_extractor?api-version=1.0",
      "syncUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/generative_extractor/extraction?api-version=1.0",
      "asyncUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/generative_extractor/extraction/start?api-version=1.0"
    },
    {
      "id": "invoices",
      "name": "Invoices",
      "documentTypeId": "invoices",
      "status": "Available",
      "detailsUrl": "https://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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"
    }
  ]
}

Obtener información de los clasificadores

Recuperar todos los clasificadores de un proyecto.

curl -X 'GET' \
  'https://cloud.uipath.com/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'

Respuesta de obtener la información de los clasificadores

Proporciona información sobre los clasificadores disponibles para el proyecto mencionado.

{
  "classifiers": [
     {
      "id": "generative_classifier",
      "name": "Generative Classifier",
      "status": "Available",
      "documentTypeIds": [],
      "detailsUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/generative_classifier?api-version=1.0",
      "syncUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/generative_classifier/classification?api-version=1.0",
      "asyncUrl": "https://cloud.uipath.com:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/generative_classifier/classification/start?api-version=1.0"
    },
    {
      "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://cloud.uipath.com: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://cloud.uipath.com: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://cloud.uipath.com: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"
    }
  ]
}