Miscellaneous Operations - Get Operation

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-11-30

Ottiene le informazioni sull'operazione.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&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 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	DocumentIntelligenceOperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	La richiesta ha avuto esito positivo. Intestazioni x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

DocumentIntelligenceOperationDetails:

DocumentClassifierBuildOperationDetails
DocumentClassifierCopyToOperationDetails
DocumentModelBuildOperationDetails
DocumentModelComposeOperationDetails
DocumentModelCopyToOperationDetails

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

Esempio di richiesta

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getOperation&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": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-11-30"
  }
}

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.
DocumentAnalysisFeature	Funzionalità di analisi dei documenti da abilitare.
DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
DocumentClassifierBuildOperationDetails	Ottiene l'oggetto risposta operation.
DocumentClassifierCopyToOperationDetails	Ottiene l'oggetto risposta operation.
DocumentClassifierDetails	Informazioni sul classificatore di documenti.
DocumentFieldSchema	Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON.
DocumentFieldType	Tipo di dati semantico del valore del campo.
DocumentIntelligenceError	Oggetto error.
DocumentIntelligenceErrorResponse	Oggetto risposta di errore.
DocumentIntelligenceInnerError	Oggetto contenente informazioni più specifiche sull'errore.
DocumentIntelligenceOperationStatus	Stato dell'operazione.
DocumentIntelligenceWarning	Oggetto error.
DocumentModelBuildOperationDetails	Ottiene l'oggetto risposta operation.
DocumentModelComposeOperationDetails	Ottiene l'oggetto risposta operation.
DocumentModelCopyToOperationDetails	Ottiene l'oggetto risposta operation.
DocumentModelDetails	Informazioni sul modello di documento.
DocumentTypeDetails	Informazioni sul tipo di documento.
OperationKind	Tipo di operazione.
SplitMode	Comportamento di suddivisione dei file.

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
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.
base64	Contenuto rappresentato tramite codifica Base64.
url	Contenuto in un URL specifico.

DocumentAnalysisFeature

Enumerazione

Funzionalità di analisi dei documenti da abilitare.

Valore	Descrizione
barcodes	Abilitare il rilevamento dei codici a barre nel documento.
formulas	Abilitare il rilevamento delle espressioni matematiche nel documento.
keyValuePairs	Abilitare il rilevamento delle coppie chiave-valore generale (campi modulo) nel documento.
languages	Abilitare il rilevamento della lingua del contenuto del testo.
ocrHighResolution	Eseguire OCR con una risoluzione superiore per gestire i documenti con stampa fine.
queryFields	Abilitare l'estrazione di campi aggiuntivi tramite il parametro di query QueryFields.
styleFont	Abilitare il riconoscimento di vari stili di carattere.

DocumentBuildMode

Enumerazione

Modalità di compilazione del modello di documento personalizzato.

Valore	Descrizione
neural	Supportare documenti con modelli visivi diversi.
template	Eseguire la destinazione di documenti con modelli di oggetti visivi simili.

DocumentClassifierBuildOperationDetails

Object

Ottiene l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string (date-time)	Data e ora (UTC) alla creazione dell'operazione.
error	DocumentIntelligenceError	Errore rilevato.
kind	string: documentClassifierBuild	Tipo di operazione.
lastUpdatedDateTime	string (date-time)	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer (int32) minimum: 0 maximum: 100	Stato dell'operazione (0-100).
resourceLocation	string (uri)	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.

DocumentClassifierCopyToOperationDetails

Object

Ottiene l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string (date-time)	Data e ora (UTC) alla creazione dell'operazione.
error	DocumentIntelligenceError	Errore rilevato.
kind	string: documentClassifierCopyTo	Tipo di operazione.
lastUpdatedDateTime	string (date-time)	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer (int32) minimum: 0 maximum: 100	Stato dell'operazione (0-100).
resourceLocation	string (uri)	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

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.

DocumentFieldSchema

Object

Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON.

Nome	Tipo	Descrizione
description	string maxLength: 4096	Descrizione del campo.
example	string	Contenuto del campo di esempio.
items	DocumentFieldSchema	Schema del tipo di campo di ogni elemento della matrice.
properties	<string, DocumentFieldSchema>	Campi secondari denominati del campo oggetto.
type	DocumentFieldType	Tipo di dati semantico del valore del campo.

DocumentFieldType

Enumerazione

Tipo di dati semantico del valore del campo.

Valore	Descrizione
address	Indirizzo analizzato.
array	Elenco di campi secondari dello stesso tipo.
boolean	Valore booleano, normalizzato in true o false.
countryRegion	Paese/area geografica, normalizzato in formato ISO 3166-1 alfa-3 (ad esempio USA).
currency	Importo valuta con simbolo di valuta e unità facoltativi.
date	Data, normalizzata in formato ISO 8601 (AAAA-MM-DD).
integer	Numero intero normalizzato in intero con segno a 64 bit.
number	Numero a virgola mobile normalizzato in virgola mobile a precisione doppia.
object	Elenco denominato di sottocampi di tipi potenzialmente diversi.
phoneNumber	Numero di telefono normalizzato in formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	Matrice di valori stringa selezionati.
selectionMark	Il campo è selezionato?
signature	La firma è presente?
string	Testo normale.
time	Ora normalizzata in formato ISO 8601 (hh:mm:ss).

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.

DocumentIntelligenceOperationStatus

Enumerazione

Stato dell'operazione.

Valore	Descrizione
canceled	L'operazione è stata annullata.
failed	L'operazione non è riuscita.
notStarted	L'operazione non è ancora stata avviata.
running	L'operazione è in corso.
skipped	L'operazione è stata ignorata.
succeeded	Operazione completata.

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.

DocumentModelBuildOperationDetails

Object

Ottiene l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string (date-time)	Data e ora (UTC) alla creazione dell'operazione.
error	DocumentIntelligenceError	Errore rilevato.
kind	string: documentModelBuild	Tipo di operazione.
lastUpdatedDateTime	string (date-time)	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer (int32) minimum: 0 maximum: 100	Stato dell'operazione (0-100).
resourceLocation	string (uri)	URL della risorsa di destinazione di questa operazione.
result	DocumentModelDetails	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.

DocumentModelComposeOperationDetails

Object

Ottiene l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string (date-time)	Data e ora (UTC) alla creazione dell'operazione.
error	DocumentIntelligenceError	Errore rilevato.
kind	string: documentModelCompose	Tipo di operazione.
lastUpdatedDateTime	string (date-time)	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer (int32) minimum: 0 maximum: 100	Stato dell'operazione (0-100).
resourceLocation	string (uri)	URL della risorsa di destinazione di questa operazione.
result	DocumentModelDetails	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.

DocumentModelCopyToOperationDetails

Object

Ottiene l'oggetto risposta operation.

Nome	Tipo	Descrizione
apiVersion	string	Versione dell'API usata per creare questa operazione.
createdDateTime	string (date-time)	Data e ora (UTC) alla creazione dell'operazione.
error	DocumentIntelligenceError	Errore rilevato.
kind	string: documentModelCopyTo	Tipo di operazione.
lastUpdatedDateTime	string (date-time)	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
operationId	string	ID operazione
percentCompleted	integer (int32) minimum: 0 maximum: 100	Stato dell'operazione (0-100).
resourceLocation	string (uri)	URL della risorsa di destinazione di questa operazione.
result	DocumentModelDetails	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.

DocumentModelDetails

Object

Informazioni sul modello di documento.

Nome	Tipo	Valore predefinito	Descrizione
apiVersion	string		Versione dell'API usata per creare questo modello di documento.
azureBlobFileListSource	AzureBlobFileListContentSource		Elenco di file di Archiviazione BLOB di Azure che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Percorso di Archiviazione BLOB di Azure contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modalità di compilazione del modello di documento personalizzato.
classifierId	string		Per i modelli composti, il classificatore personalizzato per suddividere e classificare il file di input.
createdDateTime	string (date-time)		Data e ora (UTC) di creazione del modello di documento.
description	string maxLength: 4096		Descrizione del modello di documento.
docTypes	<string, DocumentTypeDetails>		Tipi di documento supportati.
expirationDateTime	string (date-time)		Data e ora (UTC) alla scadenza del modello di documento.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nome univoco del modello di documento.
modifiedDateTime	string (date-time)		Data e ora (UTC) dell'ultima modifica del modello di documento.
split	SplitMode	none	Per i modelli composti, il comportamento di suddivisione dei file.
tags	object		Elenco degli attributi di tag chiave-valore associati al modello di documento.
trainingHours	number (float)		Numero di ore GPU equivalenti V100 utilizzate per il training del modello.
warnings	DocumentIntelligenceWarning[]		Elenco di avvisi rilevati durante la compilazione del modello.

DocumentTypeDetails

Object

Informazioni sul tipo di documento.

Nome	Tipo	Descrizione
buildMode	DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
confidenceThreshold	number (float)	Eseguire l'analisi solo se l'attendibilità docType è superiore alla soglia.
description	string maxLength: 4096	Descrizione del modello di documento.
features	DocumentAnalysisFeature[]	Elenco delle funzionalità di analisi facoltative.
fieldConfidence	object	Attendibilità stimata per ogni campo.
fieldSchema	<string, DocumentFieldSchema>	Descrizione dello schema semantico del documento usando una sintassi dello stile dello schema JSON.
maxDocumentsToAnalyze	integer (int32)	Numero massimo di documenti di tipo specificato da analizzare. Default=all.
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Modello di documento da usare per l'analisi dei documenti con tipo specificato.
queryFields	string[]	Elenco di campi aggiuntivi da estrarre. Ex. "NumberOfGuests,StoreNumber"

OperationKind

Enumerazione

Tipo di operazione.

Valore	Descrizione
documentClassifierBuild	Creare un nuovo modello di classificatore personalizzato.
documentClassifierCopyTo	Copiare un classificatore di documenti esistente in una risorsa, un'area o una sottoscrizione diversa.
documentModelBuild	Creare un nuovo modello di documento personalizzato.
documentModelCompose	Comporre un nuovo modello di documento personalizzato da modelli esistenti.
documentModelCopyTo	Copiare un modello di documento esistente in una risorsa, un'area o una sottoscrizione diversa.

SplitMode

Enumerazione

Comportamento di suddivisione dei file.

Valore	Descrizione
auto	Suddividere automaticamente il file in documenti.
none	Considerare l'intero file come un singolo documento.
perPage	Considera ogni pagina del file come documento separato.

Condividi tramite

Miscellaneous Operations - Get Operation

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Get Operation

Esempio di richiesta

Risposta di esempio

Definizioni

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentAnalysisFeature

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierCopyToOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceOperationStatus

DocumentIntelligenceWarning

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

OperationKind

SplitMode