Document Models - List Models

Dienst:: Azure AI Services

API-Version:: 2024-11-30

Alle Dokumentmodelle auflisten

GET {endpoint}/documentintelligence/documentModels?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.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	PagedDocumentModelDetails	Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

PagedDocumentModelDetails

Die Anforderung ist erfolgreich.

Header

x-ms-client-request-id: string

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

Get Document Models

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2024-11-30"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage-Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
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.
DocumentIntelligenceWarning	Das Fehlerobjekt.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentTypeDetails	Dokumenttypinformationen.
PagedDocumentModelDetails	Paged-Auflistung von DocumentModelDetails-Elementen
SplitMode	Verhalten beim Teilen von Dateien.

AzureBlobContentSource

Objekt

Azure Blob Storage-Inhalt.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
prefix	string	Blobnamenpräfix.

AzureBlobFileListContentSource

Objekt

Dateiliste in Azure Blob Storage.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
fileList	string	Pfad zu einer JSONL-Datei innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

DocumentAnalysisFeature

Enumeration

Dokumentanalysefeatures, die aktiviert werden sollen.

Wert	Beschreibung
ocrHighResolution	Führen Sie OCR mit einer höheren Auflösung aus, um Dokumente mit Feindruck zu verarbeiten.
languages	Aktivieren Sie die Erkennung der Textinhaltssprache.
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.
styleFont	Aktivieren Sie die Erkennung verschiedener Schriftformate.
queryFields	Aktivieren Sie die Extraktion zusätzlicher Felder über den QueryFields-Abfrageparameter.

DocumentBuildMode

Enumeration

Benutzerdefinierter Dokumentmodell-Buildmodus.

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

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.

DocumentIntelligenceWarning

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der serverdefinierten Warnungscodes.
message	string	Eine lesbare Darstellung der Warnung.
target	string	Das Ziel des Fehlers.

DocumentModelDetails

Objekt

Dokumentmodellinformationen.

Name	Typ	Standardwert	Beschreibung
apiVersion	string		API-Version, die zum Erstellen dieses Dokumentmodells verwendet 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.
classifierId	string		Bei zusammengesetzten Modellen wird der benutzerdefinierte Klassifizierer zum Teilen und Klassifizieren der Eingabedatei verwendet.
createdDateTime	string (date-time)		Datum und Uhrzeit (UTC), wann das Dokumentmodell erstellt wurde.
description	string maxLength: 4096		Dokumentmodellbeschreibung.
docTypes	<string, DocumentTypeDetails>		Unterstützte Dokumenttypen.
expirationDateTime	string (date-time)		Datum und Uhrzeit (UTC), wann das Dokumentmodell abläuft.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Eindeutiger Dokumentmodellname.
modifiedDateTime	string (date-time)		Datum und Uhrzeit (UTC), wann das Dokumentmodell zuletzt geändert wurde.
split	SplitMode	none	Bei zusammengesetzten Modellen verhält sich das Dateiaufteilungsverhalten.
tags	object		Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.
trainingHours	number (float)		Die Anzahl der V100-äquivalenten GPU-Stunden, die für die Modellschulung verbraucht wurden.
warnings	DocumentIntelligenceWarning[]		Liste der Warnungen, die beim Erstellen des Modells aufgetreten sind.

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"

PagedDocumentModelDetails

Objekt

Paged-Auflistung von DocumentModelDetails-Elementen

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	DocumentModelDetails[]	Die DocumentModelDetails-Elemente auf dieser Seite

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.