Document Models - Get Model
Ruft detaillierte Dokumentmodellinformationen ab.
GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string |
Der Document Intelligence-Dienstendpunkt. |
model
|
path | True |
string |
Eindeutiger Name des Dokumentmodells. Regex pattern: |
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 |
Die Anforderung wurde erfolgreich durchgeführt. Headers x-ms-client-request-id: string |
|
Other Status Codes |
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 Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview
Sample Response
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-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
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview
Sample Response
{
"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-02-29-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 |
---|---|
Azure |
Azure Blob Storage Inhalt. |
Azure |
Dateiliste in Azure Blob Storage. |
Document |
Erstellungsmodus für benutzerdefiniertes Dokumentmodell. |
Document |
Beschreibung des semantischen Feldschemas mithilfe einer JSON-Schemasyntax. |
Document |
Semantischer Datentyp des Feldwerts. |
Document |
Dokumentmodellinformationen. |
Document |
Dokumenttypinformationen. |
Error |
Das Fehlerobjekt. |
Error |
Fehlerantwortobjekt. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. |
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 |
Feldtypschema jedes Arrayelements. |
|
properties |
<string,
Document |
Benannte Unterfelder des Objektfelds. |
type |
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 |
Azure Blob Storage Dateiliste, in der die Trainingsdaten angegeben werden. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden. |
|
azureBlobSource |
Azure Blob Storage Speicherort mit den Trainingsdaten. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden. |
|
buildMode |
Erstellungsmodus für benutzerdefiniertes Dokumentmodell. |
|
createdDateTime |
string |
Datum und Uhrzeit (UTC), wann das Dokumentmodell erstellt wurde. |
description |
string |
Dokumentmodellbeschreibung. |
docTypes |
<string,
Document |
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 |
Erstellungsmodus für benutzerdefiniertes Dokumentmodell. |
|
description |
string |
Dokumentmodellbeschreibung. |
fieldConfidence |
object |
Geschätzte Zuverlässigkeit für jedes Feld. |
fieldSchema |
<string,
Document |
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 |
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 |
Fehlerinformationen. |
InnerError
Ein Objekt, das spezifischere Informationen zum Fehler enthält.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer der vom Server definierten Fehlercodes. |
innererror |
Innerer Fehler. |
|
message |
string |
Eine für Menschen lesbare Darstellung des Fehlers. |
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. |