Procesamiento de documentos con llamadas a la API separadas

Un escenario típico para procesar documentos mediante llamadas a la API separadas (para crear una transacción, cargar un archivo e iniciar una transacción) consta de los siguientes pasos:

Recibir una lista de todas las skills disponibles
Crear una transacción vacía
Agregar un conjunto de archivos que se procesarán en la transacción
Iniciar la transacción
Supervisar el estado de la transacción
Descargar archivos de origen y archivos de resultados

Cada solicitud al servidor debe incluir información de autenticación (como un token de acceso). Para obtener más información, consulte Authentication.

Obtener una lista de todas las skills disponibles

Para ello, envía una solicitud GET al recurso skills: Ejecute el siguiente comando: La respuesta contendrá un archivo JSON similar al siguiente:

[
   {
      "id": "Receipt",
      "name": "Receipt",
      "type": "Document"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "NewClassifier",
      "type": "Classification"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "Invoice",
      "type": "Document"
   }
]

Defina el identificador de la skill que va a utilizar. Puede encontrar descripciones detalladas de las skills en las skills integradas.

Creación de una transacción vacía

Para ello, envíe la siguiente solicitud POST al recurso transactions: Ejecute el siguiente comando: Una vez creada correctamente la transacción vacía, recibirá una respuesta con el identificador de la transacción:

{
   "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Añadir un conjunto de archivos para procesar en la transacción

El número máximo de archivos en una transacción es de 1000.

Un conjunto de archivos se puede añadir de dos maneras:

Directamente a la transacción
A un documento, y luego añadir este documento a la transacción

Añadir archivos directamente a la transacción

Para ello, envíe una solicitud POST al recurso transactions/<transaction-id>/files: Ejecute el siguiente comando: Como resultado, recibirá una respuesta con una lista de los archivos añadidos y sus identificadores. Puede añadir tantos archivos como necesite repitiendo esta llamada varias veces. Opciones adicionales para la carga de archivos:

Agregar archivos a un documento

Primero, cree un documento enviando una solicitud POST al recurso transactions/<transaction-id>/documents: Como resultado, recibirá una respuesta con el identificador del documento. Luego, agregue archivos al documento enviando una solicitud POST al recurso transactions/<transaction-id>/documents/<document-id>/sourceFiles:

Iniciar la transacción

Para iniciar la transacción con la skill y los archivos especificados, envíe la siguiente solicitud POST al recurso transactions/<transaction-id>/start:

Supervisar el estado de la transacción

Para empezar a supervisar el estado de la transacción mediante un bucle con un breve tiempo de espera (no recomendamos comprobar el estado con más frecuencia que una vez por segundo), envíe una solicitud GET al recurso transactions/<transaction_id> con el identificador de la transacción en el URI de la solicitud: La respuesta tendrá un aspecto similar al siguiente:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

En la respuesta:

Si el valor de la clave status se establece en:
- New — la transacción se ha creado, pero no está actualmente en curso.
- Processing — la transacción se ha iniciado, pero los resultados aún no están listos.
- Processed — la transacción se ha completado correctamente y podrá descargar los resultados.
- Failed — la transacción ha fallado.
- Canceled — la transacción se canceló.
La clave manualReviewLink contendrá un enlace a la interfaz web del cliente de revisión manual y un token de acceso de Vantage, si se requiere revisión manual. Este enlace y este token pueden utilizarse para revisar y corregir los resultados de la clasificación y la extracción de campos de una transacción concreta. Hasta que se complete la revisión, el valor de la clave status se establecerá en Processing. El enlace proporcionado es válido durante 168 horas, transcurridas las cuales debe crearse y obtenerse un nuevo enlace para otro período de 168 horas utilizando el mismo método. Consulte más información en Integrating manual review.

Los usuarios autorizados mediante este enlace no pueden ver ni modificar ningún otro documento o transacción.

Para un Skill de documento, la respuesta tendrá ahora un aspecto similar al siguiente:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "resultFiles": [
            {
               "fileId": "3a3e6245-48e1-489a-9fef-a10b5ba28515",
               "type": "Json"
            }
         ],
         "businessRulesErrors": []
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

En el array documents, cada documento tiene un array resultFiles. Use este array para obtener los valores de fileId. El formato de los archivos de salida lo define la skill que utiliza. Actualmente, todas las skills devuelven los campos extraídos en formato JSON. Para una Skill de clasificación, la respuesta que se recibe después de que se hayan procesado los documentos tendrá un aspecto similar al siguiente:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "classification": {
            "isResultClassConfident": true,
            "resultClass": "Invoice",
            "classConfidences": [
               {
                  "class": "Invoice",
                  "confidence": 89
               },
               {
                  "class": "PurchaseOrder",
                  "confidence": 32
               }
            ]
         }
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

Extraiga la clase del documento de la clave resultClass y compruebe el nivel de confianza de cada posible clase en las claves confidence. Para una Habilidad de proceso, la respuesta puede contener toda o parte de la información que se devuelve para las habilidades de documento y de clasificación, según las etapas disponibles en la Habilidad de proceso.

Descarga de archivos de origen y de resultados

Una vez finalizado el procesamiento, puede descargar dos tipos de archivos:

Archivos de origen — los archivos originales que cargó, devueltos en su formato binario original.
Archivos de resultados — la salida del procesamiento: los datos extraídos, en formato JSON de forma predeterminada (el formato de salida lo establece la skill).

Los archivos de origen y los archivos de resultados usan endpoints e identificadores de archivo diferentes:

Archivo de origen — GET transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download. El ID del archivo proviene de la respuesta de GET transactions/<transaction-id>/documents (sourceFiles[].id).
Archivo de resultados — GET transactions/<transaction-id>/files/<file-id>/download. El ID del archivo proviene del array resultFiles en la respuesta de estado de la transacción (documents[].resultFiles[].fileId).

Para obtener una lista de documentos con sus identificadores, envíe una solicitud GET al recurso transactions/<transaction-id>/documents y especifique el identificador de la transacción: Como resultado, recibirá una lista de todos los documentos creados dentro de esta transacción. La respuesta también incluye los identificadores de estos documentos, que pueden ser necesarios para solicitar información detallada sobre documentos específicos.

Archivos de origen

Para descargar un archivo de origen que necesite, envíe una solicitud GET al recurso transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download y especifique los identificadores de la transacción, el documento y el archivo (de la última respuesta): Ejecute el siguiente comando: La respuesta contendrá el archivo en formato binario. Repita este paso para todos sus archivos de origen.

Archivos de resultados

Para descargar un archivo de resultados, envíe una solicitud GET al recurso transactions/<transaction-id>/files/<file-id>/download y especifique el identificador de la transacción y el fileId del archivo de resultados. Obtenga el fileId del array resultFiles devuelto al consultar el estado de la transacción (cada entrada tiene un fileId y un type, como Json): Ejecute el siguiente comando:

​Obtener una lista de todas las skills disponibles

​Creación de una transacción vacía

​Añadir un conjunto de archivos para procesar en la transacción

​Añadir archivos directamente a la transacción

​Agregar archivos a un documento

​Iniciar la transacción

​Supervisar el estado de la transacción

​Descarga de archivos de origen y de resultados

​Archivos de origen

​Archivos de resultados

Obtener una lista de todas las skills disponibles

Creación de una transacción vacía

Añadir un conjunto de archivos para procesar en la transacción

Añadir archivos directamente a la transacción

Agregar archivos a un documento

Iniciar la transacción

Supervisar el estado de la transacción

Descarga de archivos de origen y de resultados

Archivos de origen

Archivos de resultados