Document Models - Compose Model

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Tworzy nowy model dokumentu na podstawie typów dokumentów istniejących modeli dokumentów.

POST {endpoint}/documentintelligence/documentModels:compose?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.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
classifierId	True	string	Klasyfikator niestandardowy do dzielenia i klasyfikowania pliku wejściowego.
docTypes	True	<string,  DocumentTypeDetails>	Mapowanie słownika obsługiwane przez dokumenty do odpowiednich modeli dokumentów.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikatowa nazwa modelu dokumentu.
description		string maxLength: 4096	Opis modelu dokumentu.
split		SplitMode	Zachowanie dzielenia plików.
tags		object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Nagłówki Operation-Location: string Retry-After: integer
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

Compose Document Model

Przykładowe żądanie

HTTP

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

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Definicje

Nazwa	Opis
ComposeDocumentModelRequest	Treść żądania utworzenia złożonego modelu dokumentów na podstawie modeli dokumentów składników.
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.
DocumentTypeDetails	Informacje o typie dokumentu.
SplitMode	Zachowanie dzielenia plików.

ComposeDocumentModelRequest

Objekt

Treść żądania utworzenia złożonego modelu dokumentów na podstawie modeli dokumentów składników.

Nazwa	Typ	Domyślna wartość	Opis
classifierId	string		Klasyfikator niestandardowy do dzielenia i klasyfikowania pliku wejściowego.
description	string maxLength: 4096		Opis modelu dokumentu.
docTypes	<string,  DocumentTypeDetails>		Mapowanie słownika obsługiwane przez dokumenty do odpowiednich modeli dokumentów.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Unikatowa nazwa modelu dokumentu.
split	SplitMode	none	Zachowanie dzielenia plików.
tags	object		Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

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.

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.