Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Hiermee bouwt u een aangepast documentanalysemodel.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Het eindpunt van de Document Intelligence-service.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
buildMode	True	DocumentBuildMode	Modus voor het maken van aangepast documentmodellen.
modelId	True	string	Unieke documentmodelnaam.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage bestandslijst waarin de trainingsgegevens worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage locatie met de trainingsgegevens. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
description		string	Beschrijving van documentmodel.
tags		object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Beveiliging

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

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

Voorbeelden

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

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage inhoud.
AzureBlobFileListContentSource	Lijst met bestanden in Azure Blob Storage.
BuildDocumentModelRequest	Aanvraagtekst voor het bouwen van een nieuw aangepast documentmodel.
DocumentBuildMode	Modus voor het maken van aangepast documentmodellen.
Error	Het foutobject.
ErrorResponse	Foutreactieobject.
InnerError	Een object met specifiekere informatie over de fout.

AzureBlobContentSource

Azure Blob Storage inhoud.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
prefix	string	Blobnaamvoorvoegsel.

AzureBlobFileListContentSource

Lijst met bestanden in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
fileList	string	Pad naar een JSONL-bestand in de container waarin een subset van documenten wordt opgegeven.

BuildDocumentModelRequest

Aanvraagtekst voor het bouwen van een nieuw aangepast documentmodel.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage bestandslijst waarin de trainingsgegevens worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage locatie met de trainingsgegevens. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
buildMode	DocumentBuildMode	Modus voor het maken van aangepast documentmodellen.
description	string	Beschrijving van documentmodel.
modelId	string	Unieke documentmodelnaam.
tags	object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

DocumentBuildMode

Modus voor het maken van aangepast documentmodellen.

Name	Type	Description
neural	string	Ondersteuningsdocumenten met diverse visuele sjablonen.
template	string	Doeldocumenten met vergelijkbare visuele sjablonen.

Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met specifiekere informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	InnerError	Interne fout.
message	string	Een door mensen leesbare weergave van de fout.