Document Classifiers - Build Classifier

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Tworzy niestandardowy klasyfikator dokumentów.

POST {endpoint}/documentintelligence/documentClassifiers:build?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 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikatowa nazwa klasyfikatora dokumentów.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista typów dokumentów do klasyfikowania.
allowOverwrite		boolean	Zezwalaj na zastępowanie istniejącego klasyfikatora o tej samej nazwie.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Identyfikator klasyfikatora podstawowego, na którym należy wytrenować klasyfikator.
description		string maxLength: 4096	Opis klasyfikatora dokumentów.

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

Build Document Classifier

Przykładowe żądanie

HTTP

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

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

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
AzureBlobContentSource	Zawartość usługi Azure Blob Storage.
AzureBlobFileListContentSource	Lista plików w usłudze Azure Blob Storage.
BuildDocumentClassifierRequest	Treść żądania utworzenia nowego niestandardowego klasyfikatora dokumentów.
ClassifierDocumentTypeDetails	Informacje o typie dokumentu klasyfikatora.
ContentSourceKind	Typ źródła zawartości.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.

AzureBlobContentSource

Objekt

Zawartość usługi Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string (uri)	Adres URL kontenera usługi Azure Blob Storage.
prefix	string	Prefiks nazwy obiektu blob.

AzureBlobFileListContentSource

Objekt

Lista plików w usłudze Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string (uri)	Adres URL kontenera usługi Azure Blob Storage.
fileList	string	Ścieżka do pliku JSONL w kontenerze określającym podzbiór dokumentów.

BuildDocumentClassifierRequest

Objekt

Treść żądania utworzenia nowego niestandardowego klasyfikatora dokumentów.

Nazwa	Typ	Domyślna wartość	Opis
allowOverwrite	boolean	False	Zezwalaj na zastępowanie istniejącego klasyfikatora o tej samej nazwie.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Identyfikator klasyfikatora podstawowego, na którym należy wytrenować klasyfikator.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Unikatowa nazwa klasyfikatora dokumentów.
description	string maxLength: 4096		Opis klasyfikatora dokumentów.
docTypes	<string,  ClassifierDocumentTypeDetails>		Lista typów dokumentów do klasyfikowania.

ClassifierDocumentTypeDetails

Objekt

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

Wyliczanie

Typ źródła zawartości.

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

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.