Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.

POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
api-version	query	True	string	Angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
buildMode	True	DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
modelId	True	string	Eindeutiger Dokumentmodellname.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage Dateiliste an, in der die Trainingsdaten angegeben werden. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage Speicherort, der die Trainingsdaten enthält. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.
description		string	Dokumentmodellbeschreibung.
tags		object	Liste der Schlüssel-Wert-Tag-Attribute, die dem Dokumentmodell zugeordnet sind.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wird erfolgreich in die Warteschlange gestellt. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Type: apiKey
In: header

Beispiele

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
BuildDocumentModelRequest	Anforderungstext zum Erstellen eines neuen benutzerdefinierten Dokumentmodells.
DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
Error	Fehlerinformationen.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Detaillierter Fehler.

AzureBlobContentSource

Azure Blob Storage Inhalt.

Name	Typ	Beschreibung
containerUrl	string	Azure Blob Storage Container-URL.
prefix	string	Präfix des Blobnamens.

AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.

Name	Typ	Beschreibung
containerUrl	string	Azure Blob Storage Container-URL.
fileList	string	Pfad zu einer JSONL-Datei im Container, die eine Teilmenge der Dokumente für das Training angibt.

BuildDocumentModelRequest

Anforderungstext zum Erstellen eines neuen benutzerdefinierten Dokumentmodells.

Name	Typ	Beschreibung
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage Dateiliste an, in der die Trainingsdaten angegeben werden. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage Speicherort, der die Trainingsdaten enthält. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.
buildMode	DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
description	string	Dokumentmodellbeschreibung.
modelId	string	Eindeutiger Dokumentmodellname.
tags	object	Liste der Schlüssel-Wert-Tag-Attribute, die dem Dokumentmodell zugeordnet sind.

DocumentBuildMode

Benutzerdefinierter Dokumentmodell-Buildmodus.

Name	Typ	Beschreibung
neural	string	Unterstützung von Dokumenten mit verschiedenen visuellen Vorlagen.
template	string	Zieldokumente mit ähnlichen visuellen Vorlagen.

Error

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	Error[]	Liste der detaillierten Fehler.
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.