Document Models - Compose Model
Crée un modèle de document à partir de types de documents de modèles de documents existants.
POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-11-30
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
Point de terminaison du service Document Intelligence. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
classifierId | True |
string |
Classifieur personnalisé pour fractionner et classifier le fichier d’entrée. |
docTypes | True |
<string,
Document |
Mappage de dictionnaire pris en charge docTypes sur les modèles de document correspondants. |
modelId | True |
string |
Nom unique du modèle de document. |
description |
string |
Description du modèle de document. |
|
split |
Comportement de fractionnement de fichiers. |
||
tags |
object |
Liste des attributs de balise clé-valeur associés au modèle de document. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes
|
|
Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
Ocp-Apim-Subscription-Key
Type:
apiKey
Dans:
header
OAuth2Auth
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton:
https://login.microsoftonline.com/common/oauth2/token
Étendues
Nom | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemples
Compose Document Model
Exemple de requête
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30
{
"modelId": "composedModel",
"description": "Composed model description",
"classifierId": "customClassifier",
"docTypes": {
"formA": {
"modelId": "model1"
},
"formB": {
"modelId": "model2"
}
}
}
Exemple de réponse
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30
Définitions
Nom | Description |
---|---|
Compose |
Corps de la demande pour créer un modèle de document composé à partir de modèles de documents de composant. |
Document |
Fonctionnalités d’analyse de document à activer. |
Document |
Mode de génération de modèle de document personnalisé. |
Document |
Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON. |
Document |
Type de données sémantiques de la valeur du champ. |
Document |
Objet d’erreur. |
Document |
Objet de réponse d’erreur. |
Document |
Objet contenant des informations plus spécifiques sur l’erreur. |
Document |
Informations sur le type de document. |
Split |
Comportement de fractionnement de fichiers. |
ComposeDocumentModelRequest
Corps de la demande pour créer un modèle de document composé à partir de modèles de documents de composant.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
classifierId |
string |
Classifieur personnalisé pour fractionner et classifier le fichier d’entrée. |
|
description |
string |
Description du modèle de document. |
|
docTypes |
<string,
Document |
Mappage de dictionnaire pris en charge docTypes sur les modèles de document correspondants. |
|
modelId |
string |
Nom unique du modèle de document. |
|
split | none |
Comportement de fractionnement de fichiers. |
|
tags |
object |
Liste des attributs de balise clé-valeur associés au modèle de document. |
DocumentAnalysisFeature
Fonctionnalités d’analyse de document à activer.
Nom | Type | Description |
---|---|---|
barcodes |
string |
Activez la détection des codes-barres dans le document. |
formulas |
string |
Activez la détection d’expressions mathématiques dans le document. |
keyValuePairs |
string |
Activez la détection des paires de valeurs de clé générale (champs de formulaire) dans le document. |
languages |
string |
Activez la détection de la langue du contenu texte. |
ocrHighResolution |
string |
Effectuez l’OCR à une résolution plus élevée pour gérer les documents avec une impression fine. |
queryFields |
string |
Activez l’extraction de champs supplémentaires via le paramètre de requête queryFields. |
styleFont |
string |
Activez la reconnaissance de différents styles de police. |
DocumentBuildMode
Mode de génération de modèle de document personnalisé.
Nom | Type | Description |
---|---|---|
neural |
string |
Prise en charge des documents avec différents modèles visuels. |
template |
string |
Cibler des documents avec des modèles visuels similaires. |
DocumentFieldSchema
Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON.
Nom | Type | Description |
---|---|---|
description |
string |
Description du champ. |
example |
string |
Exemple de contenu de champ. |
items |
Schéma de type de champ de chaque élément de tableau. |
|
properties |
<string,
Document |
Sous-champs nommés du champ objet. |
type |
Type de données sémantiques de la valeur du champ. |
DocumentFieldType
Type de données sémantiques de la valeur du champ.
Nom | Type | Description |
---|---|---|
address |
string |
Adresse analysée. |
array |
string |
Liste des sous-champs du même type. |
boolean |
string |
Valeur booléenne, normalisée en true ou false. |
countryRegion |
string |
Pays/région, normalisé au format ISO 3166-1 alpha-3 (par exemple aux États-Unis). |
currency |
string |
Montant monétaire avec symbole et unité monétaire facultatifs. |
date |
string |
Date, normalisée au format ISO 8601 (AAAA-MM-DD). |
integer |
string |
Nombre entier, normalisé en entier signé 64 bits. |
number |
string |
Nombre à virgule flottante, normalisé à double précision à virgule flottante. |
object |
string |
Liste nommée des sous-champs de types potentiellement différents. |
phoneNumber |
string |
Numéro de téléphone, normalisé au format E.164 (+{CountryCode}{SubscriberNumber}). |
selectionGroup |
string |
Tableau de valeurs de chaîne sélectionnées. |
selectionMark |
string |
Le champ est-il sélectionné ? |
signature |
string |
La signature est-elle présente ? |
string |
string |
Texte brut. |
time |
string |
Heure, normalisée au format ISO 8601 (hh :mm :ss). |
DocumentIntelligenceError
Objet d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
details |
Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
target |
string |
Cible de l’erreur. |
DocumentIntelligenceErrorResponse
Objet de réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Informations d’erreur. |
DocumentIntelligenceInnerError
Objet contenant des informations plus spécifiques sur l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
innererror |
Erreur interne. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
DocumentTypeDetails
Informations sur le type de document.
Nom | Type | Description |
---|---|---|
buildMode |
Mode de génération de modèle de document personnalisé. |
|
confidenceThreshold |
number |
Effectuez uniquement une analyse si la confiance docType est supérieure au seuil. |
description |
string |
Description du modèle de document. |
features |
Liste des fonctionnalités d’analyse facultatives. |
|
fieldConfidence |
object |
Confiance estimée pour chaque champ. |
fieldSchema |
<string,
Document |
Description du schéma sémantique de document à l’aide d’une syntaxe de style de schéma JSON. |
maxDocumentsToAnalyze |
integer |
Nombre maximal de documents de type spécifié à analyser. Default=all. |
modelId |
string |
Modèle de document à utiliser pour l’analyse de documents avec un type spécifié. |
queryFields |
string[] |
Liste des champs supplémentaires à extraire. Ex. « NumberOfGuests,StoreNumber » |
SplitMode
Comportement de fractionnement de fichiers.
Nom | Type | Description |
---|---|---|
auto |
string |
Fractionner automatiquement le fichier en documents. |
none |
string |
Traitez l’intégralité du fichier en tant que document unique. |
perPage |
string |
Traitez chaque page du fichier comme un document distinct. |