Document Classifiers - Build Classifier

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Vytvoří vlastní klasifikátor dokumentů.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod služby Document Intelligence
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Jedinečný název klasifikátoru dokumentu
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Seznam typů dokumentů, které se mají klasifikovat
allowOverwrite		boolean	Povolte přepsání existujícího klasifikátoru se stejným názvem.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Základní klasifikátorId nad kterým chcete vytrénovat klasifikátor.
description		string maxLength: 4096	Popis klasifikátoru dokumentu

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Build Document Classifier

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
AzureBlobContentSource	Obsah služby Azure Blob Storage
AzureBlobFileListContentSource	Seznam souborů ve službě Azure Blob Storage
BuildDocumentClassifierRequest	Text požadavku pro sestavení nového vlastního klasifikátoru dokumentů
ClassifierDocumentTypeDetails	Informace o typu dokumentu klasifikátoru
ContentSourceKind	Typ zdroje obsahu
DocumentIntelligenceError	Objekt chyby.
DocumentIntelligenceErrorResponse	Objekt odpovědi na chybu
DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace o chybě.

AzureBlobContentSource

Objekt

Obsah služby Azure Blob Storage

Name	Typ	Description
containerUrl	string (uri)	Adresa URL kontejneru služby Azure Blob Storage
prefix	string	Předpona názvu objektu blob

AzureBlobFileListContentSource

Objekt

Seznam souborů ve službě Azure Blob Storage

Name	Typ	Description
containerUrl	string (uri)	Adresa URL kontejneru služby Azure Blob Storage
fileList	string	Cesta k souboru JSONL v kontejneru určujícím podmnožinu dokumentů

BuildDocumentClassifierRequest

Objekt

Text požadavku pro sestavení nového vlastního klasifikátoru dokumentů

Name	Typ	Default value	Description
allowOverwrite	boolean	False	Povolte přepsání existujícího klasifikátoru se stejným názvem.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Základní klasifikátorId nad kterým chcete vytrénovat klasifikátor.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Jedinečný název klasifikátoru dokumentu
description	string maxLength: 4096		Popis klasifikátoru dokumentu
docTypes	<string,  ClassifierDocumentTypeDetails>		Seznam typů dokumentů, které se mají klasifikovat

ClassifierDocumentTypeDetails

Objekt

Informace o typu dokumentu klasifikátoru

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Seznam souborů Azure Blob Storage určující trénovací data pro typ dokumentu klasifikátoru Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Umístění služby Azure Blob Storage obsahující trénovací data pro typ dokumentu klasifikátoru Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
sourceKind	ContentSourceKind	Typ trénovacího zdroje dat

ContentSourceKind

Výčet

Typ zdroje obsahu

Hodnota	Description
url	Obsah na konkrétní adrese URL
base64	Obsah reprezentovaný kódováním Base64
azureBlob	Soubory v cestě v kontejneru Azure Blob Storage
azureBlobFileList	Seznam souborů určující jednotlivé soubory v kontejneru Azure Blob Storage.

DocumentIntelligenceError

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	DocumentIntelligenceError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

DocumentIntelligenceErrorResponse

Objekt

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	DocumentIntelligenceInnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.