Document Models - Get Model
Obtient des informations détaillées sur le modèle de document.
GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Point de terminaison du service Document Intelligence. |
model
|
path | True |
string |
Nom du modèle de document unique. Modèle d’expression régulière: |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Identificateur de chaîne opaque, globalement unique et généré par le client pour la demande. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande a réussi. En-têtes x-ms-client-request-id: string |
|
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
Get Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Exemple de requête
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview
Exemple de réponse
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"myForm": {
"fieldSchema": {
"Name": {
"type": "string"
},
"Date": {
"type": "date"
},
"Amount": {
"type": "number"
}
},
"buildMode": "template",
"fieldConfidence": {
"Name": 0.9,
"Date": 0.95,
"Amount": 0.93
}
}
},
"tags": {
"createdBy": "myUserId"
}
}
Get Prebuilt Document Model
Exemple de requête
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview
Exemple de réponse
{
"modelId": "prebuilt-invoice",
"description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
"createdDateTime": "2021-07-30T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"prebuilt:invoice": {
"fieldSchema": {
"CustomerName": {
"type": "string"
},
"CustomerId": {
"type": "string"
},
"PurchaseOrder": {
"type": "string"
},
"InvoiceId": {
"type": "string"
},
"InvoiceDate": {
"type": "date"
},
"DueDate": {
"type": "date"
},
"VendorName": {
"type": "string"
},
"VendorAddress": {
"type": "string"
},
"VendorAddressRecipient": {
"type": "string"
},
"CustomerAddress": {
"type": "string"
},
"CustomerAddressRecipient": {
"type": "string"
},
"BillingAddress": {
"type": "string"
},
"BillingAddressRecipient": {
"type": "string"
},
"ShippingAddress": {
"type": "string"
},
"ShippingAddressRecipient": {
"type": "string"
},
"SubTotal": {
"type": "number"
},
"TotalTax": {
"type": "number"
},
"InvoiceTotal": {
"type": "number"
},
"AmountDue": {
"type": "number"
},
"PreviousUnpaidBalance": {
"type": "number"
},
"RemittanceAddress": {
"type": "string"
},
"RemittanceAddressRecipient": {
"type": "string"
},
"ServiceAddress": {
"type": "string"
},
"ServiceAddressRecipient": {
"type": "string"
},
"ServiceStartDate": {
"type": "date"
},
"ServiceEndDate": {
"type": "date"
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"Date": {
"type": "date"
},
"Description": {
"type": "string"
},
"Quantity": {
"type": "number"
},
"ProductCode": {
"type": "string"
},
"Tax": {
"type": "number"
},
"Unit": {
"type": "string"
},
"UnitPrice": {
"type": "number"
}
}
}
}
}
}
},
"tags": {}
}
Définitions
Nom | Description |
---|---|
Azure |
Stockage Blob Azure contenu. |
Azure |
Liste de fichiers dans Stockage Blob Azure. |
Document |
Mode de génération du 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émantique de la valeur de champ. |
Document |
Informations sur le modèle de document. |
Document |
Informations sur le type de document. |
Error |
Objet error. |
Error |
Objet de réponse d’erreur. |
Inner |
Objet contenant des informations plus spécifiques sur l’erreur. |
Warning |
Objet error. |
AzureBlobContentSource
Stockage Blob Azure contenu.
Nom | Type | Description |
---|---|---|
containerUrl |
string |
Stockage Blob Azure l’URL du conteneur. |
prefix |
string |
Préfixe de nom d’objet blob. |
AzureBlobFileListContentSource
Liste de fichiers dans Stockage Blob Azure.
Nom | Type | Description |
---|---|---|
containerUrl |
string |
Stockage Blob Azure l’URL du conteneur. |
fileList |
string |
Chemin d’accès à un fichier JSONL dans le conteneur spécifiant un sous-ensemble de documents. |
DocumentBuildMode
Mode de génération du modèle de document personnalisé.
Nom | Type | Description |
---|---|---|
neural |
string |
Documents de support avec divers modèles visuels. |
template |
string |
Ciblez les 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 d’objet. |
type |
Type de données sémantique de la valeur de champ. |
DocumentFieldType
Type de données sémantique de la valeur de 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 sur true ou false. |
countryRegion |
string |
Pays/région, normalisé au format ISO 3166-1 alpha-3 (par exemple, États-Unis). |
currency |
string |
Montant monétaire avec symbole et unité de devise facultatifs. |
date |
string |
Date, normalisée au format ISO 8601 (AAAA-MM-JJ). |
integer |
string |
Nombre entier normalisé en entier signé 64 bits. |
number |
string |
Nombre à virgule flottante, normalisé en virgule flottante double précision. |
object |
string |
Liste nommée de 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 des 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). |
DocumentModelDetails
Informations sur le modèle de document.
Nom | Type | Description |
---|---|---|
apiVersion |
string |
Version de l’API utilisée pour créer ce modèle de document. |
azureBlobFileListSource |
Stockage Blob Azure liste de fichiers spécifiant les données d’apprentissage. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés. |
|
azureBlobSource |
Stockage Blob Azure emplacement contenant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés. |
|
buildMode |
Mode de génération du modèle de document personnalisé. |
|
createdDateTime |
string |
Date et heure (UTC) de création du modèle de document. |
description |
string |
Description du modèle de document. |
docTypes |
<string,
Document |
Types de documents pris en charge. |
expirationDateTime |
string |
Date et heure (UTC) d’expiration du modèle de document. |
modelId |
string |
Nom du modèle de document unique. |
tags |
object |
Liste des attributs de balise clé-valeur associés au modèle de document. |
warnings |
Warning[] |
Liste des avertissements rencontrés lors de la génération du modèle. |
DocumentTypeDetails
Informations sur le type de document.
Nom | Type | Description |
---|---|---|
buildMode |
Mode de génération du modèle de document personnalisé. |
|
description |
string |
Description du modèle de document. |
fieldConfidence |
object |
Confiance estimée pour chaque champ. |
fieldSchema |
<string,
Document |
Description du schéma sémantique du document à l’aide d’une syntaxe de style de schéma JSON. |
Error
Objet error.
Nom | Type | Description |
---|---|---|
code |
string |
Un des ensembles de codes d’erreur définis par le serveur. |
details |
Error[] |
Tableau de détails sur les 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 de l’erreur. |
target |
string |
Cible de l’erreur. |
ErrorResponse
Objet de réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Informations sur l’erreur. |
InnerError
Objet contenant des informations plus spécifiques sur l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Un des ensembles de codes d’erreur définis par le serveur. |
innererror |
Erreur interne. |
|
message |
string |
Représentation lisible de l’erreur. |
Warning
Objet error.
Nom | Type | Description |
---|---|---|
code |
string |
Un des ensembles de codes d’avertissement définis par le serveur. |
message |
string |
Représentation lisible de l’avertissement. |
target |
string |
Cible de l’erreur. |