Miscellaneous Operations - Get Document Classifier Build Operation

Service:

Azure AI Services

API Version:

2024-02-29-preview

Ottiene le informazioni sull'operazione.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
operationId	path	True	string	ID operazione
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 stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	DocumentClassifierBuildOperationDetails	La richiesta ha avuto esito positivo. Headers x-ms-client-request-id: string
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

Get Operation - Document Classifier Build

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-preview

Sample Response

Status code:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "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 contenuto.
DocumentClassifierBuildOperationDetails	Ottenere l'oggetto risposta operation.
DocumentClassifierDetails	Informazioni sul classificatore di documenti.
Error	Oggetto error.
ErrorResponse	Oggetto risposta errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
OperationKind	Tipo di operazione.
OperationStatus	Stato dell'operazione.
Warning	Oggetto error.

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.

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.

DocumentClassifierBuildOperationDetails

Ottenere l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string	Data e ora UTC al momento della creazione dell'operazione.
error	Error	Errore rilevato.
kind	string: documentClassifierBuild	Tipo di operazione.
lastUpdatedDateTime	string	Data e ora (UTC) quando lo stato è stato aggiornato.
operationId	string	ID operazione
percentCompleted	integer	Stato dell'operazione (0-100).
resourceLocation	string	URL della risorsa destinata a questa operazione.
result	DocumentClassifierDetails	Risultato dell'operazione al termine dell'operazione.
status	OperationStatus	Stato dell'operazione. notStarted, running, complete o failed
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

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 in cima al quale è stato eseguito il training del classificatore.
classifierId	string	Nome univoco del classificatore di documenti.
createdDateTime	string	Data e ora (UTC) quando è stato creato il classificatore di documenti.
description	string	Descrizione del classificatore del documento.
docTypes	<string,  ClassifierDocumentTypeDetails>	Elenco dei tipi di documento da classificare.
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 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.

OperationKind

Tipo di operazione.

Nome	Tipo	Descrizione
documentClassifierBuild	string	Creare un nuovo modello di classificatore personalizzato.
documentModelBuild	string	Creare un nuovo modello di documento personalizzato.
documentModelCompose	string	Comporre un nuovo modello di documento personalizzato dai modelli esistenti.
documentModelCopyTo	string	Copiare un modello di documento esistente in una risorsa, un'area o una sottoscrizione diverse.

OperationStatus

Stato dell'operazione.

Nome	Tipo	Descrizione
canceled	string	L'operazione è stata annullata.
completed	string	L'operazione è stata completata.
failed	string	L'operazione non è riuscita.
notStarted	string	L'operazione non è ancora stata avviata.
running	string	L'operazione è in corso.
succeeded	string	L'operazione è stata completata.

Warning

Oggetto error.

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