Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Compila un classificatore di documenti personalizzato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
classifierId	True	string	Nome univoco del classificatore di documenti.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Elenco dei tipi di documento da classificare.
baseClassifierId		string	ClassifierId di base su cui eseguire il training del classificatore.
description		string	Descrizione del classificatore del documento.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

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

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

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

Definizioni

Nome	Descrizione
AzureBlobContentSource	Archiviazione BLOB di Azure contenuto.
AzureBlobFileListContentSource	Elenco di file in Archiviazione BLOB di Azure.
BuildDocumentClassifierRequest	Richiedere il corpo per compilare un nuovo classificatore di documenti personalizzato.
ClassifierDocumentTypeDetails	Informazioni sul tipo di documento del classificatore.
ContentSourceKind	Tipo di origine contenuto.
Error	Oggetto error.
ErrorResponse	Oggetto risposta errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.

AzureBlobContentSource

Archiviazione BLOB di Azure contenuto.

Nome	Tipo	Descrizione
containerUrl	string	ARCHIVIAZIONE BLOB DI AZURE URL contenitore.
prefix	string	Prefisso del nome BLOB.

AzureBlobFileListContentSource

Elenco di file in Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string	ARCHIVIAZIONE BLOB DI AZURE URL contenitore.
fileList	string	Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti.

BuildDocumentClassifierRequest

Richiedere il corpo per compilare un nuovo classificatore di documenti personalizzato.

Nome	Tipo	Descrizione
baseClassifierId	string	ClassifierId di base su cui eseguire il training del classificatore.
classifierId	string	Nome univoco del classificatore di documenti.
description	string	Descrizione del classificatore del documento.
docTypes	<string,  ClassifierDocumentTypeDetails>	Elenco dei tipi di documento da classificare.

ClassifierDocumentTypeDetails

Informazioni sul tipo di documento del classificatore.

Nome	Tipo	Descrizione
azureBlobFileListSource	AzureBlobFileListContentSource	Archiviazione BLOB di Azure elenco di file che specifica i dati di training per un tipo di documento classificatore. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Archiviazione BLOB di Azure percorso contenente i dati di training per un tipo di documento classificatore. È necessario specificare azureBlobSource o azureBlobFileListSource.
sourceKind	ContentSourceKind	Tipo di origine dati di training.

ContentSourceKind

Tipo di origine contenuto.

Nome	Tipo	Descrizione
azureBlob	string	File in un percorso all'interno di un contenitore Archiviazione BLOB di Azure.
azureBlobFileList	string	Elenco di file che specifica singoli file in un contenitore di Archiviazione BLOB di Azure.
base64	string	Contenuto rappresentato tramite codifica Base64.
url	string	Contenuto in un URL specifico.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	InnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.