Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

Hiermee wordt een aangepaste documentclassificatie gemaakt.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Aanvraagbody

Name	Vereist	Type	Description
classifierId	True	string	Unieke naam voor documentclassificatie.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen voor classificatie.
description		string	Beschrijving van documentclassificatie.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is in de wachtrij geplaatst. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage inhoud.
AzureBlobFileListContentSource	Lijst met bestanden in Azure Blob Storage.
BuildDocumentClassifierRequest	Aanvraagbody voor het bouwen van een nieuwe aangepaste documentclassificatie.
ClassifierDocumentTypeDetails	Informatie over het type classificatiedocument.
Error	Foutinformatie.
ErrorResponse	Foutreactieobject.
InnerError	Gedetailleerde fout.

AzureBlobContentSource

Azure Blob Storage inhoud.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
prefix	string	Blobnaamvoorvoegsel.

AzureBlobFileListContentSource

Lijst met bestanden in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
fileList	string	Pad naar een JSONL-bestand in de container waarin een subset van documenten voor training wordt opgegeven.

BuildDocumentClassifierRequest

Aanvraagbody voor het bouwen van een nieuwe aangepaste documentclassificatie.

Name	Type	Description
classifierId	string	Unieke naam voor documentclassificatie.
description	string	Beschrijving van documentclassificatie.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen voor classificatie.

ClassifierDocumentTypeDetails

Informatie over het type classificatiedocument.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage bestandslijst waarin de trainingsgegevens voor een type classificatiedocument worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage locatie met de trainingsgegevens voor een type classificatiedocument. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.

Error

Foutinformatie.

Name	Type	Description
code	string	Foutcode.
details	Error[]	Lijst met gedetailleerde fouten.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.
target	string	Doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Gedetailleerde fout.

Name	Type	Description
code	string	Foutcode.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.