Udostępnij za pośrednictwem


Document Models - List Models

Wyświetlanie listy wszystkich modeli dokumentów

GET {endpoint}/documentintelligence/documentModels?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

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

PagedDocumentModelDetails

Żą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 Document Models

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2024-11-30"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

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.

PagedDocumentModelDetails

Stronicowana kolekcja elementów DocumentModelDetails

SplitMode

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

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

DocumentIntelligenceError

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

Błąd obiektu odpowiedzi.

Nazwa Typ Opis
error

DocumentIntelligenceError

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

DocumentIntelligenceInnerError

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

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

Data i godzina (UTC) utworzenia modelu dokumentu.

description

string

Opis modelu dokumentu.

docTypes

<string,  DocumentTypeDetails>

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

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

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

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"

PagedDocumentModelDetails

Stronicowana kolekcja elementów DocumentModelDetails

Nazwa Typ Opis
nextLink

string

Link do następnej strony elementów

value

DocumentModelDetails[]

Elementy DocumentModelDetails na tej stronie

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.