Document Models - List Models

Service:

Azure AI Services

API Version:

2024-02-29-preview

Auflisten aller Dokumentmodelle

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

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	PagedDocumentModelDetails	Die Anforderung wurde erfolgreich durchgeführt. Headers x-ms-client-request-id: string
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

Get Document Models

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-02-29-preview

Sample Response

Status code:

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-02-29-preview"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
DocumentFieldSchema	Beschreibung des semantischen Feldschemas mithilfe einer JSON-Schemasyntax.
DocumentFieldType	Semantischer Datentyp des Feldwerts.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentTypeDetails	Dokumenttypinformationen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
PagedDocumentModelDetails	Ausgelagerte Auflistung von DocumentModelDetails-Elementen
Warning	Das Fehlerobjekt.

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, die eine Teilmenge von Dokumenten angibt.

DocumentBuildMode

Erstellungsmodus für benutzerdefiniertes Dokumentmodell.

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

DocumentFieldSchema

Beschreibung des semantischen Feldschemas mithilfe einer JSON-Schemasyntax.

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

DocumentFieldType

Semantischer Datentyp des Feldwerts.

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

DocumentModelDetails

Dokumentmodellinformationen.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Dokumentmodells verwendet wird.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage Dateiliste, in der die Trainingsdaten angegeben werden. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage Speicherort mit den Trainingsdaten. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
buildMode	DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
createdDateTime	string	Datum und Uhrzeit (UTC), wann das Dokumentmodell erstellt wurde.
description	string	Dokumentmodellbeschreibung.
docTypes	<string,  DocumentTypeDetails>	Unterstützte Dokumenttypen.
expirationDateTime	string	Datum und Uhrzeit (UTC), wann das Dokumentmodell abläuft.
modelId	string	Eindeutiger Name des Dokumentmodells.
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.
warnings	Warning[]	Liste der Warnungen, die beim Erstellen des Modells aufgetreten sind.

DocumentTypeDetails

Dokumenttypinformationen.

Name	Typ	Beschreibung
buildMode	DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
description	string	Dokumentmodellbeschreibung.
fieldConfidence	object	Geschätzte Zuverlässigkeit für jedes Feld.
fieldSchema	<string,  DocumentFieldSchema>	Beschreibung des semantischen Dokumentschemas unter Verwendung einer JSON-Schemasyntax.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten 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 für Menschen 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 der vom Server definierten Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

PagedDocumentModelDetails

Ausgelagerte Auflistung von DocumentModelDetails-Elementen

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

Warning

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Warnungscodes.
message	string	Eine für Menschen lesbare Darstellung der Warnung.
target	string	Das Ziel des Fehlers.