Document Models - Build Model

Service:

Azure AI Services

API-versie:

2024-11-30

Hiermee maakt u een aangepast documentanalysemodel.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-11-30

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Het Eindpunt van de Document Intelligence-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
buildMode	True	DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unieke documentmodelnaam.
allowOverwrite		boolean	Toestaan dat een bestaand model met dezelfde naam wordt overschreven.
azureBlobFileListSource		AzureBlobFileListContentSource	Lijst met Azure Blob Storage-bestanden 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 maxLength: 4096	Beschrijving van documentmodel.
maxTrainingHours		number (float)	Maximum aantal gpu-uren van V100-equivalent dat moet worden gebruikt voor modeltraining. Default=0,5.
tags		object	Lijst met kenmerken van sleutel-waardetags 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. Kopteksten Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Build Document Model

Voorbeeldaanvraag

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"
  }
}

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage-inhoud.
AzureBlobFileListContentSource	Bestandslijst in Azure Blob Storage.
BuildDocumentModelRequest	Aanvraagtekst om een nieuw aangepast documentmodel te maken.
DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
DocumentIntelligenceError	Het foutobject.
DocumentIntelligenceErrorResponse	Foutantwoordobject.
DocumentIntelligenceInnerError	Een object met meer specifieke informatie over de fout.

AzureBlobContentSource

Object

Azure Blob Storage-inhoud.

Name	Type	Description
containerUrl	string (uri)	Url van Azure Blob Storage-container.
prefix	string	Voorvoegsel van blobnaam.

AzureBlobFileListContentSource

Object

Bestandslijst in Azure Blob Storage.

Name	Type	Description
containerUrl	string (uri)	Url van Azure Blob Storage-container.
fileList	string	Pad naar een JSONL-bestand in de container die een subset van documenten opgeeft.

BuildDocumentModelRequest

Object

Aanvraagtekst om een nieuw aangepast documentmodel te maken.

Name	Type	Default value	Description
allowOverwrite	boolean	False	Toestaan dat een bestaand model met dezelfde naam wordt overschreven.
azureBlobFileListSource	AzureBlobFileListContentSource		Lijst met Azure Blob Storage-bestanden 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		De buildmodus voor het aangepaste documentmodel.
description	string maxLength: 4096		Beschrijving van documentmodel.
maxTrainingHours	number (float)	0.5	Maximum aantal gpu-uren van V100-equivalent dat moet worden gebruikt voor modeltraining. Default=0,5.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Unieke documentmodelnaam.
tags	object		Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentBuildMode

Inventarisatie

De buildmodus voor het aangepaste documentmodel.

Waarde	Description
template	Doeldocumenten met vergelijkbare visuele sjablonen.
neural	Ondersteuning voor documenten met diverse visuele sjablonen.

DocumentIntelligenceError

Object

Het foutobject.

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

DocumentIntelligenceErrorResponse

Object

Foutantwoordobject.

Name	Type	Description
error	DocumentIntelligenceError	Foutinformatie.

DocumentIntelligenceInnerError

Object

Een object met meer specifieke informatie over de fout.

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