Document Models - Compose Model

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-07-31-preview

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

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-07-31-preview

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	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	Unikatowa nazwa modelu dokumentu.
description		string	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	ErrorResponse	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-07-31-preview

{
  "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-07-31-preview

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.
DocumentTypeDetails	Informacje o typie dokumentu.
Error	Obiekt błędu.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
SplitMode	Zachowanie dzielenia plików.

ComposeDocumentModelRequest

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		Opis modelu dokumentu.
docTypes	<string,  DocumentTypeDetails>		Mapowanie słownika obsługiwane przez dokumenty do odpowiednich modeli dokumentów.
modelId	string		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

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
generative	string	Włącz dokumenty wszystkich typów przy użyciu technik generowania sztucznej inteligencji.
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	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

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).

DocumentTypeDetails

Informacje o typie dokumentu.

Nazwa	Typ	Opis
buildMode	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
confidenceThreshold	number	Wykonaj analizę tylko wtedy, gdy pewność dokumentu przekracza próg.
description	string	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	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"

Error

Obiekt błędu.

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

ErrorResponse

Błąd obiektu odpowiedzi.

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

InnerError

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

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.