Document Classifiers - List Classifiers

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Wyświetl listę wszystkich klasyfikatorów dokumentów.

GET {endpoint}/documentintelligence/documentClassifiers?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	PagedDocumentClassifierDetails	Żą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 Classifiers

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "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-11-30",
      "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
AzureBlobContentSource	Zawartość usługi Azure Blob Storage.
AzureBlobFileListContentSource	Lista plików w usłudze Azure Blob Storage.
ClassifierDocumentTypeDetails	Informacje o typie dokumentu klasyfikatora.
ContentSourceKind	Typ źródła zawartości.
DocumentClassifierDetails	Informacje klasyfikatora dokumentów.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
DocumentIntelligenceWarning	Obiekt błędu.
PagedDocumentClassifierDetails	Stronicowana kolekcja elementów DocumentClassifierDetails

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.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

Nazwa	Typ	Opis
azureBlobFileListSource	AzureBlobFileListContentSource	Lista plików usługi Azure Blob Storage określająca dane szkoleniowe dla klasyfikatora typu dokumentu. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Lokalizacja usługi Azure Blob Storage zawierająca dane szkoleniowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.
sourceKind	ContentSourceKind	Typ źródła danych trenowania.

ContentSourceKind

Typ źródła zawartości.

Nazwa	Typ	Opis
azureBlob	string	Pliki w ścieżce w kontenerze usługi Azure Blob Storage.
azureBlobFileList	string	Lista plików określająca poszczególne pliki w kontenerze usługi Azure Blob Storage.
base64	string	Zawartość reprezentowana za pomocą kodowania Base64.
url	string	Zawartość pod określonym adresem URL.

DocumentClassifierDetails

Informacje klasyfikatora dokumentów.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API użyta do utworzenia tego klasyfikatora dokumentów.
baseClassifierId	string	Identyfikator klasyfikatora podstawowego, na podstawie którego został wytrenowany klasyfikator.
classifierId	string	Unikatowa nazwa klasyfikatora dokumentów.
createdDateTime	string	Data i godzina (UTC) utworzenia klasyfikatora dokumentów.
description	string	Opis klasyfikatora dokumentów.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista typów dokumentów do klasyfikowania.
expirationDateTime	string	Data i godzina (UTC), kiedy klasyfikator dokumentu wygaśnie.
modifiedDateTime	string	Data i godzina (UTC) ostatniej modyfikacji modelu dokumentu.
warnings	DocumentIntelligenceWarning[]	Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora.

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.

PagedDocumentClassifierDetails

Stronicowana kolekcja elementów DocumentClassifierDetails

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony elementów
value	DocumentClassifierDetails[]	Elementy DocumentClassifierDetails na tej stronie