Document Models - Compose Model

Dienst:

Azure AI Services

API-Version:

2024-11-30

Erstellt ein neues Dokumentmodell aus Dokumenttypen vorhandener Dokumentmodelle.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
classifierId	True	string	Benutzerdefinierte Klassifizierer zum Teilen und Klassifizieren der Eingabedatei.
docTypes	True	<string,  DocumentTypeDetails>	Wörterbuchzuordnung unterstützte DocTypes zu den entsprechenden Dokumentmodellen.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentmodellname.
description		string maxLength: 4096	Dokumentmodellbeschreibung.
split		SplitMode	Verhalten beim Teilen von Dateien.
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	DocumentIntelligenceErrorResponse	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

Compose Document Model

Beispielanforderung

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Beispiel für eine Antwort

Statuscode:

202

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

Definitionen

Name	Beschreibung
ComposeDocumentModelRequest	Fordern Sie textkörper an, um ein zusammengesetztes Dokumentmodell aus Komponentendokumentmodellen zu erstellen.
DocumentAnalysisFeature	Dokumentanalysefeatures, die aktiviert werden sollen.
DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
DocumentFieldSchema	Beschreibung des Feldsemantikschemas mithilfe einer JSON-Schemaformatsyntax.
DocumentFieldType	Semantischer Datentyp des Feldwerts.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
DocumentTypeDetails	Dokumenttypinformationen.
SplitMode	Verhalten beim Teilen von Dateien.

ComposeDocumentModelRequest

Objekt

Fordern Sie textkörper an, um ein zusammengesetztes Dokumentmodell aus Komponentendokumentmodellen zu erstellen.

Name	Typ	Standardwert	Beschreibung
classifierId	string		Benutzerdefinierte Klassifizierer zum Teilen und Klassifizieren der Eingabedatei.
description	string maxLength: 4096		Dokumentmodellbeschreibung.
docTypes	<string,  DocumentTypeDetails>		Wörterbuchzuordnung unterstützte DocTypes zu den entsprechenden Dokumentmodellen.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Eindeutiger Dokumentmodellname.
split	SplitMode	none	Verhalten beim Teilen von Dateien.
tags	object		Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentAnalysisFeature

Enumeration

Dokumentanalysefeatures, die aktiviert werden sollen.

Wert	Beschreibung
barcodes	Aktivieren Sie die Erkennung von Barcodes im Dokument.
formulas	Aktivieren Sie die Erkennung mathematischer Ausdrücke im Dokument.
keyValuePairs	Aktivieren Sie die Erkennung allgemeiner Schlüsselwertpaare (Formularfelder) im Dokument.
languages	Aktivieren Sie die Erkennung der Textinhaltssprache.
ocrHighResolution	Führen Sie OCR mit einer höheren Auflösung aus, um Dokumente mit Feindruck zu verarbeiten.
queryFields	Aktivieren Sie die Extraktion zusätzlicher Felder über den QueryFields-Abfrageparameter.
styleFont	Aktivieren Sie die Erkennung verschiedener Schriftformate.

DocumentBuildMode

Enumeration

Benutzerdefinierter Dokumentmodell-Buildmodus.

Wert	Beschreibung
neural	Unterstützen Sie Dokumente mit verschiedenen visuellen Vorlagen.
template	Zieldokumente mit ähnlichen visuellen Vorlagen.

DocumentFieldSchema

Objekt

Beschreibung des Feldsemantikschemas mithilfe einer JSON-Schemaformatsyntax.

Name	Typ	Beschreibung
description	string maxLength: 4096	Feldbeschreibung.
example	string	Beispielfeldinhalt.
items	DocumentFieldSchema	Feldtypschema jedes Arrayelements.
properties	<string,  DocumentFieldSchema>	Benannte Unterfelder des Objektfelds.
type	DocumentFieldType	Semantischer Datentyp des Feldwerts.

DocumentFieldType

Enumeration

Semantischer Datentyp des Feldwerts.

Wert	Beschreibung
address	Analysierte Adresse.
array	Liste der Unterfelder desselben Typs.
boolean	Boolescher Wert, normalisiert auf "true" oder "false".
countryRegion	Land/Region, normalisiert auf ISO 3166-1 Alpha-3-Format (z. B. USA).
currency	Währungsbetrag mit optionalem Währungssymbol und Einheit.
date	Datum, normalisiert auf ISO 8601 (JJJJ-MM-DD) Format.
integer	Ganze Zahl, normalisiert auf 64-Bit-Ganzzahl mit Vorzeichen.
number	Gleitkommazahl, normalisiert in Gleitkommazahl mit doppelter Genauigkeit.
object	Benannte Liste von Unterfeldern potenziell unterschiedlicher Typen.
phoneNumber	Telefonnummer, normalisiert auf E.164 (+{CountryCode}{SubscriberNumber}) Format.
selectionGroup	Array der ausgewählten Zeichenfolgenwerte.
selectionMark	Ist das Feld ausgewählt?
signature	Ist die Signatur vorhanden?
string	Klartext.
time	Zeit, normalisiert auf ISO 8601 (hh:mm:ss)-Format.

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

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

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

DocumentTypeDetails

Objekt

Dokumenttypinformationen.

Name	Typ	Beschreibung
buildMode	DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
confidenceThreshold	number (float)	Führen Sie nur Analysen durch, wenn die DocType-Konfidenz über dem Schwellenwert liegt.
description	string maxLength: 4096	Dokumentmodellbeschreibung.
features	DocumentAnalysisFeature[]	Liste der optionalen Analysefeatures.
fieldConfidence	object	Geschätzte Konfidenz für jedes Feld.
fieldSchema	<string,  DocumentFieldSchema>	Beschreibung des Dokumentsemantikschemas mithilfe einer JSON-Schemaformatsyntax.
maxDocumentsToAnalyze	integer (int32)	Maximale Anzahl der zu analysierenden Dokumente des angegebenen Typs. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Dokumentmodell, das zum Analysieren von Dokumenten mit angegebenem Typ verwendet werden soll.
queryFields	string[]	Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"

SplitMode

Enumeration

Verhalten beim Teilen von Dateien.

Wert	Beschreibung
auto	Datei automatisch in Dokumente aufteilen.
none	Behandeln Sie die gesamte Datei als einzelnes Dokument.
perPage	Behandeln Sie jede Seite in der Datei als separates Dokument.