Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
classifierId	True	string	Egyedi dokumentumosztályozó neve.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Az osztályozandó dokumentumtípusok listája.
baseClassifierId		string	Alaposztályozóazonosító, amely fölött be kell tanítani az osztályozót.
description		string	Dokumentumosztályozó leírása.

Válaszok

Name	Típus	Description
202 Accepted		A kérést elfogadták feldolgozásra, de a feldolgozás még nem fejeződött be. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

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

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

Példák

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

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista Azure Blob Storage.
BuildDocumentClassifierRequest	Kérelemtörzs új egyéni dokumentumosztályozó létrehozásához.
ClassifierDocumentTypeDetails	Az osztályozó dokumentumtípusának adatai.
ContentSourceKind	A tartalomforrás típusa.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

AzureBlobContentSource

Azure Blob Storage tartalmat.

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

AzureBlobFileListContentSource

Fájllista Azure Blob Storage.

Name	Típus	Description
containerUrl	string	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

Kérelemtörzs új egyéni dokumentumosztályozó létrehozásához.

Name	Típus	Description
baseClassifierId	string	Alaposztályozóazonosító, amely fölött be kell tanítani az osztályozót.
classifierId	string	Egyedi dokumentumosztályozó neve.
description	string	Dokumentumosztályozó leírása.
docTypes	<string,  ClassifierDocumentTypeDetails>	Az osztályozandó dokumentumtípusok listája.

ClassifierDocumentTypeDetails

Az osztályozó dokumentumtípusának adatai.

Name	Típus	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage fájllista, amely megadja az osztályozó dokumentumtípus betanítási adatait. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage osztályozó dokumentumtípus betanítási adatait tartalmazó hely. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
sourceKind	ContentSourceKind	A betanítási adatforrás típusa.

ContentSourceKind

A tartalomforrás típusa.

Name	Típus	Description
azureBlob	string	Fájlok egy Azure Blob Storage tárolóban lévő elérési úton.
azureBlobFileList	string	Egy Azure Blob Storage tároló egyes fájljait meghatározó fájllista.
base64	string	A Base64-kódolással ábrázolt tartalom.
url	string	Adott URL-címen lévő tartalom.

Error

A hibaobjektum.

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

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibaadatok.

InnerError

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

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.