Document Models - Get Model
Pobiera szczegółowe informacje o modelu dokumentu.
GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-11-30
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
Punkt końcowy usługi Analizy dokumentów. |
model
|
path | True |
string |
Unikatowa nazwa modelu dokumentu. Wzorzec wyrażenia regularnego: |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Żądanie zakończyło się pomyślnie. Nagłówki x-ms-client-request-id: string |
|
Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
Ocp-Apim-Subscription-Key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
accessCode
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu:
https://login.microsoftonline.com/common/oauth2/token
Zakresy
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default |
Przykłady
Get Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Przykładowe żądanie
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-11-30
Przykładowa odpowiedź
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-11-30",
"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
Przykładowe żądanie
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-11-30
Przykładowa odpowiedź
{
"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-11-30",
"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": {}
}
Definicje
Nazwa | Opis |
---|---|
Azure |
Zawartość usługi Azure Blob Storage. |
Azure |
Lista plików w usłudze Azure Blob Storage. |
Document |
Funkcje analizy dokumentów do włączenia. |
Document |
Niestandardowy tryb kompilacji modelu dokumentu. |
Document |
Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON. |
Document |
Semantyczny typ danych wartości pola. |
Document |
Obiekt błędu. |
Document |
Błąd obiektu odpowiedzi. |
Document |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. |
Document |
Obiekt błędu. |
Document |
Informacje o modelu dokumentu. |
Document |
Informacje o typie dokumentu. |
Split |
Zachowanie dzielenia plików. |
AzureBlobContentSource
Zawartość usługi Azure Blob Storage.
Nazwa | Typ | Opis |
---|---|---|
containerUrl |
string |
Adres URL kontenera usługi Azure Blob Storage. |
prefix |
string |
Prefiks nazwy obiektu blob. |
AzureBlobFileListContentSource
Lista plików w usłudze Azure Blob Storage.
Nazwa | Typ | Opis |
---|---|---|
containerUrl |
string |
Adres URL kontenera usługi Azure Blob Storage. |
fileList |
string |
Ścieżka do pliku JSONL w kontenerze określającym podzbiór dokumentów. |
DocumentAnalysisFeature
Funkcje analizy dokumentów do włączenia.
Nazwa | Typ | Opis |
---|---|---|
barcodes |
string |
Włącz wykrywanie kodów kreskowych w dokumencie. |
formulas |
string |
Włącz wykrywanie wyrażeń matematycznych w dokumencie. |
keyValuePairs |
string |
Włącz wykrywanie ogólnych par wartości klucza (pól formularza) w dokumencie. |
languages |
string |
Włącz wykrywanie języka zawartości tekstowej. |
ocrHighResolution |
string |
Wykonaj funkcję OCR w wyższej rozdzielczości, aby obsługiwać dokumenty z precyzyjnym drukowaniem. |
queryFields |
string |
Włącz wyodrębnianie dodatkowych pól za pomocą parametru zapytania QueryFields. |
styleFont |
string |
Włącz rozpoznawanie różnych stylów czcionek. |
DocumentBuildMode
Niestandardowy tryb kompilacji modelu dokumentu.
Nazwa | Typ | Opis |
---|---|---|
neural |
string |
Obsługa dokumentów z różnymi szablonami wizualnymi. |
template |
string |
Dokumenty docelowe z podobnymi szablonami wizualizacji. |
DocumentFieldSchema
Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.
Nazwa | Typ | Opis |
---|---|---|
description |
string |
Opis pola. |
example |
string |
Przykładowa zawartość pola. |
items |
Schemat typu pola każdego elementu tablicy. |
|
properties |
<string,
Document |
Nazwane pola podrzędne pola obiektu. |
type |
Semantyczny typ danych wartości pola. |
DocumentFieldType
Semantyczny typ danych wartości pola.
Nazwa | Typ | Opis |
---|---|---|
address |
string |
Przeanalizowany adres. |
array |
string |
Lista pól podrzędnych tego samego typu. |
boolean |
string |
Wartość logiczna, znormalizowana do wartości true lub false. |
countryRegion |
string |
Kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA). |
currency |
string |
Kwota waluty z opcjonalnym symbolem waluty i jednostką. |
date |
string |
Data, znormalizowana do formatu ISO 8601 (RRRR-MM-DD). |
integer |
string |
Liczba całkowita, znormalizowana do 64-bitowej liczby całkowitej ze znakiem. |
number |
string |
Liczba zmiennoprzecinkowa znormalizowana do podwójnej precyzji zmiennoprzecinkowa. |
object |
string |
Nazwana lista pól podrzędnych potencjalnie różnych typów. |
phoneNumber |
string |
Numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{Numer subskrybenta}). |
selectionGroup |
string |
Tablica wybranych wartości ciągów. |
selectionMark |
string |
Czy pole jest zaznaczone? |
signature |
string |
Czy podpis jest obecny? |
string |
string |
Zwykły tekst. |
time |
string |
Czas znormalizowany do formatu ISO 8601 (hh:mm:ss). |
DocumentIntelligenceError
Obiekt błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
target |
string |
Element docelowy błędu. |
DocumentIntelligenceErrorResponse
Błąd obiektu odpowiedzi.
Nazwa | Typ | Opis |
---|---|---|
error |
Informacje o błędzie. |
DocumentIntelligenceInnerError
Obiekt zawierający bardziej szczegółowe informacje o błędzie.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
innererror |
Błąd wewnętrzny. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
DocumentIntelligenceWarning
Obiekt błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów ostrzegawczych. |
message |
string |
Czytelna dla człowieka reprezentacja ostrzeżenia. |
target |
string |
Element docelowy błędu. |
DocumentModelDetails
Informacje o modelu dokumentu.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
apiVersion |
string |
Wersja interfejsu API używana do tworzenia tego modelu dokumentów. |
|
azureBlobFileListSource |
Lista plików usługi Azure Blob Storage określająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource. |
||
azureBlobSource |
Lokalizacja usługi Azure Blob Storage zawierająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource. |
||
buildMode |
Niestandardowy tryb kompilacji modelu dokumentu. |
||
classifierId |
string |
W przypadku modeli skomponowanych klasyfikator niestandardowy do dzielenia i klasyfikowania pliku wejściowego. |
|
createdDateTime |
string |
Data i godzina (UTC) utworzenia modelu dokumentu. |
|
description |
string |
Opis modelu dokumentu. |
|
docTypes |
<string,
Document |
Obsługiwane typy dokumentów. |
|
expirationDateTime |
string |
Data i godzina (UTC), kiedy model dokumentu wygaśnie. |
|
modelId |
string |
Unikatowa nazwa modelu dokumentu. |
|
modifiedDateTime |
string |
Data i godzina (UTC) ostatniej modyfikacji modelu dokumentu. |
|
split | none |
W przypadku modeli skomponowanych zachowanie dzielenia plików. |
|
tags |
object |
Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu. |
|
trainingHours |
number |
Liczba godzin procesorów GPU równoważnych w wersji 100 używanych na potrzeby trenowania modelu. |
|
warnings |
Lista ostrzeżeń napotkanych podczas tworzenia modelu. |
DocumentTypeDetails
Informacje o typie dokumentu.
Nazwa | Typ | Opis |
---|---|---|
buildMode |
Niestandardowy tryb kompilacji modelu dokumentu. |
|
confidenceThreshold |
number |
Wykonaj analizę tylko wtedy, gdy pewność dokumentu przekracza próg. |
description |
string |
Opis modelu dokumentu. |
features |
Lista opcjonalnych funkcji analizy. |
|
fieldConfidence |
object |
Szacowana pewność dla każdego pola. |
fieldSchema |
<string,
Document |
Opis schematu semantycznego dokumentu przy użyciu składni stylu schematu JSON. |
maxDocumentsToAnalyze |
integer |
Maksymalna liczba dokumentów określonego typu do przeanalizowania. Default=all. |
modelId |
string |
Model dokumentów używany do analizowania dokumentów o określonym typie. |
queryFields |
string[] |
Lista dodatkowych pól do wyodrębnienia. Ex. "NumberOfGuests,StoreNumber" |
SplitMode
Zachowanie dzielenia plików.
Nazwa | Typ | Opis |
---|---|---|
auto |
string |
Automatycznie podziel plik na dokumenty. |
none |
string |
Traktuj cały plik jako pojedynczy dokument. |
perPage |
string |
Traktuj każdą stronę w pliku jako oddzielny dokument. |