Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Hiermee wordt een aangepaste documentclassificatie gemaakt.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Het eindpunt van de Document Intelligence-service.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
classifierId	True	string	Unieke naam voor documentclassificatie.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen voor classificatie.
baseClassifierId		string	Base classifierId waarop de classificatie moet worden getraind.
description		string	Beschrijving van documentclassificatie.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwacht foutbericht.

Beveiliging

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

Voorbeelden

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

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.
ContentSourceKind	Type inhoudsbron.
Error	Het foutobject.
ErrorResponse	Foutreactieobject.
InnerError	Een object met specifiekere informatie over de 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 wordt opgegeven.

BuildDocumentClassifierRequest

Aanvraagbody voor het bouwen van een nieuwe aangepaste documentclassificatie.

Name	Type	Description
baseClassifierId	string	Base classifierId waarop de classificatie moet worden getraind.
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.
sourceKind	ContentSourceKind	Type trainingsgegevensbron.

ContentSourceKind

Type inhoudsbron.

Name	Type	Description
azureBlob	string	Bestanden in een pad binnen een Azure Blob Storage container.
azureBlobFileList	string	Een bestandslijst met afzonderlijke bestanden in een Azure Blob Storage container.
base64	string	Inhoud die wordt weergegeven via Base64-codering.
url	string	Inhoud op een specifieke URL.

Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met specifiekere informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	InnerError	Interne fout.
message	string	Een door mensen leesbare weergave van de fout.