Document Classifiers - Build Classifier

Szolgáltatás:

Azure AI Services

API-verzió:

2024-11-30

Egyéni dokumentumosztályozót hoz létre.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Egyedi dokumentumosztályozó neve.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Az osztályozandó dokumentumtípusok listája.
allowOverwrite		boolean	Meglévő osztályozó felülírásának engedélyezése ugyanazzal a névvel.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Alaposztályozóazonosító, amelyen az osztályozó betanítása.
description		string maxLength: 4096	A dokumentumosztályozó leírása.

Válaszok

Name	Típus	Description
202 Accepted		A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be. Fejlécek Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

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

Példák

Build Document Classifier

Mintakérelem

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

Mintaválasz

Állapotkód:

202

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

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage-tartalom.
AzureBlobFileListContentSource	Fájllista az Azure Blob Storage-ban.
BuildDocumentClassifierRequest	Kérje meg a törzset, hogy hozzon létre egy új egyéni dokumentumosztályozót.
ClassifierDocumentTypeDetails	Osztályozó dokumentumtípus-információi.
ContentSourceKind	A tartalomforrás típusa.
DocumentIntelligenceError	A hibaobjektum.
DocumentIntelligenceErrorResponse	Hibaválasz-objektum.
DocumentIntelligenceInnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról.

AzureBlobContentSource

Objektum

Azure Blob Storage-tartalom.

Name	Típus	Description
containerUrl	string (uri)	Az Azure Blob Storage tároló URL-címe.
prefix	string	Blobnév előtagja.

AzureBlobFileListContentSource

Objektum

Fájllista az Azure Blob Storage-ban.

Name	Típus	Description
containerUrl	string (uri)	Az Azure Blob Storage tároló URL-címe.
fileList	string	Egy JSONL-fájl elérési útja a tárolóban, amely a dokumentumok egy részhalmazát adja meg.

BuildDocumentClassifierRequest

Objektum

Kérje meg a törzset, hogy hozzon létre egy új egyéni dokumentumosztályozót.

Name	Típus	Alapértelmezett érték	Description
allowOverwrite	boolean	False	Meglévő osztályozó felülírásának engedélyezése ugyanazzal a névvel.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Alaposztályozóazonosító, amelyen az osztályozó betanítása.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Egyedi dokumentumosztályozó neve.
description	string maxLength: 4096		A dokumentumosztályozó leírása.
docTypes	<string,  ClassifierDocumentTypeDetails>		Az osztályozandó dokumentumtípusok listája.

ClassifierDocumentTypeDetails

Objektum

Osztályozó dokumentumtípus-információi.

Name	Típus	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Az Osztályozó dokumentumtípus betanítási adatait meghatározó Azure Blob Storage-fájllista. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
azureBlobSource	AzureBlobContentSource	Az Osztályozó dokumentumtípus betanítási adatait tartalmazó Azure Blob Storage-hely. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
sourceKind	ContentSourceKind	A betanítási adatforrás típusa.

ContentSourceKind

Enumerálás

A tartalomforrás típusa.

Érték	Description
azureBlob	Egy Azure Blob Storage-tároló elérési útjának fájljai.
azureBlobFileList	Egy Azure Blob Storage-tároló egyes fájljait meghatározó fájllista.
base64	A Base64 kódolása által képviselt tartalom.
url	Adott URL-címen lévő tartalom.

DocumentIntelligenceError

Objektum

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	DocumentIntelligenceError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	DocumentIntelligenceInnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

DocumentIntelligenceErrorResponse

Objektum

Hibaválasz-objektum.

Name	Típus	Description
error	DocumentIntelligenceError	Hibainformációk.

DocumentIntelligenceInnerError

Objektum

Egy objektum, amely részletesebb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	DocumentIntelligenceInnerError	Belső hiba.
message	string	A hiba ember által olvasható ábrázolása.