Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Crée un modèle personnalisé d’analyse de document.

POST {endpoint}/documentintelligence/documentModels:build?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.
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 du modèle de document personnalisé.
modelId	True	string	Nom du modèle de document unique.
azureBlobFileListSource		AzureBlobFileListContentSource	Stockage Blob Azure liste de fichiers spécifiant les données d’apprentissage. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.
azureBlobSource		AzureBlobContentSource	Stockage Blob Azure emplacement contenant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.
description		string	Description du modèle de document.
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’est pas encore terminé. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-02-29-preview

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

Sample Response

Status code:

202

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

Définitions

Nom	Description
AzureBlobContentSource	Stockage Blob Azure contenu.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
BuildDocumentModelRequest	Corps de la demande pour créer un nouveau modèle de document personnalisé.
DocumentBuildMode	Mode de génération du modèle de document personnalisé.
Error	Objet error.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.

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.

BuildDocumentModelRequest

Corps de la demande pour créer un nouveau modèle de document personnalisé.

Nom	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Stockage Blob Azure liste de fichiers spécifiant les données d’apprentissage. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.
azureBlobSource	AzureBlobContentSource	Stockage Blob Azure emplacement contenant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.
buildMode	DocumentBuildMode	Mode de génération du modèle de document personnalisé.
description	string	Description 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.

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.

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	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	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	InnerError	Erreur interne.
message	string	Représentation lisible de l’erreur.