Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

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

POST {endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-07-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string url	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Az Azure Cognitive Services-előfizetés titkos kulcsa.

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.
description		string	Dokumentumosztályozó leírása.

Válaszok

Name	Típus	Description
202 Accepted		A kérés sikeresen várólistára van helyezve. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Az Azure Cognitive Services-előfizetés titkos kulcsa.

Type: apiKey
In: header

Példák

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista a Azure Blob Storage.
BuildDocumentClassifierRequest	Kérje meg a törzset, hogy hozzon létre egy új egyéni dokumentumosztályozót.
ClassifierDocumentTypeDetails	Osztályozó dokumentumtípusának adatai.
Error	Hibainformáció.
ErrorResponse	Hibaválasz-objektum.
InnerError	Részletes hiba.

AzureBlobContentSource

Azure Blob Storage tartalmat.

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

AzureBlobFileListContentSource

Fájllista a 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 betanításhoz szükséges dokumentumok egy részhalmazát adja meg.

BuildDocumentClassifierRequest

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

Name	Típus	Description
classifierId	string	Egyedi dokumentumosztályozó neve.
description	string	Dokumentumosztályozó leírása.
docTypes	<string,  ClassifierDocumentTypeDetails>	Az osztályozandó dokumentumtípusok listája.

ClassifierDocumentTypeDetails

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-t vagy az azureBlobFileListSource-t.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage osztályozó dokumentumtípus betanítási adatait tartalmazó helyet. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.

Error

Hibainformáció.

Name	Típus	Description
code	string	Hibakód.
details	Error[]	Részletes hibák listája.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibainformáció.

InnerError

Részletes hiba.

Name	Típus	Description
code	string	Hibakód.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.