Condividi tramite

Miscellaneous Operations - Get Document Classifier Build Operation

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-11-30

Ottiene le informazioni sull'operazione.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-11-30

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

uri

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 di 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.

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 Operation - Document Classifier Build

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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-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.
DocumentClassifierBuildOperationDetails

Ottiene l'oggetto risposta operation.
DocumentClassifierDetails

Informazioni sul classificatore di documenti.
DocumentIntelligenceError

Oggetto error.
DocumentIntelligenceErrorResponse

Oggetto risposta di errore.
DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.
DocumentIntelligenceOperationStatus

Stato dell'operazione.
DocumentIntelligenceWarning

Oggetto error.
OperationKind

Tipo di operazione.

AzureBlobContentSource

Contenuto di Archiviazione BLOB di Azure.

Nome Tipo Descrizione
containerUrl

string

URL del contenitore di Archiviazione BLOB di Azure.
prefix

string

Prefisso del nome BLOB.

AzureBlobFileListContentSource

Elenco di file in Archiviazione BLOB di Azure.

Nome Tipo Descrizione
containerUrl

string

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

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

Tipo di origine del contenuto.

Nome Tipo Descrizione
azureBlob

string

File in un percorso all'interno di un contenitore di 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

Ottiene l'oggetto risposta operation.

Nome Tipo Descrizione
apiVersion

string

Versione dell'API usata per creare questa operazione.
createdDateTime

string

Data e ora (UTC) alla creazione dell'operazione.
error

DocumentIntelligenceError

Errore rilevato.
kind string:

documentClassifierBuild

Tipo di operazione.
lastUpdatedDateTime

string

Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId

string

ID operazione
percentCompleted

integer

Stato dell'operazione (0-100).
resourceLocation

string

URL della risorsa di destinazione di questa operazione.
result

DocumentClassifierDetails

Risultato dell'operazione al termine dell'operazione.
status

DocumentIntelligenceOperationStatus

Stato dell'operazione. notStarted, running, completed 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 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.
modifiedDateTime

string

Data e ora (UTC) dell'ultima modifica del modello di documento.
warnings

DocumentIntelligenceWarning[]

Elenco di avvisi rilevati durante la compilazione del classificatore.

DocumentIntelligenceError

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

Oggetto risposta di errore.

Nome Tipo Descrizione
error

DocumentIntelligenceError

Informazioni sull'errore.

DocumentIntelligenceInnerError

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.

DocumentIntelligenceOperationStatus

Stato dell'operazione.

Nome Tipo Descrizione
canceled

string

L'operazione è stata annullata.
failed

string

L'operazione non è riuscita.
notStarted

string

L'operazione non è ancora stata avviata.
running

string

L'operazione è in corso.
skipped

string

L'operazione è stata ignorata.
succeeded

string

Operazione completata.

DocumentIntelligenceWarning

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.

OperationKind

Tipo di operazione.

Nome Tipo Descrizione
documentClassifierBuild

string

Creare un nuovo modello di classificatore personalizzato.
documentClassifierCopyTo

string

Copiare un classificatore di documenti esistente in una risorsa, un'area o una sottoscrizione diversa.
documentModelBuild

string

Creare un nuovo modello di documento personalizzato.
documentModelCompose

string

Comporre un nuovo modello di documento personalizzato da modelli esistenti.
documentModelCopyTo

string

Copiare un modello di documento esistente in una risorsa, un'area o una sottoscrizione diversa.