Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Tworzy niestandardowy klasyfikator dokumentów.

POST {endpoint}/documentintelligence/documentClassifiers:build?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.

Treść żądania

Nazwa	Wymagane	Typ	Opis
classifierId	True	string	Unikatowa nazwa klasyfikatora dokumentów.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista typów dokumentów do klasyfikowania.
baseClassifierId		string	Identyfikator klasyfikatora podstawowego, na którym należy wytrenować klasyfikator.
description		string	Opis klasyfikatora dokumentów.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze zakończone. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

{
  "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"
      }
    }
  }
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

Definicje

Nazwa	Opis
AzureBlobContentSource	Azure Blob Storage zawartości.
AzureBlobFileListContentSource	Lista plików w 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.
Error	Obiekt error.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.

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.

BuildDocumentClassifierRequest

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

Nazwa	Typ	Opis
baseClassifierId	string	Identyfikator klasyfikatora podstawowego, na którym należy wytrenować klasyfikator.
classifierId	string	Unikatowa nazwa klasyfikatora dokumentów.
description	string	Opis klasyfikatora dokumentów.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista typów dokumentów do klasyfikowania.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

Nazwa	Typ	Opis
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage listę plików określającą dane szkoleniowe dla klasyfikatora typu dokumentu. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage lokalizacji zawierającej dane szkoleniowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.
sourceKind	ContentSourceKind	Typ źródła danych szkoleniowych.

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.

Error

Obiekt error.

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.