Document Models - Get Model

Référence

Service:: Azure AI Services

Version d'API:: 2024-11-30

Obtient des informations détaillées sur le modèle de document.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-11-30

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Point de terminaison du service Document Intelligence.
modelId	path	True	string	Nom unique du modèle de document. Modèle d’expression régulière: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

endpoint

path

True

string

uri

Point de terminaison du service Document Intelligence.

modelId

path

True

string

Nom unique du modèle de document.

Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

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 requête.

Réponses

Nom	Type	Description
200 OK	DocumentModelDetails	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

DocumentModelDetails

La demande a réussi.

En-têtes

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

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

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-11-30

Exemple de réponse

Code d’état:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-11-30",
  "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

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-11-30

Exemple de réponse

Code d’état:: 200

{
  "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-11-30",
  "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
AzureBlobContentSource	Contenu stockage Blob Azure.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
DocumentAnalysisFeature	Fonctionnalités d’analyse de document à activer.
DocumentBuildMode	Mode de génération de modèle de document personnalisé.
DocumentFieldSchema	Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON.
DocumentFieldType	Type de données sémantiques de la valeur du champ.
DocumentIntelligenceError	Objet d’erreur.
DocumentIntelligenceErrorResponse	Objet de réponse d’erreur.
DocumentIntelligenceInnerError	Objet contenant des informations plus spécifiques sur l’erreur.
DocumentIntelligenceWarning	Objet d’erreur.
DocumentModelDetails	Informations sur le modèle de document.
DocumentTypeDetails	Informations sur le type de document.
SplitMode	Comportement de fractionnement de fichiers.

AzureBlobContentSource

Contenu stockage Blob Azure.

Nom	Type	Description
containerUrl	string	URL du conteneur Stockage Blob Azure.
prefix	string	Préfixe de nom d’objet blob.

AzureBlobFileListContentSource

Liste de fichiers dans Stockage Blob Azure.

Nom	Type	Description
containerUrl	string	URL du conteneur Stockage Blob Azure.
fileList	string	Chemin d’accès à un fichier JSONL dans le conteneur spécifiant un sous-ensemble de documents.

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	DocumentFieldSchema	Schéma de type de champ de chaque élément de tableau.
properties	<string, DocumentFieldSchema>	Sous-champs nommés du champ objet.
type	DocumentFieldType	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	DocumentIntelligenceError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	DocumentIntelligenceInnerError	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	DocumentIntelligenceError	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	DocumentIntelligenceInnerError	Erreur interne.
message	string	Représentation lisible par l’homme de l’erreur.

DocumentIntelligenceWarning

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’avertissement définis par le serveur.
message	string	Représentation lisible par l’homme de l’avertissement.
target	string	Cible de l’erreur.

DocumentModelDetails

Informations sur le modèle de document.

Nom	Type	Valeur par défaut	Description
apiVersion	string		Version de l’API utilisée pour créer ce modèle de document.
azureBlobFileListSource	AzureBlobFileListContentSource		Liste de fichiers stockage Blob Azure spécifiant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
azureBlobSource	AzureBlobContentSource		Emplacement stockage Blob Azure contenant les données d’apprentissage. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
buildMode	DocumentBuildMode		Mode de génération de modèle de document personnalisé.
classifierId	string		Pour les modèles composés, le classifieur personnalisé à fractionner et classifier le fichier d’entrée.
createdDateTime	string		Date et heure (UTC) lors de la création du modèle de document.
description	string		Description du modèle de document.
docTypes	<string, DocumentTypeDetails>		Types de documents pris en charge.
expirationDateTime	string		Date et heure (UTC) à laquelle le modèle de document expire.
modelId	string		Nom unique du modèle de document.
modifiedDateTime	string		Date et heure (UTC) de la dernière modification du modèle de document.
split	SplitMode	none	Pour les modèles composés, le comportement de fractionnement de fichier.
tags	object		Liste des attributs de balise clé-valeur associés au modèle de document.
trainingHours	number		Nombre d’heures GPU équivalentes à V100 consommées pour l’entraînement du modèle.
warnings	DocumentIntelligenceWarning[]		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	DocumentBuildMode	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	DocumentAnalysisFeature[]	Liste des fonctionnalités d’analyse facultatives.
fieldConfidence	object	Confiance estimée pour chaque champ.
fieldSchema	<string, DocumentFieldSchema>	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.

Partager via

Document Models - Get Model

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

OAuth2Auth

Étendues

Exemples

Get Custom Document Model

Exemple de requête

Exemple de réponse

Get Prebuilt Document Model

Exemple de requête

Exemple de réponse

Définitions

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

SplitMode

Ressources supplémentaires