Document Classifiers - Build Classifier

Tjänst:

Azure AI Services

API-version:

2024-11-30

Skapar en anpassad dokumentklassificerare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Slutpunkten för document intelligence-tjänsten.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
classifierId	True	string	Unikt namn på dokumentklassificerare.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista över dokumenttyper som ska klassificeras mot.
allowOverwrite		boolean	Tillåt överskrivning av en befintlig klassificerare med samma namn.
baseClassifierId		string	Base classifierId ovanpå vilket klassificeraren ska tränas.
description		string	Beskrivning av dokumentklassificerare.

Svar

Name	Typ	Description
202 Accepted		Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Build Document Classifier

Exempelbegäran

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
AzureBlobContentSource	Azure Blob Storage-innehåll.
AzureBlobFileListContentSource	Fillista i Azure Blob Storage.
BuildDocumentClassifierRequest	Begär brödtext för att skapa en ny anpassad dokumentklassificerare.
ClassifierDocumentTypeDetails	Information om dokumenttyp för klassificerare.
ContentSourceKind	Typ av innehållskälla.
DocumentIntelligenceError	Felobjektet.
DocumentIntelligenceErrorResponse	Felsvarsobjekt.
DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information om felet.

AzureBlobContentSource

Azure Blob Storage-innehåll.

Name	Typ	Description
containerUrl	string	Url för Azure Blob Storage-container.
prefix	string	Prefix för blobnamn.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

Name	Typ	Description
containerUrl	string	Url för Azure Blob Storage-container.
fileList	string	Sökväg till en JSONL-fil i containern som anger en delmängd av dokument.

BuildDocumentClassifierRequest

Begär brödtext för att skapa en ny anpassad dokumentklassificerare.

Name	Typ	Standardvärde	Description
allowOverwrite	boolean	False	Tillåt överskrivning av en befintlig klassificerare med samma namn.
baseClassifierId	string		Base classifierId ovanpå vilket klassificeraren ska tränas.
classifierId	string		Unikt namn på dokumentklassificerare.
description	string		Beskrivning av dokumentklassificerare.
docTypes	<string,  ClassifierDocumentTypeDetails>		Lista över dokumenttyper som ska klassificeras mot.

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage-fillista som anger träningsdata för en dokumenttyp för klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-plats som innehåller träningsdata för en dokumenttyp för klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
sourceKind	ContentSourceKind	Typ av träningsdatakälla.

ContentSourceKind

Typ av innehållskälla.

Name	Typ	Description
azureBlob	string	Filer i en sökväg i en Azure Blob Storage-container.
azureBlobFileList	string	En fillista som anger enskilda filer i en Azure Blob Storage-container.
base64	string	Innehåll som representeras via Base64-kodning.
url	string	Innehåll på en specifik URL.

DocumentIntelligenceError

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	DocumentIntelligenceError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	DocumentIntelligenceInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

DocumentIntelligenceErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	DocumentIntelligenceError	Felinformation.

DocumentIntelligenceInnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	DocumentIntelligenceInnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.