Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Erstellt ein benutzerdefiniertes Dokumentenanalysemodell.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

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 wurde für die Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

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	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

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

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	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.

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 innerhalb des Containers, der eine Teilmenge von Dokumenten 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

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.