Zuva DocAI
Incorporer contrats IA dans vos flux de travail de produit à l’aide de Zuva DocAI. Il n’est pas nécessaire de développer l’IA à partir de la base, de tirer parti des API DocAI pour extraire des informations de vos contrats.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Zuva Support |
| URL | https://zuva.ai/support/ |
| Messagerie électronique | support@zuva.ai |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Zuva Inc. |
| Site internet | https://zuva.ai/ |
| Politique de confidentialité | https://zuva.ai/privacy/ |
| Catégories | AI |
Ce connecteur permet aux utilisateurs de rechercher et d’extraire des entités, des phrases et des paragraphes à partir de contrats (et de documents connexes), en tirant parti de l’ia de contrats de classe de Zuva. Conçu et formé pour identifier les clauses juridiques dans plusieurs secteurs d’activité et cas d’usage, ce connecteur fournit une suite plug-and-play de modules pour incorporer Contracts AI dans vos workflows. Ce connecteur est fourni avec OCR pour lire vos documents, ainsi que les fonctionnalités de classification et de normalisation des documents.
Prerequisites
Vous aurez besoin d’un compte Zuva et d’un jeton DocAI. Commencez par vous inscrire à un compte gratuit.
Comment obtenir des informations d’identification
Zuva DocAI a plusieurs serveurs régionaux. Vous devez créer un jeton d’API pour la région spécifique que vous souhaitez utiliser.
- Créez et/ou connectez-vous à votre compte à zuva.ai.
- Accédez à la console DocAI
- Sélectionnez la région que vous souhaitez utiliser.
- Copiez l’URL de base de la région vers votre connexion.
- Créez un jeton et copiez-le pour l’utiliser dans votre connexion.
Consultez le guide de démarrage rapide DocAI pour plus d’informations sur les comptes et jetons Zuva.
Bien démarrer avec votre connecteur
Pour utiliser le connecteur Zuva DocAI, vous devez définir un flux similaire à ce qui suit :
Étape 1 : Obtenir un fichier
À des fins de test, vous pouvez créer un « flux cloud instantané » dans Power Automate. Choisissez « Déclencher manuellement un flux » et créez le flux. Ajoutez une entrée, puis choisissez le type « Fichier ».
Étape 2 : Envoyer un fichier
Ajoutez l’action Submit a file , puis choisissez « Contenu du fichier » à l’étape précédente en tant qu’entrée.
Remarque : le fichier ne doit pas être transformé d’une manière quelconque (c’est-à-dire sans encodage base64). DocAI accepte uniquement les données binaires brutes.
Étape 3 : Démarrer le traitement du fichier
Choisissez le service que vous souhaitez utiliser en ajoutant l’une des actions suivantes :
Create Language Classification RequestCreate Document Classification RequestCreate Multi-Level Classification RequestCreate Field Extraction RequestCreate OCR Request
Chacun d’eux accepte l’ID de fichier (retourné à partir de l’action Submit a file ) comme entrée.
L’extraction de champs nécessite également des ID de champ en tant qu’entrées. Les ID de champ sont disponibles dans la bibliothèque de champs (connexion requise), à partir d’un formateur IA si vous avez formé des champs personnalisés ou par programmation à l’aide de l’action Get Field List .
Étape 4 : Interroger l’achèvement de la demande
Utilisez un Do Until bloc (trouvé dans la section « Contrôle ») et ajoutez l’action de vérification d’état correcte à l’intérieur du bloc :
Get Field Extraction Request StatusGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Request Status
L’action Get ____ status prend comme entrée l’ID de requête de son action correspondante Create ____ Request .
Vous devez également ajouter un bloc de 10 secondes Delay à l’intérieur du Do until bloc pour vous assurer que le fichier a suffisamment de temps à traiter.
Définissez la condition pour que le Do Until bloc Is Finished? soit égal à true.
Étape 4 : Obtenir les résultats
Enfin, utilisez l’une des actions Obtenir les résultats correspondant à votre demande, à l’aide de l’ID de requête de l’opération De création d’origine comme entrée :
Get Field Extraction Request Text ResultsGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Results TextGet OCR Results Images
Notez que pour la langue, la classification des documents et le MLC, les résultats sont inclus dans la réponse État.
Vous pouvez consulter la documentation DocAI pour plus d’informations sur la structure des résultats d’extraction de champs.
Problèmes connus et limitations
Champs par requête
Un maximum de 100 champs peut être inclus dans une seule Create Field Extraction Request action.
Champs personnalisés
Le connecteur ne prend pas en charge les points de terminaison de DocAI liés à l’apprentissage de champs personnalisés ou à l’obtention des métadonnées d’un champ individuel.
Différences avec l’API sous-jacente
En outre, notez que la fonctionnalité de connecteur ne correspond pas à un avec la documentation de l’API sous-jacente. En particulier, le connecteur :
- Expose une valeur booléenne supplémentaire
is_finished, qui peut être utilisée pour indiquer si la requête est terminée ou a échoué - Toutes les requêtes fonctionnent sur des fichiers uniques, plutôt que sur des lots de plusieurs fichiers.
Erreurs courantes et solutions
Veillez à charger des chaînes binaires brutes plutôt que des chaînes encodées en base64. Vous pouvez utiliser le service OCR et vérifier qu’il retourne le texte attendu.
Questions fréquentes (FAQ)
Où puis-je trouver des informations supplémentaires sur Zuva DocAI ?
Où puis-je trouver de la documentation supplémentaire sur Zuva DocAI ?
https://zuva.ai/documentation/
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Jeton | securestring | Votre jeton DocAI | Vrai |
| URL de base | ficelle | Exemple : https://us.app.zuva.ai/api/v2 | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer une demande de classification de documents |
Créez une demande de classification du document spécifié. |
| Créer une demande de classification linguistique |
Créez une demande pour la langue du fichier spécifié. |
| Créer une demande de classification à plusieurs niveaux |
Créez une demande de classification à plusieurs niveaux du fichier spécifié. |
| Créer une demande d’extraction de champ |
Créez une demande d’extractions à partir du fichier spécifié. |
| Créer une requête OCR |
Créez une demande d’OCR à appliquer au fichier spécifié. |
| Envoyer un fichier |
Envoyez un fichier à Zuva DocAI. |
| Normaliser les dates |
Normaliser une chaîne contenant une ou plusieurs dates. Pour chaque date trouvée, le point de terminaison retourne un ensemble d’entiers représentant l’année, le mois et le jour. |
| Obtenir des images de requête OCR |
Obtenez les images à partir d’une requête OCR terminée. |
| Obtenir la liste des champs |
Obtenez la liste de tous les champs disponibles. |
| Obtenir le texte de la requête OCR |
Obtenez le texte à partir d’une requête OCR terminée. |
| Obtenir les résultats de la demande d’extraction de champ |
Obtenez des résultats de texte à partir d’une demande d’extraction de champ terminée. |
| Obtenir l’état de la demande de classification de document |
Obtenez l’état et les résultats disponibles pour une demande de classification de documents existante. |
| Obtenir l’état de la demande de classification linguistique |
Obtenez l’état et les résultats disponibles pour une demande de classification de documents existante. |
| Obtenir l’état de la demande d’extraction de champ |
Vérifiez l’état d’une demande d’extraction de champ existante. |
| Obtenir l’état de la demande OCR |
Vérifiez l’état d’une requête OCR existante. |
| Obtenir l’état de la requête MLC |
Obtenez l’état et les résultats disponibles pour une requête MLC existante. |
| Supprimer un fichier |
Supprimez un fichier existant de Zuva. |
Créer une demande de classification de documents
Créez une demande de classification du document spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | string |
Identificateur unique du fichier, tel qu’il est retourné par l’opération SubmitFile. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de demande de classification
|
request_id | string |
ID à utiliser pour obtenir l’état et les résultats de cette demande. |
Créer une demande de classification linguistique
Créez une demande pour la langue du fichier spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | string |
Identificateur unique du fichier, tel qu’il est retourné par l’opération SubmitFile. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de demande de langue
|
request_id | string |
ID à utiliser pour obtenir l’état et les résultats de cette demande. |
Créer une demande de classification à plusieurs niveaux
Créez une demande de classification à plusieurs niveaux du fichier spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | string |
Identificateur unique du fichier, tel qu’il est retourné par l’opération SubmitFile. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de requête MLC
|
request_id | string |
ID à utiliser pour obtenir l’état et les résultats de cette demande. |
Créer une demande d’extraction de champ
Créez une demande d’extractions à partir du fichier spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | string |
Fichier à partir duquel extraire du texte. |
|
|
ID de champ
|
field_ids | array of string |
ID des champs à extraire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de demande d’extraction
|
request_id | string |
ID à utiliser pour obtenir l’état et les résultats de cette demande. |
Créer une requête OCR
Créez une demande d’OCR à appliquer au fichier spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | string |
Identificateur unique du fichier, tel qu’il est retourné par l’opération SubmitFile. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de demande OCR
|
request_id | string |
ID utilisé pour obtenir l’état et les résultats de la requête OCR. |
Envoyer un fichier
Envoyez un fichier à Zuva DocAI.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Fichier
|
File | binary |
Contenu de fichier binaire ou chaîne de texte brut à charger. Le contenu binaire ne doit PAS être encodé en Base64. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de fichier
|
file_id | string |
Identificateur unique attribué par Zuva pour le fichier. |
|
Type de contenu
|
attributes.content-type | string |
Type de contenu MIME détecté du fichier |
|
Expiration
|
expiration | string |
Heure à laquelle le fichier est planifié pour être supprimé de DocAI. |
Normaliser les dates
Normaliser une chaîne contenant une ou plusieurs dates. Pour chaque date trouvée, le point de terminaison retourne un ensemble d’entiers représentant l’année, le mois et le jour.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
Chaîne de texte à normaliser. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Demande d'ID
|
request_id | string |
ID de la demande |
|
texte
|
text | string |
Texte d’origine fourni. |
|
sha-256
|
sha-256 | string |
Hachage SHA-256 du texte d’origine. |
|
date
|
date | array of object |
date |
|
Day
|
date.day | integer |
Jour du mois sous forme d’entier. |
|
Mois
|
date.month | integer |
Le mois représenté sous la forme d’un entier compris entre 1 et 12. |
|
Année
|
date.year | integer |
Année représentée sous forme d’entier. |
Obtenir des images de requête OCR
Obtenez les images à partir d’une requête OCR terminée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande OCR
|
request_id | True | string |
Identificateur unique d’une requête OCR existante, tel qu’il est retourné par CreateOcrRequest. |
Retours
Fichier zip contenant chaque page du document sous forme d’image.
- Images
- binary
Obtenir la liste des champs
Obtenez la liste de tous les champs disponibles.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID de champ
|
field_id | string |
Identificateur unique du champ. |
|
Nom
|
name | string |
Nom du champ |
|
Descriptif
|
description | string |
Description du champ. |
|
Biais
|
bias | double |
Biais utilisé par le modèle ML sous-jacent. |
|
F-score
|
f_score | double |
Score F du champ, mesure statistique de sa précision. |
|
Précision
|
precision | double |
Précision du champ. |
|
Rappeler
|
recall | double |
Rappel du champ. |
|
Nombre de documents
|
document_count | integer |
Le nombre de documents sur utilisant le champ a été formé. |
|
Est-ce personnalisé ?
|
is_custom | boolean |
Boolean indiquant si le champ est personnalisé. |
|
Est-ce que l’apprentissage est effectué ?
|
is_trained | boolean |
Boolean indiquant si un champ personnalisé a été entraîné. |
Obtenir le texte de la requête OCR
Obtenez le texte à partir d’une requête OCR terminée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande OCR
|
request_id | True | string |
Identificateur unique d’une requête OCR existante, tel qu’il est retourné par CreateOcrRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Texto
|
text | string |
Texte OCR du document. |
Obtenir les résultats de la demande d’extraction de champ
Obtenez des résultats de texte à partir d’une demande d’extraction de champ terminée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande d’extraction
|
request_id | True | string |
Identificateur unique d’une requête d’extraction existante, tel qu’il est retourné par CreateExtractionRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object |
Tableau des résultats de l’extraction de champ. |
|
ID de champ
|
results.field_id | string |
Identificateur unique du champ extrait. |
|
Extractions
|
results.extractions | array of object |
Tableau de résultats extraits pour ce champ particulier. |
|
Texto
|
results.extractions.text | string |
Texte extrait pour le champ. |
|
Étendues
|
results.extractions.spans | array of object |
Informations sur l’emplacement du texte dans le document. |
|
Démarrer
|
results.extractions.spans.start | integer |
Index du premier caractère de l’extraction dans le texte du document. |
|
Fin
|
results.extractions.spans.end | integer |
Index du dernier caractère de l’extraction dans le texte du document. |
|
Démarrer
|
results.extractions.spans.pages.start | integer |
Numéro de page sur lequel l’extraction démarre. |
|
Fin
|
results.extractions.spans.pages.end | integer |
Numéro de page sur lequel l’extraction se termine. |
Obtenir l’état de la demande de classification de document
Obtenez l’état et les résultats disponibles pour une demande de classification de documents existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
request_id | True | string |
ID de demande de la demande de classification de document, tel qu’il est retourné par CreateDocumentClasssificationRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État de la demande de classification
|
status | string |
État de la requête (l’un des « mis en file d’attente », « traitement », « terminé » ou « échec »). |
|
Est-ce terminé ?
|
is_finished | boolean |
Boolean indiquant si la requête a atteint un état terminal (terminé ou échoué). |
|
Classification
|
classification | string |
Type de document détecté. |
|
Le contrat est-il ?
|
is_contract | boolean |
Indique si le document a été reconnu comme un contrat ou non. |
Obtenir l’état de la demande de classification linguistique
Obtenez l’état et les résultats disponibles pour une demande de classification de documents existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
request_id | True | string |
ID de requête de la demande de classification de langue, tel qu’il est retourné par CreateLanguageRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État de la demande de langue
|
status | string |
État de la requête (l’un des « mis en file d’attente », « traitement », « terminé » ou « échec »). |
|
Est-ce terminé ?
|
is_finished | boolean |
Boolean indiquant si la requête a atteint un état terminal (terminé ou échoué). |
|
Language
|
language | string |
Langue principale détectée du document. |
Obtenir l’état de la demande d’extraction de champ
Vérifiez l’état d’une demande d’extraction de champ existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande d’extraction
|
request_id | True | string |
Identificateur unique d’une requête d’extraction existante, tel qu’il est retourné par CreateExtractionRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État de la demande d’extraction de champ
|
status | string |
État de la requête (l’un des « mis en file d’attente », « traitement », « terminé » ou « échec »). |
|
Est-ce terminé ?
|
is_finished | boolean |
Boolean indiquant si la requête a atteint un état terminal (terminé ou échoué). |
Obtenir l’état de la demande OCR
Vérifiez l’état d’une requête OCR existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de demande OCR
|
request_id | True | string |
Identificateur unique d’une requête OCR existante, tel qu’il est retourné par CreateOcrRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État de la demande OCR
|
status | string |
État de la requête (l’un des « mis en file d’attente », « traitement », « terminé » ou « échec »). |
|
Est-ce terminé ?
|
is_finished | boolean |
Boolean indiquant si la requête a atteint un état terminal (terminé ou échoué). |
Obtenir l’état de la requête MLC
Obtenez l’état et les résultats disponibles pour une requête MLC existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
request_id | True | string |
ID de requête de la requête MLC, tel qu’il est retourné par CreateMlcRequest. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État de la demande MLC
|
status | string |
État de la requête (l’un des « mis en file d’attente », « traitement », « terminé » ou « échec »). |
|
Est-ce terminé ?
|
is_finished | boolean |
Boolean indiquant si la requête a atteint un état terminal (terminé ou échoué). |
|
Classifications
|
classifications | array of string |
Classifications hiérarchiques du document. |
Supprimer un fichier
Supprimez un fichier existant de Zuva.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
file_id | True | string |
ID du fichier à supprimer. |
Retours
- response
- string
Définitions
ficelle
Il s’agit du type de données de base « string ».
binaire
Il s’agit du type de données de base "binaire".