Document Models - Build Model

Service:

Azure AI Services

Version d'API:

2024-11-30

Génère un modèle d’analyse de document personnalisé.

POST {endpoint}/documentintelligence/documentModels:build?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
buildMode	True	DocumentBuildMode	Mode de génération de modèle de document personnalisé.
modelId	True	string	Nom unique du modèle de document.
allowOverwrite		boolean	Autorisez l’écriture d’un modèle existant portant le même nom.
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é.
description		string	Description du modèle de document.
maxTrainingHours		number	Nombre maximal d’heures gpu équivalentes à V100 à utiliser pour l’entraînement du modèle. Default=0.5.
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 Operation-Location: string Retry-After: integer
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

Build Document Model

Exemple de requête

HTTP

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

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Exemple de réponse

Code d’état:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Définitions

Nom	Description
AzureBlobContentSource	Contenu stockage Blob Azure.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
BuildDocumentModelRequest	Corps de la demande pour générer un nouveau modèle de document personnalisé.
DocumentBuildMode	Mode de génération de modèle de document personnalisé.
DocumentIntelligenceError	Objet d’erreur.
DocumentIntelligenceErrorResponse	Objet de réponse d’erreur.
DocumentIntelligenceInnerError	Objet contenant des informations plus spécifiques sur l’erreur.

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.

BuildDocumentModelRequest

Corps de la demande pour générer un nouveau modèle de document personnalisé.

Nom	Type	Valeur par défaut	Description
allowOverwrite	boolean	False	Autorisez l’écriture d’un modèle existant portant le même nom.
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é.
description	string		Description du modèle de document.
maxTrainingHours	number	0.5	Nombre maximal d’heures gpu équivalentes à V100 à utiliser pour l’entraînement du modèle. Default=0.5.
modelId	string		Nom unique du modèle de document.
tags	object		Liste des attributs de balise clé-valeur associés au modèle de document.

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.

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.