Miscellaneous Operations - Get Operation

Servizio:

Azure AI Services

Versione API:

2024-07-31-preview

Ottiene le informazioni sull'operazione.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-07-31-preview

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	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	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 Operation

Esempio di richiesta

HTTP

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

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-07-31-preview"
  }
}

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.
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.
Error	Oggetto error.
ErrorResponse	Oggetto risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
OperationKind	Tipo di operazione.
OperationStatus	Stato dell'operazione.
SplitMode	Comportamento di suddivisione dei file.
Warning	Oggetto error.

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.

DocumentAnalysisFeature

Funzionalità di analisi dei documenti da abilitare.

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

DocumentBuildMode

Modalità di compilazione del modello di documento personalizzato.

Nome	Tipo	Descrizione
generative	string	Abilitare documenti di tutti i tipi usando tecniche di intelligenza artificiale generative.
neural	string	Supportare documenti con modelli visivi diversi.
template	string	Eseguire la destinazione di documenti con modelli di oggetti visivi simili.

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	Error	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	OperationStatus	Stato dell'operazione. notStarted, running, completed o failed
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentClassifierCopyToOperationDetails

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	Error	Errore rilevato.
kind	string: documentClassifierCopyTo	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	OperationStatus	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.
warnings	Warning[]	Elenco di avvisi rilevati durante la compilazione del classificatore.

DocumentFieldSchema

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

Nome	Tipo	Descrizione
description	string	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

Tipo di dati semantico del valore del campo.

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

DocumentModelBuildOperationDetails

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	Error	Errore rilevato.
kind	string: documentModelBuild	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	DocumentModelDetails	Risultato dell'operazione al termine dell'operazione.
status	OperationStatus	Stato dell'operazione. notStarted, running, completed o failed
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentModelComposeOperationDetails

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	Error	Errore rilevato.
kind	string: documentModelCompose	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	DocumentModelDetails	Risultato dell'operazione al termine dell'operazione.
status	OperationStatus	Stato dell'operazione. notStarted, running, completed o failed
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentModelCopyToOperationDetails

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	Error	Errore rilevato.
kind	string: documentModelCopyTo	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	DocumentModelDetails	Risultato dell'operazione al termine dell'operazione.
status	OperationStatus	Stato dell'operazione. notStarted, running, completed o failed
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentModelDetails

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		Data e ora (UTC) di creazione del modello di documento.
description	string		Descrizione del modello di documento.
docTypes	<string,  DocumentTypeDetails>		Tipi di documento supportati.
expirationDateTime	string		Data e ora (UTC) alla scadenza del modello di documento.
modelId	string		Nome univoco 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		Numero di ore GPU equivalenti V100 utilizzate per il training del modello.
warnings	Warning[]		Elenco di avvisi rilevati durante la compilazione del modello.

DocumentTypeDetails

Informazioni sul tipo di documento.

Nome	Tipo	Descrizione
buildMode	DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
confidenceThreshold	number	Eseguire l'analisi solo se l'attendibilità docType è superiore alla soglia.
description	string	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	Numero massimo di documenti di tipo specificato da analizzare. Default=all.
modelId	string	Modello di documento da usare per l'analisi dei documenti con tipo specificato.
queryFields	string[]	Elenco di campi aggiuntivi da estrarre. Ex. "NumberOfGuests,StoreNumber"

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

OperationStatus

Stato dell'operazione.

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

SplitMode

Comportamento di suddivisione dei file.

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

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.