Document Classifiers - Build Classifier

Service:

Azure AI Services

API-versie:

2024-11-30

Hiermee wordt een aangepaste documentclassificatie gemaakt.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Het Eindpunt van de Document Intelligence-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unieke naam van documentclassificatie.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen die moeten worden geclassificeerd op basis van.
allowOverwrite		boolean	Toestaan dat een bestaande classificatie met dezelfde naam wordt overschreven.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Base classifierId bovenop waarvan de classificatie moet worden getraind.
description		string maxLength: 4096	Beschrijving van documentclassificatie.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Build Document Classifier

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage-inhoud.
AzureBlobFileListContentSource	Bestandslijst in Azure Blob Storage.
BuildDocumentClassifierRequest	Aanvraagtekst voor het bouwen van een nieuwe aangepaste documentclassificatie.
ClassifierDocumentTypeDetails	Informatie over het type classificatiedocument.
ContentSourceKind	Type inhoudsbron.
DocumentIntelligenceError	Het foutobject.
DocumentIntelligenceErrorResponse	Foutantwoordobject.
DocumentIntelligenceInnerError	Een object met meer specifieke informatie over de fout.

AzureBlobContentSource

Object

Azure Blob Storage-inhoud.

Name	Type	Description
containerUrl	string (uri)	Url van Azure Blob Storage-container.
prefix	string	Voorvoegsel van blobnaam.

AzureBlobFileListContentSource

Object

Bestandslijst in Azure Blob Storage.

Name	Type	Description
containerUrl	string (uri)	Url van Azure Blob Storage-container.
fileList	string	Pad naar een JSONL-bestand in de container die een subset van documenten opgeeft.

BuildDocumentClassifierRequest

Object

Aanvraagtekst voor het bouwen van een nieuwe aangepaste documentclassificatie.

Name	Type	Default value	Description
allowOverwrite	boolean	False	Toestaan dat een bestaande classificatie met dezelfde naam wordt overschreven.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Base classifierId bovenop waarvan de classificatie moet worden getraind.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Unieke naam van documentclassificatie.
description	string maxLength: 4096		Beschrijving van documentclassificatie.
docTypes	<string,  ClassifierDocumentTypeDetails>		Lijst met documenttypen die moeten worden geclassificeerd op basis van.

ClassifierDocumentTypeDetails

Object

Informatie over het type classificatiedocument.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lijst met Azure Blob Storage-bestanden waarin de trainingsgegevens voor een classificatiedocumenttype worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-locatie met de trainingsgegevens voor een classificatiedocumenttype. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
sourceKind	ContentSourceKind	Type trainingsgegevensbron.

ContentSourceKind

Inventarisatie

Type inhoudsbron.

Waarde	Description
azureBlob	Bestanden in een pad binnen een Azure Blob Storage-container.
azureBlobFileList	Een bestandslijst waarin afzonderlijke bestanden in een Azure Blob Storage-container worden opgegeven.
base64	Inhoud die wordt weergegeven via Base64-codering.
url	Inhoud op een specifieke URL.

DocumentIntelligenceError

Object

Het foutobject.

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

DocumentIntelligenceErrorResponse

Object

Foutantwoordobject.

Name	Type	Description
error	DocumentIntelligenceError	Foutinformatie.

DocumentIntelligenceInnerError

Object

Een object met meer specifieke informatie over de fout.

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