Miscellaneous Operations - List Operations
Elenchi tutte le operazioni.
GET {endpoint}/documentintelligence/operations?api-version=2024-02-29-preview
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
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 stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
La richiesta ha avuto esito positivo. Headers x-ms-client-request-id: string |
|
Other Status Codes |
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 Operations
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-02-29-preview
Sample Response
{
"value": [
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "running",
"percentCompleted": 0,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:12:58Z",
"kind": "documentModelBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
"apiVersion": "2024-02-29-preview"
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}
Definizioni
Nome | Descrizione |
---|---|
Azure |
Archiviazione BLOB di Azure contenuto. |
Azure |
Elenco di file in Archiviazione BLOB di Azure. |
Classifier |
Informazioni sul tipo di documento del classificatore. |
Content |
Tipo di origine contenuto. |
Document |
Modalità di compilazione del modello di documento personalizzata. |
Document |
Ottiene l'oggetto risposta Operation. |
Document |
Informazioni sul classificatore di documenti. |
Document |
Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON. |
Document |
Tipo di dati semantico del valore del campo. |
Document |
Ottiene l'oggetto risposta Operation. |
Document |
Ottiene l'oggetto risposta Operation. |
Document |
Ottiene l'oggetto risposta Operation. |
Document |
Informazioni sul modello di documento. |
Document |
Informazioni sul tipo di documento. |
Error |
Oggetto error. |
Error |
Oggetto risposta di errore. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. |
Operation |
Tipo di operazione. |
Operation |
Stato dell'operazione. |
Paged |
Raccolta di pagine di elementi OperationDetails |
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 |
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 |
Archiviazione BLOB di Azure percorso contenente i dati di training per un tipo di documento classificatore. È necessario specificare azureBlobSource o azureBlobFileListSource. |
|
sourceKind |
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. |
DocumentBuildMode
Modalità di compilazione del modello di documento personalizzata.
Nome | Tipo | Descrizione |
---|---|---|
neural |
string |
Supportare documenti con modelli visivi diversi. |
template |
string |
Visualizzare documenti di destinazione con modelli di oggetto visivo 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) di creazione dell'operazione. |
error |
Errore rilevato. |
|
kind |
string:
document |
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 |
Risultato dell'operazione al termine dell'operazione. |
|
status |
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,
Classifier |
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 campo. |
example |
string |
Contenuto del campo di esempio. |
items |
Schema del tipo di campo di ogni elemento della matrice. |
|
properties |
<string,
Document |
Campi secondari denominati del campo oggetto. |
type |
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 su 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 facoltativo e unità. |
date |
string |
Data, normalizzata in formato ISO 8601 (AAAA-MM-DD). |
integer |
string |
Numero intero normalizzato a intero con segno a 64 bit. |
number |
string |
Numero a virgola mobile normalizzato in virgola mobile doppia. |
object |
string |
Elenco denominato di campi secondari 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 |
Tempo normalizzato 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) di creazione dell'operazione. |
error |
Errore rilevato. |
|
kind |
string:
document |
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 |
Risultato dell'operazione al termine dell'operazione. |
|
status |
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) di creazione dell'operazione. |
error |
Errore rilevato. |
|
kind |
string:
document |
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 |
Risultato dell'operazione al termine dell'operazione. |
|
status |
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) di creazione dell'operazione. |
error |
Errore rilevato. |
|
kind |
string:
document |
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 |
Risultato dell'operazione al termine dell'operazione. |
|
status |
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 | Descrizione |
---|---|---|
apiVersion |
string |
Versione dell'API usata per creare questo modello di documento. |
azureBlobFileListSource |
Archiviazione BLOB di Azure elenco di file che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
|
azureBlobSource |
Archiviazione BLOB di Azure posizione contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
|
buildMode |
Modalità di compilazione del modello di documento personalizzato. |
|
createdDateTime |
string |
Data e ora (UTC) in cui è stato creato il modello di documento. |
description |
string |
Descrizione del modello di documento. |
docTypes |
<string,
Document |
Tipi di documento supportati. |
expirationDateTime |
string |
Data e ora (UTC) alla scadenza del modello di documento. |
modelId |
string |
Nome univoco del modello di documento. |
tags |
object |
Elenco degli attributi di tag chiave-valore associati al modello di documento. |
warnings |
Warning[] |
Elenco di avvisi rilevati durante la compilazione del modello. |
DocumentTypeDetails
Informazioni sul tipo di documento.
Nome | Tipo | Descrizione |
---|---|---|
buildMode |
Modalità di compilazione del modello di documento personalizzata. |
|
description |
string |
Descrizione del modello di documento. |
fieldConfidence |
object |
Attendibilità stimata per ogni campo. |
fieldSchema |
<string,
Document |
Descrizione dello schema semantico del documento usando una sintassi dello stile dello schema JSON. |
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 |
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 |
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 |
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 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 |
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. |
PagedOperationDetails
Raccolta di pagine di elementi OperationDetails
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento alla pagina successiva di elementi |
value | OperationDetails[]: |
Elementi OperationDetails in questa pagina |
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. |