Zuva DocAI
Inserte contracts AI en los flujos de trabajo del producto mediante Zuva DocAI. Sin necesidad de desarrollo de inteligencia artificial desde cero, aproveche las API de DocAI para extraer información de los contratos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Zuva |
| URL | https://zuva.ai/support/ |
| Correo Electrónico | support@zuva.ai |
| Metadatos del conector | |
|---|---|
| Publicador | Zuva Inc. |
| Sitio web | https://zuva.ai/ |
| Directiva de privacidad | https://zuva.ai/privacy/ |
| Categorías | AI |
Este conector permite a los usuarios buscar y extraer entidades, oraciones y párrafos de contratos (y documentos relacionados), aprovechando la inteligencia artificial de contratos de zuva de la mejor clase. Diseñado y entrenado para identificar cláusulas legales en varios sectores y casos de uso, este conector proporciona un conjunto de módulos plug-and-play para insertar la inteligencia artificial de contratos en los flujos de trabajo. Este conector incluye OCR para leer los documentos, así como funcionalidades de clasificación y normalización de documentos.
Prerrequisitos
Necesitará una cuenta de Zuva y un token de DocAI. Para empezar, regístrese para obtener una cuenta gratuita.
Obtención de credenciales
Zuva DocAI tiene varios servidores regionales. Deberá crear un token de API para la región específica que quiera usar.
- Cree o inicie sesión en su cuenta en zuva.ai.
- Vaya a la consola de DocAI.
- Seleccione la región que desea usar.
- Copie la dirección URL base de la región a la conexión.
- Cree un token y cópielo para usarlo en la conexión.
Consulte la guía de inicio rápido de DocAI para obtener más información sobre las cuentas y tokens de Zuva.
Introducción al conector
Para usar el conector de Zuva DocAI, deberá establecer un flujo similar al siguiente:
Paso 1: Obtener un archivo
Con fines de prueba, puede crear un "flujo de nube instantánea" en Power Automate. Elija "Desencadenar manualmente un flujo" y cree el flujo. Agregue una entrada y elija el tipo "Archivo".
Paso 2: Enviar un archivo
Agregue la Submit a file acción y elija el "Contenido del archivo" del paso anterior como entrada.
Nota: El archivo no se debe transformar de ninguna manera (es decir, sin codificación base64). DocAI solo acepta datos binarios sin procesar.
Paso 3: Iniciar el procesamiento del archivo
Elija el servicio que desea usar agregando una de las siguientes acciones:
Create Language Classification RequestCreate Document Classification RequestCreate Multi-Level Classification RequestCreate Field Extraction RequestCreate OCR Request
Cada uno de estos acepta el identificador de archivo (devuelto de la Submit a file acción) como entrada.
Además, la extracción de campos requiere identificadores de campo como entradas. Los identificadores de campo se pueden encontrar en la biblioteca de campos (se requiere inicio de sesión), desde el instructor de IA si ha entrenado campos personalizados o mediante programación mediante la Get Field List acción.
Paso 4: Sondear para completar la solicitud
Use un Do Until bloque (que se encuentra en la sección "Control" ) y agregue la acción de comprobación de estado correcta al interior del bloque:
Get Field Extraction Request StatusGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Request Status
La Get ____ status acción toma como entrada el identificador de solicitud de su acción correspondiente Create ____ Request .
También debe agregar un bloque de 10 segundos Delay dentro del Do until bloque para asegurarse de que el archivo tiene tiempo suficiente para procesar.
Establezca la condición para que el Do Until bloque Is Finished? sea igual a true.
Paso 4: Obtener resultados
Por último, use una de las acciones Obtener resultados correspondientes a la solicitud mediante el identificador de solicitud de la operación Create original como entrada:
Get Field Extraction Request Text ResultsGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Results TextGet OCR Results Images
Tenga en cuenta que para Language, Document Classification y MLC, los resultados se incluyen en la respuesta Status.
Es posible que desee consultar la documentación de DocAI para obtener más información sobre la estructura de los resultados de extracción de campos.
Problemas y limitaciones conocidos
Campos por solicitud
Un máximo de 100 campos se puede incluir en una sola Create Field Extraction Request acción.
Campos personalizados
El conector no admite ninguno de los puntos de conexión de DocAI relacionados con el entrenamiento de campos personalizados ni la obtención de metadatos de un campo individual.
Diferencias con la API subyacente
Además, tenga en cuenta que la funcionalidad del conector no corresponde uno a uno con la documentación de la API subyacente. En concreto, el conector:
- Expone un booleano adicional
is_finished, que se puede usar para indicar si la solicitud está completa o no. - Todas las solicitudes funcionan en archivos únicos, en lugar de lotes de varios archivos.
Errores y soluciones comunes
Asegúrese de cargar cadenas codificadas en base64 sin formato. Puede usar el servicio OCR y comprobar que devuelve el texto esperado.
Preguntas más frecuentes
¿Dónde puedo encontrar información adicional sobre Zuva DocAI?
¿Dónde puedo encontrar documentación adicional sobre Zuva DocAI?
https://zuva.ai/documentation/
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Token | securestring | El token de DocAI | Cierto |
| Dirección URL base | cuerda / cadena | p ej. https://us.app.zuva.ai/api/v2 | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Creación de una solicitud de clasificación de varios niveles |
Cree una solicitud para la clasificación de varios niveles del archivo especificado. |
| Creación de una solicitud de OCR |
Cree una nueva solicitud para que OCR se aplique al archivo especificado. |
| Crear solicitud de clasificación de documentos |
Cree una solicitud para la clasificación del documento especificado. |
| Crear solicitud de clasificación de idioma |
Cree una solicitud para el idioma del archivo especificado. |
| Crear solicitud de extracción de campos |
Cree una nueva solicitud de extracciones del archivo especificado. |
| Eliminar un archivo |
Elimine un archivo existente de Zuva. |
| Enviar un archivo |
Envíe un archivo a Zuva DocAI. |
| Normalizar fechas |
Normalice una cadena que contenga una o varias fechas. Para cada fecha encontrada, el punto de conexión devuelve un conjunto de enteros que representan el año, el mes y el día. |
| Obtención del estado de la solicitud de MLC |
Obtenga el estado y los resultados disponibles para una solicitud de MLC existente. |
| Obtención del estado de la solicitud de OCR |
Compruebe el estado de una solicitud de OCR existente. |
| Obtener el estado de la solicitud de clasificación de documentos |
Obtenga el estado y los resultados disponibles para una solicitud de clasificación de documentos existente. |
| Obtener el estado de la solicitud de clasificación de idioma |
Obtenga el estado y los resultados disponibles para una solicitud de clasificación de documentos existente. |
| Obtener el estado de la solicitud de extracción de campos |
Compruebe el estado de una solicitud de extracción de campos existente. |
| Obtener imágenes de solicitud de OCR |
Obtenga las imágenes de una solicitud de OCR completada. |
| Obtener lista de campos |
Obtenga una lista de todos los campos disponibles. |
| Obtener los resultados de la solicitud de extracción de campos |
Obtiene los resultados de texto de una solicitud de extracción de campos completada. |
| Obtener texto de solicitud de OCR |
Obtenga el texto de una solicitud de OCR completada. |
Creación de una solicitud de clasificación de varios niveles
Cree una solicitud para la clasificación de varios niveles del archivo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Identificador único del archivo, tal como lo devuelve la operación SubmitFile. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud de MLC
|
request_id | string |
Identificador que se va a usar para obtener el estado y los resultados de esta solicitud. |
Creación de una solicitud de OCR
Cree una nueva solicitud para que OCR se aplique al archivo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Identificador único del archivo, tal como lo devuelve la operación SubmitFile. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud de OCR
|
request_id | string |
Identificador usado para obtener el estado y los resultados de la solicitud OCR. |
Crear solicitud de clasificación de documentos
Cree una solicitud para la clasificación del documento especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Identificador único del archivo, tal como lo devuelve la operación SubmitFile. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud de clasificación
|
request_id | string |
Identificador que se va a usar para obtener el estado y los resultados de esta solicitud. |
Crear solicitud de clasificación de idioma
Cree una solicitud para el idioma del archivo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Identificador único del archivo, tal como lo devuelve la operación SubmitFile. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de solicitud de idioma
|
request_id | string |
Identificador que se va a usar para obtener el estado y los resultados de esta solicitud. |
Crear solicitud de extracción de campos
Cree una nueva solicitud de extracciones del archivo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Archivo del que se va a extraer texto. |
|
|
Identificadores de campo
|
field_ids | array of string |
Identificadores de los campos que se van a extraer. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de solicitud de extracción
|
request_id | string |
Identificador que se va a usar para obtener el estado y los resultados de esta solicitud. |
Eliminar un archivo
Elimine un archivo existente de Zuva.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de archivo
|
file_id | True | string |
Identificador del archivo que se va a eliminar. |
Devoluciones
- response
- string
Enviar un archivo
Envíe un archivo a Zuva DocAI.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivo
|
File | binary |
Contenido de archivo binario o cadena de texto sin formato que se va a cargar. El contenido binario NO debe estar codificado en Base64. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de archivo
|
file_id | string |
Identificador único asignado a Zuva para el archivo. |
|
Tipo de contenido
|
attributes.content-type | string |
Tipo de contenido MIME detectado del archivo |
|
Expiration
|
expiration | string |
Hora en la que se programa la eliminación del archivo de DocAI. |
Normalizar fechas
Normalice una cadena que contenga una o varias fechas. Para cada fecha encontrada, el punto de conexión devuelve un conjunto de enteros que representan el año, el mes y el día.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Mensaje de texto
|
text | string |
Cadena de texto que se va a normalizar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud
|
request_id | string |
Identificador de la solicitud |
|
texto
|
text | string |
Texto original que se proporcionó. |
|
sha-256
|
sha-256 | string |
Hash SHA-256 del texto original. |
|
date
|
date | array of object |
date |
|
Day
|
date.day | integer |
El día del mes como un entero. |
|
Mes
|
date.month | integer |
El mes representado como un entero entre 1 y 12. |
|
Año
|
date.year | integer |
El año representado como un entero. |
Obtención del estado de la solicitud de MLC
Obtenga el estado y los resultados disponibles para una solicitud de MLC existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
request_id | True | string |
Id. de solicitud de la solicitud de MLC, tal y como devuelve CreateMlcRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Estado de la solicitud de MLC
|
status | string |
Estado de la solicitud (uno de 'queued', 'processing', 'complete' o 'failed'). |
|
¿Está terminado?
|
is_finished | boolean |
Boolean que indica si la solicitud ha alcanzado un estado terminal (completado o erróneo). |
|
Classifications
|
classifications | array of string |
Clasificaciones jerárquicas del documento. |
Obtención del estado de la solicitud de OCR
Compruebe el estado de una solicitud de OCR existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de OCR
|
request_id | True | string |
Identificador único de una solicitud de OCR existente, tal y como devuelve CreateOcrRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Estado de la solicitud de OCR
|
status | string |
Estado de la solicitud (uno de 'queued', 'processing', 'complete' o 'failed'). |
|
¿Está terminado?
|
is_finished | boolean |
Boolean que indica si la solicitud ha alcanzado un estado terminal (completado o erróneo). |
Obtener el estado de la solicitud de clasificación de documentos
Obtenga el estado y los resultados disponibles para una solicitud de clasificación de documentos existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
request_id | True | string |
Id. de solicitud de la solicitud de clasificación de documentos, tal y como devuelve CreateDocumentClasssificationRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Estado de la solicitud de clasificación
|
status | string |
Estado de la solicitud (uno de 'queued', 'processing', 'complete' o 'failed'). |
|
¿Está terminado?
|
is_finished | boolean |
Boolean que indica si la solicitud ha alcanzado un estado terminal (completado o erróneo). |
|
Classification
|
classification | string |
Tipo de documento que se detectó. |
|
¿Tiene contrato?
|
is_contract | boolean |
Si el documento se reconoció como un contrato o no. |
Obtener el estado de la solicitud de clasificación de idioma
Obtenga el estado y los resultados disponibles para una solicitud de clasificación de documentos existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
request_id | True | string |
Id. de solicitud de la solicitud de clasificación de idioma, tal y como devuelve CreateLanguageRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Estado de solicitud de idioma
|
status | string |
Estado de la solicitud (uno de 'queued', 'processing', 'complete' o 'failed'). |
|
¿Está terminado?
|
is_finished | boolean |
Boolean que indica si la solicitud ha alcanzado un estado terminal (completado o erróneo). |
|
Language
|
language | string |
Idioma detectado principal del documento. |
Obtener el estado de la solicitud de extracción de campos
Compruebe el estado de una solicitud de extracción de campos existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de extracción
|
request_id | True | string |
Identificador único de una solicitud de extracción existente, tal y como devuelve CreateExtractionRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Estado de la solicitud de extracción de campos
|
status | string |
Estado de la solicitud (uno de 'queued', 'processing', 'complete' o 'failed'). |
|
¿Está terminado?
|
is_finished | boolean |
Boolean que indica si la solicitud ha alcanzado un estado terminal (completado o erróneo). |
Obtener imágenes de solicitud de OCR
Obtenga las imágenes de una solicitud de OCR completada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de OCR
|
request_id | True | string |
Identificador único de una solicitud de OCR existente, tal y como devuelve CreateOcrRequest. |
Devoluciones
Un archivo ZIP que contiene cada página del documento como una imagen.
- Imágenes
- binary
Obtener lista de campos
Obtenga una lista de todos los campos disponibles.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id. de campo
|
field_id | string |
Identificador único del campo. |
|
Nombre
|
name | string |
Nombre del campo |
|
Description
|
description | string |
Descripción del campo. |
|
Sesgo
|
bias | double |
Sesgo utilizado por el modelo de ML subyacente. |
|
Puntuación F
|
f_score | double |
Puntuación F del campo, una medida estadística de su precisión. |
|
Precisión
|
precision | double |
Precisión del campo. |
|
Recuerdos
|
recall | double |
La recuperación del campo. |
|
Recuento de documentos
|
document_count | integer |
Número de documentos en los que se ha entrenado el campo. |
|
¿Es personalizado?
|
is_custom | boolean |
Boolean que indica si el campo es personalizado. |
|
¿Está entrenado?
|
is_trained | boolean |
Boolean que indica si se ha entrenado un campo personalizado. |
Obtener los resultados de la solicitud de extracción de campos
Obtiene los resultados de texto de una solicitud de extracción de campos completada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de extracción
|
request_id | True | string |
Identificador único de una solicitud de extracción existente, tal y como devuelve CreateExtractionRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object |
Matriz de los resultados de la extracción de campos. |
|
Id. de campo
|
results.field_id | string |
Identificador único del campo extraído. |
|
Extracciones
|
results.extractions | array of object |
Matriz de resultados extraídos para este campo determinado. |
|
Mensaje de texto
|
results.extractions.text | string |
Texto que se extrajo para el campo. |
|
Intervalos
|
results.extractions.spans | array of object |
Información sobre la ubicación del texto dentro del documento. |
|
Comenzar
|
results.extractions.spans.start | integer |
Índice del primer carácter de la extracción dentro del texto del documento. |
|
Fin
|
results.extractions.spans.end | integer |
Índice del último carácter de la extracción dentro del texto del documento. |
|
Comenzar
|
results.extractions.spans.pages.start | integer |
Número de página en el que se inicia la extracción. |
|
Fin
|
results.extractions.spans.pages.end | integer |
Número de página en el que finaliza la extracción. |
Obtener texto de solicitud de OCR
Obtenga el texto de una solicitud de OCR completada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de OCR
|
request_id | True | string |
Identificador único de una solicitud de OCR existente, tal y como devuelve CreateOcrRequest. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Mensaje de texto
|
text | string |
Texto OCR del documento. |
Definiciones
cuerda / cadena
Este es el tipo de datos básico "string".
binary
Este es el tipo de datos básico "binary".