Azure AI Document Intelligence (module de reconnaissance de formulaire)
Extrait du texte (OCR imprimé et manuscrit) et des informations supplémentaires (tables, cases à cocher, paires champs/paires valeur clé) à partir de fichiers PDF, d’images ou de documents et de formulaires Microsoft Office dans des données structurées basées sur des modèles préentraînés (disposition, facture, reçu, ID, carte de visite) ou modèle personnalisé créé par un ensemble de formulaires de formation représentatifs à l’aide de la compréhension des documents optimisés par l’IA.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Us Department of Defense (DoD) |
| Power Apps | - | Non disponible |
| Power Automate | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Microsoft |
| URL | https://aka.ms/formrecognizer |
| Messagerie électronique | formrecog_contact@microsoft.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
| Site internet | https://aka.ms/formrecognizer |
| Politique de confidentialité | https://aka.ms/form-recognizer/privacy |
| Catégories | IA; Informatique décisionnelle |
Le connecteur Azure AI Document Intelligence (anciennement Form Recognizer) fournit une intégration à Azure AI Document Intelligence. Il permet d’analyser et d’extraire des informations à partir de formulaires, de factures, de reçus, de cartes de visite, de documents d’IDENTIFICATION et de plusieurs autres types de documents.
Prerequisites
Pour utiliser cette intégration, vous aurez besoin d’une ressource Azure AI Document Intelligence dans le portail Azure. Créer un lien de ressource. Vous obtiendrez un point de terminaison et une clé pour l’authentification de vos applications. Pour établir une connexion, indiquez la clé de compte, l’URL du site et sélectionnez Créer une connexion. Pour connaître les coûts d’opération sur votre connexion, découvrez-en plus ici.
Comment obtenir des informations d’identification
- Ouvrez la ressource Document Intelligence dans le portail Azure (consultez Conditions préalables).
- Sélectionner des clés et un point de terminaison sous Gestion des ressources
- Copiez le point de terminaison et la clé et utilisez-les pour créer une connexion.
Prise en main de votre connecteur
La façon la plus simple d’essayer le connecteur Document Intelligence consiste à utiliser tous les modèles prédéfinis (prédéfini-invoice, prédéfini-layout, etc.). Fournissez un fichier PDF ou une image de votre document. Analysez l’utilisation d’une opération de connecteur en fonction de votre type de document et inspectez les champs détectés. Liste complète des modèles et fonctionnalités prises en charge ici.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Clé API | Fournissez le nom de la ressource Intellignce document et la clé API. | Toutes les régions | Partageable |
| Identités managées par applications logiques | Créer une connexion à l’aide d’une identité managée LogicApps | LOGICAPPS uniquement | Partageable |
| Microsoft Entra ID Intégré | Utiliser l’ID Microsoft Entra pour accéder à | Toutes les régions | Non partageable |
| Valeur par défaut [DÉCONSEILLÉE] | Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante. | Toutes les régions | Non partageable |
Clé d’API
ID d’authentification : keyBasedAuth
Applicable : Toutes les régions
Fournissez le nom de la ressource Intellignce document et la clé API.
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé de compte | securestring | Clé de compte Document Intelligence | Vrai |
| URL du point de terminaison | ficelle | URL du point de terminaison Document Intelligence (exemple : https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Vrai |
Identité managée Logic Apps
ID d’authentification : managedIdentityAuth
Applicable : LOGICAPPS uniquement
Créer une connexion à l’aide d’une identité managée LogicApps
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Identité managée LogicApps | managedIdentity | Se connecter avec une identité managée Logic Apps | Vrai |
| URL du point de terminaison | ficelle | URL du point de terminaison Document Intelligence (exemple : https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Vrai |
Microsoft Entra ID Intégré
ID d’authentification : oauth
Applicable : Toutes les régions
Utiliser l’ID Microsoft Entra pour accéder à
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 |
|---|---|---|---|
| URL du point de terminaison | ficelle | URL du point de terminaison Document Intelligence (exemple : https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Vrai |
Valeur par défaut [DÉCONSEILLÉE]
Applicable : Toutes les régions
Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante.
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 |
|---|---|---|---|
| Clé de compte | securestring | Clé de compte Document Intelligence | Vrai |
| URL du point de terminaison | ficelle | URL du point de terminaison Document Intelligence (exemple : https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 1200 | 60 secondes |
Actions
| Analyser la carte de visite (déconseillée) [DÉPRÉCIÉE] |
Extrayez du texte de champ et des valeurs sémantiques à partir d’un document de carte de visite donné (déconseillé). |
| Analyser la disposition (déconseillée) [DÉPRÉCIÉE] |
Extrayez des informations de texte et de disposition à partir d’un document donné (déconseillé). |
| Analyser la facture (déconseillée) [DÉCONSEILLÉE] |
Extrayez le texte du champ et les valeurs sémantiques d’un document de facture donné (déconseillé). |
| Analyser le document d’ID (déconseillé) [DÉPRÉCIÉ] |
Extrayez du texte de champ et des valeurs sémantiques à partir d’un document d’ID donné (déconseillé). |
| Analyser le document pour les modèles prédéfinis ou personnalisés (API v3.x) |
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (API v3.x). |
| Analyser le document pour les modèles prédéfinis ou personnalisés (API v4.x) |
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (API v4.x). |
| Analyser le reçu (déconseillé) [DÉCONSEILLÉ] |
Extrayez le texte du champ et les valeurs sémantiques d’un document de reçu donné (déconseillé). |
| Analyser un formulaire personnalisé (déconseillé) [DÉPRÉCIÉ] |
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (déconseillé). |
| Classifier le document avec le classifieur de document (API v3.1) |
Classifiez le document avec le classifieur de document (API v3.1). |
| Classifier un document avec un classifieur de document (API v4.x) |
Classifiez le document avec le classifieur de document (API v4.x). |
Analyser la carte de visite (déconseillée) [DÉPRÉCIÉE]
Extrayez du texte de champ et des valeurs sémantiques à partir d’un document de carte de visite donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Inclure les détails du texte
|
includeTextDetails | boolean |
Incluez des lignes de texte et des références d’élément dans le résultat. Valeur par défaut : True (juste pour le connecteur FR). |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux de la facture. Les paramètres régionaux pris en charge sont les suivants : en-US. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
Analyser la disposition (déconseillée) [DÉPRÉCIÉE]
Extrayez des informations de texte et de disposition à partir d’un document donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Language
|
language | string |
Code de langue BCP-47 du texte du document. |
|
|
Ordre de lecture
|
readingOrder | string |
Paramètre facultatif pour spécifier l’algorithme d’ordre de lecture à appliquer lors de l’ordre des éléments de texte d’extraction. Peut être « de base » ou « naturel ». La valeur par défaut est de base si elle n’est pas spécifiée. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
Analyser la facture (déconseillée) [DÉCONSEILLÉE]
Extrayez le texte du champ et les valeurs sémantiques d’un document de facture donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Inclure les détails du texte
|
includeTextDetails | boolean |
Incluez des lignes de texte et des références d’élément dans le résultat. Valeur par défaut : True (juste pour le connecteur FR). |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux de la facture. Les paramètres régionaux pris en charge sont les suivants : en-US. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
Analyser le document d’ID (déconseillé) [DÉPRÉCIÉ]
Extrayez du texte de champ et des valeurs sémantiques à partir d’un document d’ID donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Inclure les détails du texte
|
includeTextDetails | boolean |
Incluez des lignes de texte et des références d’élément dans le résultat. Valeur par défaut : True (juste pour le connecteur FR). |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
- Corps
- IdAnalyzeOperationResult
Analyser le document pour les modèles prédéfinis ou personnalisés (API v3.x)
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (API v3.x).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Version de l’API Document Intelligence
|
api-version | True | string |
Version de l’API Document Intelligence. |
|
Identificateur de modèle
|
modelId | True | string |
Modèles prédéfinis : prédéfini-read, prebuilt-layout, prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us. Format modelId personnalisé - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nom de modèle unique. |
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Indicateur de paramètres régionaux pour la reconnaissance de texte et l’analyse de document. La valeur peut contenir uniquement le code de langue (par exemple, « en », « fr ») ou la balise de langue BCP 47 (par exemple, «en-US»). |
|
|
Type d’index de chaîne
|
stringIndexType | string |
Méthode utilisée pour calculer le décalage de chaîne et la longueur. Options prises en charge : textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Fonctionnalités facultatives et Premium
|
features | array |
Liste des fonctionnalités d’analyse facultatives (telles que ocrHighResolution, langues, codes-barres, formules, keyValuePairs et styleFont). |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf de document ou d’image (JPG, PNG, BMP, TIFF) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse.
Analyser le document pour les modèles prédéfinis ou personnalisés (API v4.x)
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (API v4.x).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Version de l’API Document Intelligence
|
api-version | True | string |
Version de l’API Document Intelligence. |
|
Identificateur de modèle
|
modelId | True | string |
ModelIds prédéfinis : prédéfini-read, prebuilt-layout, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us, prebuilt-tax.us.1098, prebuilt-tax.us.us.1098E, prebuilt-tax.us.1098T, prebuilt-contract, etc. Format modelId personnalisé - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nom de modèle unique. |
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf de document ou d’image (JPG, PNG, BMP, TIFF) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Indicateur de paramètres régionaux pour la reconnaissance de texte et l’analyse de document. La valeur peut contenir uniquement le code de langue (par exemple, « en », « fr ») ou la balise de langue BCP 47 (par exemple, «en-US»). |
|
|
Type d’index de chaîne
|
stringIndexType | string |
Méthode utilisée pour calculer le décalage de chaîne et la longueur. Options prises en charge : textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Fonctionnalités facultatives et Premium
|
features | array |
Liste des fonctionnalités d’analyse facultatives (telles que ocrHighResolution, langues, codes-barres, formules, keyValuePairs, styleFont et queryFields). |
|
|
Champs de requête
|
queryFields | array |
Liste des champs supplémentaires à extraire. Ex. « NumberOfGuests,StoreNumber » |
|
|
Format de contenu de sortie
|
outputContentFormat | string |
Format du contenu de niveau supérieur d’analyse du résultat. |
Retours
État et résultat de l’opération d’analyse.
Analyser le reçu (déconseillé) [DÉCONSEILLÉ]
Extrayez le texte du champ et les valeurs sémantiques d’un document de reçu donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Inclure les détails du texte
|
includeTextDetails | boolean |
Incluez des lignes de texte et des références d’élément dans le résultat. Valeur par défaut : True (juste pour le connecteur FR). |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux de la facture. Les paramètres régionaux pris en charge sont les suivants : en-US. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
Analyser un formulaire personnalisé (déconseillé) [DÉPRÉCIÉ]
Extrayez des paires clé-valeur, des tables et des valeurs sémantiques à partir d’un document donné (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de modèle
|
modelId | True | string |
Format - uuid. Identificateur de modèle. |
|
Inclure les détails du texte
|
includeTextDetails | boolean |
Incluez des lignes de texte et des références d’élément dans le résultat. Valeur par défaut : True (juste pour le connecteur FR). |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire les informations de facture à partir de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf ou image (JPG ou PNG) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse mise en file d’attente.
Classifier le document avec le classifieur de document (API v3.1)
Classifiez le document avec le classifieur de document (API v3.1).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de classifieur
|
classifierId | True | string |
Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nom de classifieur unique. |
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire des informations de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Indicateur de paramètres régionaux pour la reconnaissance de texte et l’analyse de document. La valeur peut contenir uniquement le code de langue (par exemple, « en », « fr ») ou la balise de langue BCP 47 (par exemple, «en-US»). |
|
|
Type d’index de chaîne
|
stringIndexType | string |
Méthode utilisée pour calculer le décalage de chaîne et la longueur. Options prises en charge : textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf de document ou d’image (JPG, PNG, BMP, TIFF) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
Retours
État et résultat de l’opération d’analyse.
Classifier un document avec un classifieur de document (API v4.x)
Classifiez le document avec le classifieur de document (API v4.x).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Version de l’API Document Intelligence
|
api-version | True | string |
Version de l’API Document Intelligence. |
|
Identificateur de classifieur
|
classifierId | True | string |
Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Nom de classifieur unique. |
|
Contenu du fichier document/image
|
inputFileContent | binary |
Fichier pdf de document ou d’image (JPG, PNG, BMP, TIFF) à analyser. |
|
|
Document/Image URL
|
inputFileUrl | string |
Chemin d’URL du fichier d’entrée. Alternative au contenu du fichier document/image. |
|
|
Mode fractionné
|
split | string |
Comportement de fractionnement de fichiers. |
|
|
Feuilles
|
pages | string |
Sélection de pages pour les documents PDF et TIFF à plusieurs pages, pour extraire des informations de pages individuelles et une plage de pages (par exemple, page 2 et pages 5-7) en entrant les numéros de page et les plages séparés par des virgules (par exemple, « 2, 5-7 »). S’il n’est pas défini, toutes les pages sont traitées. |
|
|
Paramètres régionaux
|
locale | string |
Indicateur de paramètres régionaux pour la reconnaissance de texte et l’analyse de document. La valeur peut contenir uniquement le code de langue (par exemple, « en », « fr ») ou la balise de langue BCP 47 (par exemple, «en-US»). |
|
|
Type d’index de chaîne
|
stringIndexType | string |
Méthode utilisée pour calculer le décalage de chaîne et la longueur. Options prises en charge : textElements, unicodeCodePoint, utf16CodeUnit. |
Retours
État et résultat de l’opération d’analyse.
Définitions
OperationStatus
LayoutAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Analyser le résultat de l’opération. |
InvoiceAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Analyser le résultat de l’opération. |
BusinessCardAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Analyser le résultat de l’opération. |
ReceiptAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Analyser le résultat de l’opération. |
IdAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Analyser le résultat de l’opération. |
CustomFormsAnalyzeOperationResult
État et résultat de l’opération d’analyse mise en file d’attente.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | OperationStatus |
État de l’opération mise en file d’attente. |
|
createdDateTime
|
createdDateTime | string |
Date et heure (UTC) que l’opération d’analyse a été envoyée. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Analyser le résultat de l’opération. |
FormOperationError
Erreur signalée pendant une opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Message
|
message | string |
Message d’erreur. |
LayoutAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
InvoiceAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Informations au niveau du document extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
BusinessCardAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Informations au niveau du document extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
ReceiptAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Informations au niveau du document extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
IdAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Informations au niveau du document extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
CustomFormsAnalyzeResult
Analyser le résultat de l’opération.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
version
|
version | string |
Version du schéma utilisée pour ce résultat. |
|
readResults
|
readResults | array of ReadResult |
Texte extrait de l’entrée. |
|
pageResults
|
pageResults | array of PageResult |
Informations au niveau de la page extraites de l’entrée. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Informations au niveau du document extraites de l’entrée. |
|
Erreurs
|
errors | array of FormOperationError |
Liste des erreurs signalées pendant l’opération d’analyse. |
ReadResult
Texte extrait d’une page dans le document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Numéro de page basé sur 1 dans le document d’entrée. |
|
angle
|
angle | float |
Orientation générale du texte dans le sens des aiguilles d’une montre, mesurée en degrés entre (-180, 180]. |
|
width
|
width | float |
Largeur de l’image/PDF en pixels/pouces, respectivement. |
|
height
|
height | float |
Hauteur de l’image/PDF en pixels/pouces, respectivement. |
|
unité
|
unit | string |
Unité utilisée par les propriétés width, height et boundingBox. Pour les images, l’unité est « pixel ». Pour pdf, l’unité est « pouce ». |
|
Lignes
|
lines | array of TextLine |
Lorsque includeTextDetails a la valeur true, une liste de lignes de texte reconnues. Le nombre maximal de lignes retournées est de 300 par page. Les lignes sont triées en haut en bas, de gauche à droite, bien que dans certains cas la proximité soit traitée avec une priorité plus élevée. Comme l’ordre de tri dépend du texte détecté, il peut changer entre les images et les mises à jour de version OCR. Par conséquent, la logique métier doit être basée sur l’emplacement de ligne réel au lieu de l’ordre. |
TextLine
Objet représentant une ligne de texte extraite.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
texte
|
text | string |
Contenu du texte de la ligne. |
|
boundingBox
|
boundingBox | BoundingBox |
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces. |
|
words
|
words | array of TextWord |
Liste des mots dans la ligne de texte. |
TextWord
Objet représentant un mot.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
texte
|
text | string |
Contenu texte du mot. |
|
boundingBox
|
boundingBox | BoundingBox |
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces. |
|
confiance
|
confidence | Confidence |
Valeur de confiance. |
BoundingBox
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
float |
PageResult
Informations extraites d’une seule page.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
page
|
page | integer |
Numéro de page. |
|
clusterId
|
clusterId | integer |
Identificateur de cluster. |
|
keyValuePairs
|
keyValuePairs | array of KeyValuePair |
Liste des paires clé-valeur extraites de la page. |
|
tables
|
tables | array of DataTable |
Liste des tables de données extraites de la page. |
KeyValuePair
Informations sur la paire clé-valeur extraite.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
label
|
label | string |
Étiquette définie par l’utilisateur pour l’entrée de paire clé/valeur. |
|
key
|
key | KeyValueElement |
Informations sur la clé ou la valeur extraite dans une paire clé-valeur. |
|
value
|
value | KeyValueElement |
Informations sur la clé ou la valeur extraite dans une paire clé-valeur. |
|
confiance
|
confidence | Confidence |
Valeur de confiance. |
KeyValueElement
Informations sur la clé ou la valeur extraite dans une paire clé-valeur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
texte
|
text | string |
Contenu texte de la clé ou de la valeur. |
|
boundingBox
|
boundingBox | BoundingBox |
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces. |
|
Éléments
|
elements | array of ElementReference |
Lorsque includeTextDetails a la valeur true, une liste de références aux éléments de texte constituant cette clé ou cette valeur. |
ElementReference
DataTable
Informations sur la table extraite contenue dans une page.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Lignes
|
rows | integer |
Nombre de lignes. |
|
columns
|
columns | integer |
Nombre de colonnes. |
|
Cellules
|
cells | array of DataTableCell |
Liste des cellules contenues dans le tableau. |
DataTableCell
Informations sur la cellule extraite dans un tableau.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Index de ligne de la cellule. |
|
columnIndex
|
columnIndex | integer |
Index de colonne de la cellule. |
|
rowSpan
|
rowSpan | integer |
Nombre de lignes délimitées par cette cellule. |
|
columnSpan
|
columnSpan | integer |
Nombre de colonnes délimitées par cette cellule. |
|
texte
|
text | string |
Contenu texte de la cellule. |
|
boundingBox
|
boundingBox | BoundingBox |
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces. |
|
Éléments
|
elements | array of ElementReference |
Lorsque includeTextDetails a la valeur true, une liste de références aux éléments de texte constituant cette cellule de tableau. |
|
isHeader
|
isHeader | boolean |
Retourne si la cellule active est une cellule d’en-tête. |
|
isFooter
|
isFooter | boolean |
Retourne si la cellule active est une cellule de pied de page. |
InvoiceDocumentResult
Ensemble de champs extraits correspondant au document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Type de document. |
|
pageRange
|
pageRange | array of integer |
Numéro de première et dernière page où se trouve le document. |
|
fields
|
fields | InvoiceFields |
Champs de facture pour la version 2.1. |
BusinessCardDocumentResult
Ensemble de champs extraits correspondant au document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Type de document. |
|
pageRange
|
pageRange | array of integer |
Numéro de première et dernière page où se trouve le document. |
|
fields
|
fields | BusinessCardFields |
Champs Carte de visite pour la version 2.1. |
CustomFormsDocumentResult
Ensemble de champs extraits correspondant au document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Type de document. |
|
pageRange
|
pageRange | array of integer |
Numéro de première et dernière page où se trouve le document. |
|
Fields
|
_fields | array of CustomFormsFields |
Tableau de champs avec des propriétés fieldName et fieldValue. |
ReceiptDocumentResult
Ensemble de champs extraits correspondant au document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Type de document. |
|
pageRange
|
pageRange | array of integer |
Numéro de première et dernière page où se trouve le document. |
|
fields
|
fields | ReceiptFields |
Champs de réception pour la version 2.1. |
IdDocumentResult
Ensemble de champs extraits correspondant au document d’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | string |
Type de document. |
|
pageRange
|
pageRange | array of integer |
Numéro de première et dernière page où se trouve le document. |
|
fields
|
fields | IdFields |
Champs de document d’ID pour la version 2.1. |
CustomFormsFields
Champs de formulaire personnalisés.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du champ
|
fieldName | string | |
|
Valeur de champ
|
fieldValue | FieldValue |
Objet valeur de champ prédit. |
InvoiceFields
Champs de facture pour la version 2.1.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Montant dû (texte)
|
AmountDue.text | string |
Retourne le montant dû tel qu’écrit sur la facture. |
|
Montant dû (nombre)
|
AmountDue.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du montant dû
|
AmountDue.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse de facturation
|
BillingAddress.text | string | |
|
Confiance de l’adresse de facturation
|
BillingAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse de facturation
|
BillingAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse de facturation
|
BillingAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse du client
|
CustomerAddress.text | string | |
|
Confiance de l’adresse du client
|
CustomerAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse du client
|
CustomerAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse du client
|
CustomerAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
ID de client
|
CustomerId.text | string | |
|
Confiance de l’ID client
|
CustomerId.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nom du client
|
CustomerName.text | string | |
|
Confiance du nom du client
|
CustomerName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date d’échéance (texte)
|
DueDate.text | string |
Retourne la date d’échéance telle qu’elle est écrite sur la facture. |
|
Date d’échéance (date)
|
DueDate.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date d’échéance
|
DueDate.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date de facture (texte)
|
InvoiceDate.text | string |
Retourne la date de facture telle qu’elle est écrite sur la facture. |
|
Date de facture (date)
|
InvoiceDate.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date de facture
|
InvoiceDate.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
ID facture
|
InvoiceId.text | string | |
|
Confiance de l’ID de facture
|
InvoiceId.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Total de la facture (texte)
|
InvoiceTotal.text | string |
Retourne le total de la facture tel qu’il est écrit sur la facture. |
|
Total de la facture (nombre)
|
InvoiceTotal.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du total de la facture
|
InvoiceTotal.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Solde non payé précédent (texte)
|
PreviousUnpaidBalance.text | string |
Retourne le solde impayé précédent tel qu’il est écrit sur la facture. |
|
Solde non payé précédent (nombre)
|
PreviousUnpaidBalance.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du solde impayé précédent
|
PreviousUnpaidBalance.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Bon de commande
|
PurchaseOrder.text | string | |
|
Confiance de la commande d’achat
|
PurchaseOrder.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse de transfert
|
RemittanceAddress.text | string | |
|
Confiance de l’adresse de transfert
|
RemittanceAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse de transfert
|
RemittanceAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse de transfert
|
RemittanceAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse du service
|
ServiceAddress.text | string | |
|
Confiance de l’adresse de service
|
ServiceAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse de service
|
ServiceAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse de service
|
ServiceAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date de fin du service (texte)
|
ServiceEndDate.text | string |
Retourne la date de fin du service telle qu’elle est écrite sur la facture. |
|
Date de fin du service (date)
|
ServiceEndDate.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date de fin du service
|
ServiceEndDate.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date de début du service (texte)
|
ServiceStartDate.text | string |
Retourne la date de début du service telle qu’elle est écrite sur la facture. |
|
Date de début du service (date)
|
ServiceStartDate.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date de début du service
|
ServiceStartDate.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse d’expédition
|
ShippingAddress.text | string | |
|
Confiance de l’adresse de livraison
|
ShippingAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse d’expédition
|
ShippingAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse d’expédition
|
ShippingAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Sous-total (texte)
|
SubTotal.text | string |
Retourne le sous-total tel qu’il est écrit sur la facture. |
|
Sous-total (nombre)
|
SubTotal.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du sous-total
|
SubTotal.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Taxe totale (texte)
|
TotalTax.text | string |
Retourne la taxe totale telle qu’elle est écrite sur la facture. |
|
Taxe totale (nombre)
|
TotalTax.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance de l’impôt total
|
TotalTax.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse du fournisseur
|
VendorAddress.text | string | |
|
Confiance de l’adresse du fournisseur
|
VendorAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Destinataire de l’adresse du fournisseur
|
VendorAddressRecipient.text | string | |
|
Confiance du destinataire de l’adresse du fournisseur
|
VendorAddressRecipient.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nom de fournisseur
|
VendorName.text | string | |
|
Confiance du nom du fournisseur
|
VendorName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Objets
|
Items.valueArray | array of object |
Tableau d’éléments de ligne |
|
Montant (texte)
|
Items.valueArray.valueObject.Amount.text | string |
Retourne le montant tel qu’il est écrit sur la facture. |
|
Montant (nombre)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance du montant
|
Items.valueArray.valueObject.Amount.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Descriptif
|
Items.valueArray.valueObject.Description.text | string | |
|
Confiance de la description
|
Items.valueArray.valueObject.Description.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Quantité (texte)
|
Items.valueArray.valueObject.Quantity.text | string |
Retourne la quantité telle qu’elle est écrite sur la facture. |
|
Quantité (nombre)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance de la quantité
|
Items.valueArray.valueObject.Quantity.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Prix unitaire (texte)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Retourne le prix unitaire tel qu’il est écrit sur la facture. |
|
Prix unitaire (nombre)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance du prix unitaire
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Code du produit
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Confiance du code de produit
|
Items.valueArray.valueObject.ProductCode.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Unité
|
Items.valueArray.valueObject.Unit.text | string | |
|
Confiance de l’unité
|
Items.valueArray.valueObject.Unit.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date (texte)
|
Items.valueArray.valueObject.Date.text | string |
Retourne la date écrite sur la facture. |
|
Date (date)
|
Items.valueArray.valueObject.Date.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date
|
Items.valueArray.valueObject.Date.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Taxe (texte)
|
Items.valueArray.valueObject.Tax.text | string |
Retourne la taxe telle qu’elle est écrite sur la facture. |
|
Taxe (numéro)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance en impôts
|
Items.valueArray.valueObject.Tax.confidence | float |
Confiance que le modèle est dans sa prédiction. |
BusinessCardFields
Champs Carte de visite pour la version 2.1.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Noms de contacts
|
ContactNames.valueArray | array of object |
Tableau de noms de contacts |
|
Prénom
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Confiance du prénom
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nom
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Confiance du nom
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Noms d’entreprise
|
CompanyNames.valueArray | array of object |
Tableau de noms d’entreprise |
|
Nom de la société
|
CompanyNames.valueArray.text | string | |
|
Confiance du nom de la société
|
CompanyNames.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Départements
|
Departments.valueArray | array of object |
Tableau de services |
|
Département
|
Departments.valueArray.text | string | |
|
Confiance du service
|
Departments.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Titres du travail
|
JobTitles.valueArray | array of object |
Tableau de titres de travail |
|
Fonction
|
JobTitles.valueArray.text | string | |
|
Confiance du titre du travail
|
JobTitles.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Courriels
|
Emails.valueArray | array of object |
Tableau d’e-mails |
|
Messagerie électronique
|
Emails.valueArray.text | string | |
|
Confiance de l’e-mail
|
Emails.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Sites Web
|
Websites.valueArray | array of object |
Tableau de sites web |
|
Site internet
|
Websites.valueArray.text | string | |
|
Confiance du site web
|
Websites.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Addresses
|
Addresses.valueArray | array of object |
Tableau d’adresses |
|
Adresse
|
Addresses.valueArray.text | string | |
|
Confiance de l’adresse
|
Addresses.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Téléphones mobiles
|
MobilePhones.valueArray | array of object |
Tableau de téléphones mobiles |
|
Téléphone portable
|
MobilePhones.valueArray.text | string | |
|
Confiance du téléphone mobile
|
MobilePhones.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Télécopies
|
Faxes.valueArray | array of object |
Tableau de télécopies |
|
Télécopie
|
Faxes.valueArray.text | string | |
|
Confiance en télécopie
|
Faxes.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Téléphones professionnels
|
WorkPhones.valueArray | array of object |
Tableau de téléphones professionnels |
|
Téléphone professionnel
|
WorkPhones.valueArray.text | string | |
|
Confiance en téléphone professionnel
|
WorkPhones.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Autres téléphones
|
OtherPhones.valueArray | array of object |
Tableau d’autres téléphones |
|
Autre téléphone
|
OtherPhones.valueArray.text | string | |
|
Confiance d’un autre téléphone
|
OtherPhones.valueArray.confidence | float |
Confiance que le modèle est dans sa prédiction. |
ReceiptFields
Champs de réception pour la version 2.1.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type de reçu
|
ReceiptType.text | string | |
|
Confiance du type de reçu
|
ReceiptType.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nom du marchand
|
MerchantName.text | string | |
|
Confiance du nom du marchand
|
MerchantName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Numéro de téléphone du marchand
|
MerchantPhoneNumber.text | string | |
|
Confiance du numéro de téléphone marchand
|
MerchantPhoneNumber.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse du marchand
|
MerchantAddress.text | string | |
|
Confiance de l’adresse du commerçant
|
MerchantAddress.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date de transaction (texte)
|
TransactionDate.text | string |
Retourne la date de transaction telle qu’elle est écrite sur la facture. |
|
Date de transaction (date)
|
TransactionDate.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date de transaction
|
TransactionDate.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Heure de transaction (texte)
|
TransactionTime.text | string |
Retourne l’heure de transaction telle qu’elle est écrite sur la facture. |
|
Heure de transaction (heure)
|
TransactionTime.valueDate | time |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance du temps de transaction
|
TransactionTime.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Total (texte)
|
Total.text | string |
Retourne le total tel qu’il est écrit sur la facture. |
|
Total (nombre)
|
Total.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du total
|
Total.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Sous-total (texte)
|
Subtotal.text | string |
Retourne le sous-total tel qu’il est écrit sur la facture. |
|
Sous-total (nombre)
|
Subtotal.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du sous-total
|
Subtotal.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Taxe (texte)
|
Tax.text | string |
Retourne la taxe telle qu’elle est écrite sur la facture. |
|
Taxe (numéro)
|
Tax.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance en impôts
|
Tax.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Conseil (texte)
|
Tip.text | string |
Retourne un pourboire tel qu’il est écrit sur la facture. |
|
Conseil (nombre)
|
Tip.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 1234.98. |
|
Confiance du conseil
|
Tip.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Objets
|
Items.valueArray | array of object |
Tableau d’éléments de ligne |
|
Nom
|
Items.valueArray.valueObject.Name.text | string | |
|
Confiance du nom
|
Items.valueArray.valueObject.Name.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Quantité (texte)
|
Items.valueArray.valueObject.Quantity.text | string |
Retourne la quantité telle qu’elle est écrite sur la facture. |
|
Quantité (nombre)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance de la quantité
|
Items.valueArray.valueObject.Quantity.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Prix (texte)
|
Items.valueArray.valueObject.Price.text | string |
Retourne le prix tel qu’il est écrit sur la facture. |
|
Prix (nombre)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance du prix
|
Items.valueArray.valueObject.Price.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Prix total (texte)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Retourne le prix total écrit sur la facture. |
|
Prix total (nombre)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Mise en forme sous forme de nombre. Exemple : 12. |
|
Confiance du prix total
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
Confiance que le modèle est dans sa prédiction. |
IdFields
Champs de document d’ID pour la version 2.1.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Région du pays
|
CountryRegion.valueCountryRegion | string | |
|
Confiance de la région du pays
|
CountryRegion.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date d’expiration
|
DateOfExpiration.text | string |
Retourne la date d’expiration telle qu’elle est écrite sur la facture. |
|
Date d’expiration (date)
|
DateOfExpiration.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date d’expiration
|
DateOfExpiration.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Date de naissance (texte)
|
DateOfBirth.text | string |
Retourne la date de naissance telle qu’elle est écrite sur la facture. |
|
Date de naissance (date)
|
DateOfBirth.valueDate | date |
Mise en forme sous forme de date. Exemple : 2019-05-31. |
|
Confiance de la date de naissance
|
DateOfBirth.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Numéro de document
|
DocumentNumber.text | string | |
|
Confiance du numéro de document
|
DocumentNumber.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Prénom
|
FirstName.text | string | |
|
Confiance du prénom
|
FirstName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nom
|
LastName.text | string | |
|
Confiance du nom
|
LastName.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Nationalité
|
Nationality.valueCountryRegion | string | |
|
Confiance en la nationalité
|
Nationality.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Sex
|
Sex.text | string | |
|
Confiance du sexe
|
Sex.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Zone lisible par l’ordinateur
|
MachineReadableZone.text | string | |
|
Confiance de la zone lisible par l’ordinateur
|
MachineReadableZone.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Type de document
|
DocumentType.text | string | |
|
Confiance du type de document
|
DocumentType.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Adresse
|
Address.text | string | |
|
Confiance de l’adresse
|
Address.confidence | float |
Confiance que le modèle est dans sa prédiction. |
|
Région
|
Region.text | string | |
|
Confiance de la région
|
Region.confidence | float |
Confiance que le modèle est dans sa prédiction. |
FieldValue
Objet valeur de champ prédit.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type
|
type | FieldValueType |
Type de données sémantiques de la valeur du champ. |
|
valueString
|
valueString | string |
Valeur de chaîne. |
|
valueDate
|
valueDate | date-time |
Valeur de date. |
|
valueTime
|
valueTime | date-time |
Valeur de temps. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valeur du numéro de téléphone. |
|
valueNumber
|
valueNumber | number |
Valeur à virgule flottante. |
|
valueInteger
|
valueInteger | integer |
Valeur entière. |
|
texte
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Rectangle englobant quadrangle, avec coordonnées spécifiées par rapport au haut à gauche de l’image d’origine. Les huit nombres représentent les quatre points, dans le sens des aiguilles d’une montre du coin supérieur gauche par rapport à l’orientation du texte. Pour l’image, les coordonnées (x, y) sont mesurées en pixels. Pour pdf, les coordonnées (x, y) sont mesurées en pouces. |
|
confiance
|
confidence | Confidence |
Valeur de confiance. |
|
Éléments
|
elements | array of ElementReference |
Lorsque includeTextDetails a la valeur true, une liste de références aux éléments de texte constituant ce champ. |
|
page
|
page | integer |
Numéro de page basé sur 1 dans le document d’entrée. |
FieldValueType
Type de données sémantiques de la valeur du champ.
Type de données sémantiques de la valeur du champ.
Confiance
ApiVersion_V30
AnalyzeResultOperation_V30
État et résultat de l’opération d’analyse.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | string |
État de l’opération. |
|
createdDateTime
|
createdDateTime | date-time |
Date et heure (UTC) de l’envoi de l’opération d’analyse. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Date et heure (UTC) de la dernière mise à jour de l’état. |
|
erreur
|
error | Error_V30 |
Informations d’erreur. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Résultat de l’analyse du document. |
AnalyzeResult_V30
Résultat de l’analyse du document.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
Version de l’API. |
|
modelId
|
modelId | ModelId_V30 |
Nom de modèle unique. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Méthode utilisée pour calculer le décalage de chaîne et la longueur. |
|
contenu
|
content | string |
Concaténer la représentation sous forme de chaîne de tous les éléments textuels et visuels dans l’ordre de lecture. |
|
contentFormat
|
contentFormat | ContentFormat_V40 |
Format du contenu dans le résultat analysé. |
|
Pages
|
pages | array of DocumentPage_V30 |
Pages analysées. |
|
Paragraphes
|
paragraphs | array of DocumentParagraph_V30 |
Paragraphes extraits. |
|
tables
|
tables | array of DocumentTable_V30 |
Tables extraites. |
|
Chiffres
|
figures | array of DocumentFigure_V40 |
Illustrations extraites. |
|
Sections
|
sections | array of DocumentSection_V40 |
Sections extraites. |
|
keyValuePairs
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Paires clé-valeur extraites. |
|
Entités
|
entities | array of DocumentEntity_V30 |
Entités extraites. |
|
Styles
|
styles | array of DocumentStyle_V30 |
Styles de police extraits. |
|
langues
|
languages | array of DocumentLanguage_V30 |
Langues détectées. |
|
documents
|
documents | array of Document_V30 |
Documents extraits. |
|
Avertissements
|
warnings | array of Warning_V40 |
Liste des avertissements rencontrés. |
DocumentPage_V30
Éléments de contenu et de disposition extraits d’une page de l’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
gentil
|
kind | string |
Type de page de document. |
|
pageNumber
|
pageNumber | integer |
Numéro de page basé sur 1 dans le document d’entrée. |
|
angle
|
angle | number |
Orientation générale du contenu dans le sens des aiguilles d’une montre, mesurée en degrés compris entre (-180, 180]. |
|
width
|
width | number |
Largeur de l’image/PDF en pixels/pouces, respectivement. |
|
height
|
height | number |
Hauteur de l’image/PDF en pixels/pouces, respectivement. |
|
unité
|
unit | string |
Unité utilisée par les propriétés de largeur, de hauteur et de polygone. Pour les images, l’unité est « pixel ». Pour pdf, l’unité est « pouce ». |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la page dans l’ordre de lecture concaténé contenu. |
|
words
|
words | array of DocumentWord_V30 |
Mots extraits de la page. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Marques de sélection extraites de la page. |
|
images
|
images | array of DocumentImage_V30 |
Images extraites de la page. |
|
Lignes
|
lines | array of DocumentLine_V30 |
Lignes extraites de la page, potentiellement contenant à la fois des éléments textuels et visuels. |
|
codes-barres
|
barcodes | array of DocumentBarcode_V31 |
Codes-barres extraits de la page. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Formules extraites de la page. |
DocumentWord_V30
Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées spatiales, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | string |
Contenu texte du mot. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
span
|
span | DocumentSpan_V30 |
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentSelectionMark_V30
Objet de marque de sélection représentant des cases à cocher, des cases d’option et d’autres éléments indiquant une sélection.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
état
|
state | DocumentSelectionMarkState_V30 |
État de la marque de sélection. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
span
|
span | DocumentSpan_V30 |
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentImage_V30
Objet image détecté dans la page.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
span
|
span | DocumentSpan_V30 |
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur. |
|
pageRef
|
pageRef | integer |
Index de base 0 du tableau de pages globales contenant le contenu de l’image. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
Objet représentant des styles de texte observés.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Couleur d’arrière-plan au format hexadécimal #rrggbb.. |
|
color
|
color | string |
Couleur de premier plan dans #rrggbb format hexadécimal. |
|
fontStyle
|
fontStyle | string |
Style de police. |
|
fontWeight
|
fontWeight | string |
Poids de police. |
|
isHandwritten
|
isHandwritten | boolean |
Contenu manuscrit. |
|
similarFontFamily
|
similarFontFamily | string |
Visuellement la police la plus similaire parmi l’ensemble de familles de polices prises en charge, avec des polices de secours suivantes convention CSS (ex. « Arial, sans-serif »). |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement des éléments de texte dans le contenu concaténé auquel le style s’applique. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentLanguage_V30
Objet représentant la langue détectée pour une étendue de texte donnée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
paramètres régionaux
|
locale | string |
Langue détectée. La valeur peut être un code de langue ISO 639-1 (par exemple, « en », « fr ») ou une balise de langue BCP 47 (par exemple, « zh-Hans »). |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement des éléments de texte dans le contenu concaténé auquel la langue s’applique. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentLine_V30
Un objet de ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | string |
Contenu concaténé des éléments contenus dans l’ordre de lecture. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la ligne dans l’ordre de lecture concaténé contenu. |
DocumentParagraph_V30
Objet de paragraphe constitué de lignes contiguës généralement avec un alignement et un espacement communs.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
role
|
role | string |
Rôle sémantique du paragraphe. |
|
contenu
|
content | string |
Contenu concaténé du paragraphe dans l’ordre de lecture. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant le paragraphe. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement du paragraphe dans l’ordre de lecture concaténé contenu. |
DocumentTable_V30
Objet table composé de cellules de tableau organisées dans une disposition rectangulaire.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Nombre de lignes dans la table. |
|
columnCount
|
columnCount | integer |
Nombre de colonnes dans la table. |
|
Cellules
|
cells | array of DocumentTableCell_V30 |
Cellules contenues dans le tableau. |
|
légende
|
caption | DocumentCaption_V30 |
Objet représentant l’emplacement et le contenu d’une légende de table. |
|
Notes
|
footnotes | array of DocumentFootnote_V30 |
Notes de bas de page associées au tableau. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant la table. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la table dans l’ordre de lecture concaténé contenu. |
DocumentTableCell_V30
Objet représentant l’emplacement et le contenu d’une cellule de tableau.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
gentil
|
kind | string |
Type de cellule de tableau. |
|
rowIndex
|
rowIndex | integer |
Index de ligne de la cellule. |
|
columnIndex
|
columnIndex | integer |
Index de colonne de la cellule. |
|
rowSpan
|
rowSpan | integer |
Nombre de lignes délimitées par cette cellule. |
|
columnSpan
|
columnSpan | integer |
Nombre de colonnes délimitées par cette cellule. |
|
contenu
|
content | string |
Contenu concaténé de la cellule de tableau dans l’ordre de lecture. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant la cellule du tableau. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la cellule de tableau dans l’ordre de lecture du contenu concaténé. |
DocumentCaption_V30
Objet représentant l’emplacement et le contenu d’une légende de table.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | string |
Contenu de légende de table. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant la légende du tableau. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la légende de la table dans l’ordre de lecture concaténé contenu. |
DocumentFootnote_V30
Objet représentant l’emplacement et le contenu d’une note de bas de page de table.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | string |
Contenu de la note de bas de page du tableau. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant la note de bas de page du tableau. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la note de bas de page du tableau dans l’ordre de lecture du contenu concaténé. |
DocumentKeyValuePair_V30
Objet représentant un champ de formulaire avec une étiquette de champ distincte (clé) et une valeur de champ (peut être vide).
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
key
|
key | DocumentKeyValueElement_V30 |
Objet représentant la clé ou la valeur de champ dans une paire clé-valeur. |
|
value
|
value | DocumentKeyValueElement_V30 |
Objet représentant la clé ou la valeur de champ dans une paire clé-valeur. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentKeyValueElement_V30
Objet représentant la clé ou la valeur de champ dans une paire clé-valeur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | string |
Contenu concaténé de l’élément clé-valeur dans l’ordre de lecture. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant l’élément clé-valeur. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de l’élément clé-valeur dans le contenu concaténé dans l’ordre de lecture. |
DocumentEntity_V30
Objet représentant différentes catégories d’entités.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
catégorie
|
category | string |
Type d’entité. |
|
sous-catégorie
|
subCategory | string |
Sous-type d’entité. |
|
contenu
|
content | string |
Contenu de l’entité. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant l’entité. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de l’entité dans l’ordre de lecture concaténé contenu. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
DocumentBarcode_V31
Objet de code-barres.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
|
gentil
|
kind | string |
Type de code-barres. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
span
|
span | DocumentSpan_V30 |
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur. |
|
value
|
value | string |
Valeur du code-barres |
DocumentFormula_V31
Objet de formule.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
|
gentil
|
kind | string |
Type de formule. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
|
span
|
span | DocumentSpan_V30 |
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur. |
|
value
|
value | string |
Expression LaTex décrivant la formule. |
DocumentFigure_V40
Objet représentant une figure dans le document.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant la figure. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la figure dans l’ordre de lecture concaténé contenu. |
|
Éléments
|
elements | array of DocumentElement_V40 |
Éléments enfants de la figure, à l’exclusion de toute légende ou note de bas de page. |
|
légende
|
caption | DocumentCaption_V30 |
Objet représentant l’emplacement et le contenu d’une légende de table. |
|
Notes
|
footnotes | array of DocumentFootnote_V30 |
Liste des notes de bas de page associées à la figure. |
|
pièce d'identité
|
id | string |
ID de la figure. |
DocumentSection_V40
Objet représentant une section dans le document.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement de la section dans l’ordre de lecture concaténé contenu. |
|
Éléments
|
elements | array of DocumentElement_V40 |
Éléments enfants de la section. |
DocumentElement_V40
Pointeur JSON référençant un élément du document, tel que paragraphe, table, section, etc.
Pointeur JSON référençant un élément du document, tel que paragraphe, table, section, etc.
Warning_V40
Objet d’erreur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code
|
code | string |
Un ensemble de codes d’avertissement définis par le serveur. |
|
Message
|
message | string |
Représentation lisible par l’homme de l’avertissement. |
|
target
|
target | string |
Cible de l’erreur. |
ContentFormat_V40
Document_V30
Objet décrivant l’emplacement et le contenu sémantique d’un document.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Nom du type de document. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant le document. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement du document dans l’ordre de lecture du contenu concaténé. |
|
fields
|
fields | object |
Dictionnaire de valeurs de champ nommées. |
|
Fields
|
_fields | array of DocumentFieldNameValue_V30 |
Tableau de champs avec des propriétés fieldName et fieldValue. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
BoundingPolygon_V30
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
number |
BoundingRegion_V30
Polygone englobant sur une page spécifique de l’entrée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
Numéro de page basé sur 1 contenant la région englobante. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Polygone englobant, avec coordonnées spécifiées par rapport au haut à gauche de la page. Les nombres représentent les valeurs x, y des sommets de polygone, dans le sens des aiguilles d’une montre de gauche (-180 degrés inclusifs) par rapport à l’orientation de l’élément. |
DocumentFieldType_V30
Type de données sémantiques de la valeur du champ.
Type de données sémantiques de la valeur du champ.
DocumentFieldNameValue_V30
Objet champ document avec nom de champ et sa valeur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du champ
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
Objet représentant le contenu et l’emplacement d’une valeur de champ. |
DocumentField_V30
Objet représentant le contenu et l’emplacement d’une valeur de champ.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type
|
type | DocumentFieldType_V30 |
Type de données sémantiques de la valeur du champ. |
|
valueString
|
valueString | string |
Valeur de chaîne. |
|
valueDate
|
valueDate | date |
Valeur de date au format AAAA -MM-DD (ISO 8601). |
|
valueTime
|
valueTime | time |
Valeur de temps au format hh :mm :ss (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Valeur du numéro de téléphone au format E.164 (ex. +19876543210). |
|
valueNumber
|
valueNumber | number |
Valeur à virgule flottante. |
|
valueInteger
|
valueInteger | integer |
Valeur entière. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
État de la marque de sélection. |
|
valueSignature
|
valueSignature | string |
Présence de signature. |
|
valueCountryRegion
|
valueCountryRegion | string |
Valeur de code pays de 3 lettres (ISO 3166-1 alpha-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Valeur du champ Monétaire. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Valeur du champ Adresse. |
|
valueBoolean
|
valueBoolean | boolean |
Valeur booléenne. |
|
contenu
|
content | string |
Contenu du champ. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Régions englobantes couvrant le champ. |
|
spans
|
spans | array of DocumentSpan_V30 |
Emplacement du champ dans l’ordre de lecture concaténé contenu. |
|
confiance
|
confidence | Confidence_V30 |
Confiance des prédictions. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Région contiguë de la propriété de contenu concaténée, spécifiée en tant que décalage et longueur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
offset
|
offset | integer |
Index de base zéro du contenu représenté par l’étendue. |
|
length
|
length | integer |
Nombre de caractères dans le contenu représenté par l’étendue. |
StringIndexType_V30
Méthode utilisée pour calculer le décalage de chaîne et la longueur.
Méthode utilisée pour calculer le décalage de chaîne et la longueur.
ModelId_V30
Error_V30
Informations d’erreur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code
|
code | string |
Code d’erreur. |
|
Message
|
message | string |
Message d’erreur. |
|
target
|
target | string |
Cible de l’erreur. |
|
details
|
details | array of InnerError_V30 |
Liste des erreurs détaillées. |
|
innererror
|
innererror | InnerError_V30 |
Erreur détaillée. |
InnerError_V30
Erreur détaillée.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code
|
code | string |
Code d’erreur. |
|
Message
|
message | string |
Message d’erreur. |
CurrencyValue_V30
Valeur du champ Monétaire.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
montant
|
amount | double |
Montant monétaire. |
|
code de devise
|
currencyCode | string |
Code monétaire résolu (ISO 4217), le cas échéant. |
|
currencySymbol
|
currencySymbol | string |
Étiquette de symbole monétaire, le cas échéant. |
AddressValue_V30
Valeur du champ Adresse.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
Numéro de maison ou de bâtiment. |
|
poBox
|
poBox | string |
Numéro de la boîte de poste. |
|
route
|
road | string |
Nom de rue. |
|
city
|
city | string |
Nom de la ville, de la ville, du village, etc. |
|
état
|
state | string |
Division administrative de premier niveau. |
|
postalCode
|
postalCode | string |
Code postal utilisé pour le tri de courrier. |
|
countryRegion
|
countryRegion | string |
Pays ou région. |
|
adresse de rue
|
streetAddress | string |
Adresse au niveau de la rue, à l’exclusion de la ville, de l’état, du countryRegion et du code postal. |
|
cityDistrict
|
cityDistrict | string |
Districts ou arrondissements d’une ville, comme Brooklyn à New York ou Ville de Westminster à Londres. |
|
maison
|
house | string |
Nom de build, tel que World Trade Center. |
|
niveau
|
level | string |
Numéro de sol, tel que 3F. |
|
stateDistrict
|
stateDistrict | string |
Division administrative de deuxième niveau utilisée dans certains paramètres régionaux. |
|
banlieue
|
suburb | string |
Nom de quartier non officiel, comme Chinatown. |
|
unité
|
unit | string |
Appartement ou numéro de bureau. |