Document Models - Get Model

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-07-31-preview

Ruft detaillierte Dokumentmodellinformationen ab.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-07-31-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string	Eindeutiger Dokumentmodellname. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

endpoint

path

True

string

uri

Der Document Intelligence-Dienstendpunkt.

modelId

path

True

string

Eindeutiger Dokumentmodellname.

RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

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	DocumentModelDetails	Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

DocumentModelDetails

Die Anforderung ist erfolgreich.

Header

x-ms-client-request-id: string

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

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Beispielanforderung

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-07-31-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

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.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentTypeDetails	Dokumenttypinformationen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
SplitMode	Verhalten beim Teilen von Dateien.
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, der eine Teilmenge von Dokumenten angibt.

DocumentAnalysisFeature

Dokumentanalysefeatures, die aktiviert werden sollen.

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

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.

DocumentFieldSchema

Beschreibung des Feldsemantikschemas mithilfe einer JSON-Schemaformatsyntax.

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 auf ISO 3166-1 Alpha-3-Format (z. B. USA).
currency	string	Währungsbetrag mit optionalem Währungssymbol und Einheit.
date	string	Datum, normalisiert auf ISO 8601 (JJJJ-MM-DD) Format.
integer	string	Ganze Zahl, normalisiert auf 64-Bit-Ganzzahl mit Vorzeichen.
number	string	Gleitkommazahl, normalisiert in Gleitkommazahl mit doppelter Genauigkeit.
object	string	Benannte Liste von Unterfeldern potenziell unterschiedlicher Typen.
phoneNumber	string	Telefonnummer, normalisiert auf E.164 (+{CountryCode}{SubscriberNumber}) Format.
selectionGroup	string	Array der ausgewählten Zeichenfolgenwerte.
selectionMark	string	Ist das Feld ausgewählt?
signature	string	Ist die Signatur vorhanden?
string	string	Klartext.
time	string	Zeit, normalisiert auf ISO 8601 (hh:mm:ss)-Format.

DocumentModelDetails

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		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 Dokumentmodellname.
split	SplitMode	none	Bei zusammengesetzten Modellen verhält sich das Dateiaufteilungsverhalten.
tags	object		Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.
trainingHours	number		Die Anzahl der V100-äquivalenten GPU-Stunden, die für die Modellschulung verbraucht wurden.
warnings	Warning[]		Liste der Warnungen, die beim Erstellen des Modells aufgetreten sind.

DocumentTypeDetails

Dokumenttypinformationen.

Name	Typ	Beschreibung
buildMode	DocumentBuildMode	Benutzerdefinierter Dokumentmodell-Buildmodus.
confidenceThreshold	number	Führen Sie nur Analysen durch, wenn die DocType-Konfidenz über dem Schwellenwert liegt.
description	string	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	Maximale Anzahl der zu analysierenden Dokumente des angegebenen Typs. Default=all.
modelId	string	Dokumentmodell, das zum Analysieren von Dokumenten mit angegebenem Typ verwendet werden soll.
queryFields	string[]	Liste der zu extrahierenden zusätzlichen Felder. Ex. "NumberOfGuests,StoreNumber"

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.

SplitMode

Verhalten beim Teilen von Dateien.

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

Warning

Das Fehlerobjekt.

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

Freigeben über

Document Models - Get Model

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Get Custom Document Model

Beispielanforderung

Beispiel für eine Antwort

Get Prebuilt Document Model

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

Zusätzliche Ressourcen