Document Classifiers - List Classifiers
Wyświetl listę wszystkich klasyfikatorów dokumentów.
GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-02-29-preview
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
endpoint
|
path | True |
string |
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 |
Nieprzezroczysty, unikatowy globalnie, wygenerowany przez klienta identyfikator ciągu 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 Document Classifiers
Przykładowe żądanie
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?api-version=2024-02-29-preview
Przykładowa odpowiedź
{
"value": [
{
"classifierId": "classifier1",
"description": "Classifier1 description",
"createdDateTime": "2022-07-30T00:00:00Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"formA": {
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "formADocs/"
}
},
"formB": {
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "formBDocs/"
}
}
}
},
{
"classifierId": "classifier2",
"description": "Classifier2 description",
"createdDateTime": "2022-07-30T00:00:00Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"formB": {
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "formBDocs/"
}
},
"formC": {
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "formCDocs/"
}
}
}
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}
Definicje
Nazwa | Opis |
---|---|
Azure |
Azure Blob Storage zawartości. |
Azure |
Lista plików w Azure Blob Storage. |
Classifier |
Informacje o typie dokumentu klasyfikatora. |
Content |
Typ źródła zawartości. |
Document |
Informacje o klasyfikatorze dokumentu. |
Error |
Obiekt błędu. |
Error |
Błąd obiektu odpowiedzi. |
Inner |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. |
Paged |
Stronicowana kolekcja elementów DocumentClassifierDetails |
Warning |
Obiekt błędu. |
AzureBlobContentSource
Azure Blob Storage zawartości.
Nazwa | Typ | Opis |
---|---|---|
containerUrl |
string |
Azure Blob Storage adres URL kontenera. |
prefix |
string |
Prefiks nazwy obiektu blob. |
AzureBlobFileListContentSource
Lista plików w Azure Blob Storage.
Nazwa | Typ | Opis |
---|---|---|
containerUrl |
string |
Azure Blob Storage adres URL kontenera. |
fileList |
string |
Ścieżka do pliku JSONL w kontenerze określającym podzestaw dokumentów. |
ClassifierDocumentTypeDetails
Informacje o typie dokumentu klasyfikatora.
Nazwa | Typ | Opis |
---|---|---|
azureBlobFileListSource |
Azure Blob Storage lista plików określająca dane treningowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource. |
|
azureBlobSource |
Azure Blob Storage lokalizacji zawierającej dane szkoleniowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource. |
|
sourceKind |
Typ źródła danych trenowania. |
ContentSourceKind
Typ źródła zawartości.
Nazwa | Typ | Opis |
---|---|---|
azureBlob |
string |
Pliki w ścieżce w kontenerze Azure Blob Storage. |
azureBlobFileList |
string |
Lista plików określająca poszczególne pliki w kontenerze Azure Blob Storage. |
base64 |
string |
Zawartość reprezentowana za pomocą kodowania Base64. |
url |
string |
Zawartość pod określonym adresem URL. |
DocumentClassifierDetails
Informacje o klasyfikatorze dokumentu.
Nazwa | Typ | Opis |
---|---|---|
apiVersion |
string |
Wersja interfejsu API używana do tworzenia klasyfikatora dokumentów. |
baseClassifierId |
string |
Base classifierId, na podstawie którego klasyfikator został wytrenowany. |
classifierId |
string |
Unikatowa nazwa klasyfikatora dokumentu. |
createdDateTime |
string |
Data i godzina (UTC) utworzenia klasyfikatora dokumentów. |
description |
string |
Opis klasyfikatora dokumentu. |
docTypes |
<string,
Classifier |
Lista typów dokumentów do klasyfikowania. |
expirationDateTime |
string |
Data i godzina (UTC), kiedy klasyfikator dokumentu wygaśnie. |
warnings |
Warning[] |
Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora. |
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 |
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 |
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 |
Błąd wewnętrzny. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
PagedDocumentClassifierDetails
Stronicowana kolekcja elementów DocumentClassifierDetails
Nazwa | Typ | Opis |
---|---|---|
nextLink |
string |
Link do następnej strony elementów |
value |
Elementy DocumentClassifierDetails na tej stronie |
Warning
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. |