Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Skapar en anpassad dokumentklassificerare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	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 dokumentklassificerarenamn.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Lista över dokumenttyper att klassificera mot.
baseClassifierId		string	Base classifierId ovanpå vilken 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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

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

Exempel

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

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.
Error	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.

AzureBlobContentSource

Azure Blob Storage innehåll.

Name	Typ	Description
containerUrl	string	Azure Blob Storage container-URL.
prefix	string	Blobnamnprefix.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

Name	Typ	Description
containerUrl	string	Azure Blob Storage container-URL.
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	Description
baseClassifierId	string	Base classifierId ovanpå vilken klassificeraren ska tränas.
classifierId	string	Unikt dokumentklassificerarenamn.
description	string	Beskrivning av dokumentklassificerare.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista över dokumenttyper att klassificera mot.

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage fillista som anger träningsdata för en klassificerardokumenttyp. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage plats som innehåller träningsdata för en dokumenttyp för klassificeraren. 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.

Error

Felobjektet.

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

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

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

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	InnerError	Inre fel.
message	string	En läsbar återgivning av felet.