Document Classifiers - Get Classifier

Servizio:

Azure AI Services

Versione API:

2024-11-30

Ottiene informazioni dettagliate sul classificatore di documenti.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-11-30

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
classifierId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome univoco del classificatore di documenti.
endpoint	path	True	string (uri)	Endpoint del servizio Document Intelligence.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	DocumentClassifierDetails	La richiesta ha avuto esito positivo. Intestazioni x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

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

Esempio

Get Document Classifier

Esempio di richiesta

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-11-30

Risposta di esempio

Codice di stato:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Definizioni

Nome	Descrizione
AzureBlobContentSource	Contenuto di Archiviazione BLOB di Azure.
AzureBlobFileListContentSource	Elenco di file in Archiviazione BLOB di Azure.
ClassifierDocumentTypeDetails	Informazioni sul tipo di documento del classificatore.
ContentSourceKind	Tipo di origine del contenuto.
DocumentClassifierDetails	Informazioni sul classificatore di documenti.
DocumentIntelligenceError	Oggetto error.
DocumentIntelligenceErrorResponse	Oggetto risposta di errore.
DocumentIntelligenceInnerError	Oggetto contenente informazioni più specifiche sull'errore.
DocumentIntelligenceWarning	Oggetto error.

AzureBlobContentSource

Object

Contenuto di Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string (uri)	URL del contenitore di Archiviazione BLOB di Azure.
prefix	string	Prefisso del nome BLOB.

AzureBlobFileListContentSource

Object

Elenco di file in Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string (uri)	URL del contenitore di Archiviazione BLOB di Azure.
fileList	string	Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti.

ClassifierDocumentTypeDetails

Object

Informazioni sul tipo di documento del classificatore.

Nome	Tipo	Descrizione
azureBlobFileListSource	AzureBlobFileListContentSource	Elenco di file di Archiviazione BLOB di Azure che specifica i dati di training per un tipo di documento classificatore. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Percorso di Archiviazione BLOB di Azure 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

Enumerazione

Tipo di origine del contenuto.

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

DocumentClassifierDetails

Object

Informazioni sul classificatore di documenti.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questo classificatore di documenti.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	ClassifierId di base su cui è stato eseguito il training del classificatore.
classifierId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome univoco del classificatore di documenti.
createdDateTime	string (date-time)	Data e ora (UTC) in cui è stato creato il classificatore di documenti.
description	string maxLength: 4096	Descrizione del classificatore di documenti.
docTypes	<string,  ClassifierDocumentTypeDetails>	Elenco dei tipi di documento da classificare in base a .
expirationDateTime	string (date-time)	Data e ora (UTC) alla scadenza del classificatore di documenti.
modifiedDateTime	string (date-time)	Data e ora (UTC) dell'ultima modifica del modello di documento.
warnings	DocumentIntelligenceWarning[]	Elenco di avvisi rilevati durante la compilazione del classificatore.

DocumentIntelligenceError

Object

Oggetto error.

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

DocumentIntelligenceErrorResponse

Object

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	DocumentIntelligenceError	Informazioni sull'errore.

DocumentIntelligenceInnerError

Object

Oggetto contenente informazioni più specifiche sull'errore.

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

DocumentIntelligenceWarning

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di avviso.
message	string	Rappresentazione leggibile dell'avviso.
target	string	Destinazione dell'errore.