Document Models - Get Model

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-11-30

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.
modelId	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikatowa nazwa modelu dokumentu.
api-version	query	True	string minLength: 1	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	DocumentModelDetails	Żądanie zakończyło się pomyślnie. Nagłówki x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

DocumentModelDetails

Żądanie zakończyło się pomyślnie.

Nagłówki

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

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

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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-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
AzureBlobContentSource	Zawartość usługi Azure Blob Storage.
AzureBlobFileListContentSource	Lista plików w usłudze Azure Blob Storage.
DocumentAnalysisFeature	Funkcje analizy dokumentów do włączenia.
DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
DocumentFieldSchema	Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.
DocumentFieldType	Semantyczny typ danych wartości pola.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
DocumentIntelligenceWarning	Obiekt błędu.
DocumentModelDetails	Informacje o modelu dokumentu.
DocumentTypeDetails	Informacje o typie dokumentu.
SplitMode	Zachowanie dzielenia plików.

AzureBlobContentSource

Objekt

Zawartość usługi Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string (uri)	Adres URL kontenera usługi Azure Blob Storage.
prefix	string	Prefiks nazwy obiektu blob.

AzureBlobFileListContentSource

Objekt

Lista plików w usłudze Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string (uri)	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

Wyliczanie

Funkcje analizy dokumentów do włączenia.

Wartość	Opis
barcodes	Włącz wykrywanie kodów kreskowych w dokumencie.
formulas	Włącz wykrywanie wyrażeń matematycznych w dokumencie.
keyValuePairs	Włącz wykrywanie ogólnych par wartości klucza (pól formularza) w dokumencie.
languages	Włącz wykrywanie języka zawartości tekstowej.
ocrHighResolution	Wykonaj funkcję OCR w wyższej rozdzielczości, aby obsługiwać dokumenty z precyzyjnym drukowaniem.
queryFields	Włącz wyodrębnianie dodatkowych pól za pomocą parametru zapytania QueryFields.
styleFont	Włącz rozpoznawanie różnych stylów czcionek.

DocumentBuildMode

Wyliczanie

Niestandardowy tryb kompilacji modelu dokumentu.

Wartość	Opis
neural	Obsługa dokumentów z różnymi szablonami wizualnymi.
template	Dokumenty docelowe z podobnymi szablonami wizualizacji.

DocumentFieldSchema

Objekt

Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.

Nazwa	Typ	Opis
description	string maxLength: 4096	Opis pola.
example	string	Przykładowa zawartość pola.
items	DocumentFieldSchema	Schemat typu pola każdego elementu tablicy.
properties	<string, DocumentFieldSchema>	Nazwane pola podrzędne pola obiektu.
type	DocumentFieldType	Semantyczny typ danych wartości pola.

DocumentFieldType

Wyliczanie

Semantyczny typ danych wartości pola.

Wartość	Opis
address	Przeanalizowany adres.
array	Lista pól podrzędnych tego samego typu.
boolean	Wartość logiczna, znormalizowana do wartości true lub false.
countryRegion	Kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA).
currency	Kwota waluty z opcjonalnym symbolem waluty i jednostką.
date	Data, znormalizowana do formatu ISO 8601 (RRRR-MM-DD).
integer	Liczba całkowita, znormalizowana do 64-bitowej liczby całkowitej ze znakiem.
number	Liczba zmiennoprzecinkowa znormalizowana do podwójnej precyzji zmiennoprzecinkowa.
object	Nazwana lista pól podrzędnych potencjalnie różnych typów.
phoneNumber	Numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{Numer subskrybenta}).
selectionGroup	Tablica wybranych wartości ciągów.
selectionMark	Czy pole jest zaznaczone?
signature	Czy podpis jest obecny?
string	Zwykły tekst.
time	Czas znormalizowany do formatu ISO 8601 (hh:mm:ss).

DocumentIntelligenceError

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	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

Objekt

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

Objekt

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	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

DocumentIntelligenceWarning

Objekt

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

Objekt

Informacje o modelu dokumentu.

Nazwa	Typ	Domyślna wartość	Opis
apiVersion	string		Wersja interfejsu API używana do tworzenia tego modelu dokumentów.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista plików usługi Azure Blob Storage określająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Lokalizacja usługi Azure Blob Storage zawierająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
buildMode	DocumentBuildMode		Niestandardowy tryb kompilacji modelu dokumentu.
classifierId	string		W przypadku modeli skomponowanych klasyfikator niestandardowy do dzielenia i klasyfikowania pliku wejściowego.
createdDateTime	string (date-time)		Data i godzina (UTC) utworzenia modelu dokumentu.
description	string maxLength: 4096		Opis modelu dokumentu.
docTypes	<string, DocumentTypeDetails>		Obsługiwane typy dokumentów.
expirationDateTime	string (date-time)		Data i godzina (UTC), kiedy model dokumentu wygaśnie.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Unikatowa nazwa modelu dokumentu.
modifiedDateTime	string (date-time)		Data i godzina (UTC) ostatniej modyfikacji modelu dokumentu.
split	SplitMode	none	W przypadku modeli skomponowanych zachowanie dzielenia plików.
tags	object		Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.
trainingHours	number (float)		Liczba godzin procesorów GPU równoważnych w wersji 100 używanych na potrzeby trenowania modelu.
warnings	DocumentIntelligenceWarning[]		Lista ostrzeżeń napotkanych podczas tworzenia modelu.

DocumentTypeDetails

Objekt

Informacje o typie dokumentu.

Nazwa	Typ	Opis
buildMode	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
confidenceThreshold	number (float)	Wykonaj analizę tylko wtedy, gdy pewność dokumentu przekracza próg.
description	string maxLength: 4096	Opis modelu dokumentu.
features	DocumentAnalysisFeature[]	Lista opcjonalnych funkcji analizy.
fieldConfidence	object	Szacowana pewność dla każdego pola.
fieldSchema	<string, DocumentFieldSchema>	Opis schematu semantycznego dokumentu przy użyciu składni stylu schematu JSON.
maxDocumentsToAnalyze	integer (int32)	Maksymalna liczba dokumentów określonego typu do przeanalizowania. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	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

Wyliczanie

Zachowanie dzielenia plików.

Wartość	Opis
auto	Automatycznie podziel plik na dokumenty.
none	Traktuj cały plik jako pojedynczy dokument.
perPage	Traktuj każdą stronę w pliku jako oddzielny dokument.

Udostępnij za pośrednictwem

Document Models - Get Model

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

OAuth2Auth

Zakresy

Przykłady

Get Custom Document Model

Przykładowe żądanie

Przykładowa odpowiedź

Get Prebuilt Document Model

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

SplitMode

Dodatkowe zasoby