Document Models - Build Model

  • Referenz
Dienst:
Azure AI Services
API-Version:
2024-07-31-preview

Erstellt ein benutzerdefiniertes Dokumentanalysemodell.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

uri

Der Document Intelligence-Dienstendpunkt.
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
buildMode True

DocumentBuildMode

Benutzerdefinierter Dokumentmodell-Buildmodus.
modelId True

string

Eindeutiger Dokumentmodellname.
allowOverwrite

boolean

Zulassen, dass ein vorhandenes Modell mit demselben Namen überschrieben wird.
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage-Dateiliste, die die Schulungsdaten angibt. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource

AzureBlobContentSource

Azure Blob Storage-Speicherort, der die Schulungsdaten enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
description

string

Dokumentmodellbeschreibung.
maxTrainingHours

number

Maximale Anzahl von V100-äquivalenten GPU-Stunden für die Modellschulung. Default=0.5.
tags

object

Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

Antworten

Name Typ Beschreibung
202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

  • Operation-Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Build Document Model

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AzureBlobContentSource

Azure Blob Storage-Inhalt.
AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.
BuildDocumentModelRequest

Fordern Sie den Textkörper an, um ein neues benutzerdefiniertes Dokumentmodell zu erstellen.
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

Blobnamenpräfix.

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

Fordern Sie den Textkörper an, um ein neues benutzerdefiniertes Dokumentmodell zu erstellen.

Name Typ Standardwert Beschreibung
allowOverwrite

boolean

False

Zulassen, dass ein vorhandenes Modell mit demselben Namen überschrieben wird.
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage-Dateiliste, die die Schulungsdaten angibt. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource

AzureBlobContentSource

Azure Blob Storage-Speicherort, der die Schulungsdaten enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
buildMode

DocumentBuildMode

Benutzerdefinierter Dokumentmodell-Buildmodus.
description

string

Dokumentmodellbeschreibung.
maxTrainingHours

number

0.5

Maximale Anzahl von V100-äquivalenten GPU-Stunden für die Modellschulung. Default=0.5.
modelId

string

Eindeutiger Dokumentmodellname.
tags

object

Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentBuildMode

Benutzerdefinierter Dokumentmodell-Buildmodus.

Name Typ Beschreibung
generative

string

Aktivieren Sie Dokumente aller Typen mithilfe von generativen KI-Techniken.
neural

string

Unterstützen Sie Dokumente mit verschiedenen visuellen Vorlagen.
template

string

Zieldokumente mit ähnlichen visuellen Vorlagen.

Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe 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

Eine serverdefinierte Gruppe von Fehlercodes.
innererror

InnerError

Innerer Fehler.
message

string

Eine lesbare Darstellung des Fehlers.