Document Classifiers - Get Classifier

Servizio:

Azure AI Services

Versione API:

2024-02-29-preview

Ottiene informazioni dettagliate sul classificatore di documenti.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
classifierId	path	True	string	Nome univoco del classificatore di documenti. Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
api-version	query	True	string	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	ErrorResponse	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-02-29-preview

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-02-29-preview",
  "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	Archiviazione BLOB di Azure contenuto.
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.
Error	Oggetto error.
ErrorResponse	Oggetto risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
Warning	Oggetto error.

AzureBlobContentSource

Archiviazione BLOB di Azure contenuto.

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

AzureBlobFileListContentSource

Elenco di file in Archiviazione BLOB di Azure.

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

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 posizione 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 del 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 i singoli file in un contenitore Archiviazione BLOB di Azure.
base64	string	Contenuto rappresentato tramite codifica Base64.
url	string	Contenuto in corrispondenza di un URL specifico.

DocumentClassifierDetails

Informazioni sul classificatore di documenti.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questo classificatore di documenti.
baseClassifierId	string	ClassifierId di base su cui è stato eseguito il training del classificatore.
classifierId	string	Nome univoco del classificatore di documenti.
createdDateTime	string	Data e ora (UTC) in cui è stato creato il classificatore di documenti.
description	string	Descrizione del classificatore di documenti.
docTypes	<string,  ClassifierDocumentTypeDetails>	Elenco dei tipi di documento da classificare in base a .
expirationDateTime	string	Data e ora (UTC) alla scadenza del classificatore di documenti.
warnings	Warning[]	Elenco di avvisi rilevati durante la compilazione del classificatore.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo 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 di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sugli errori.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

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

Warning

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.