Text Analysis Authoring - List Training Jobs
Elenchi i processi di training non scaduti creati per un progetto.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Nome del progetto da utilizzare. |
api-version
|
query | True |
string |
Versione API client. |
maxpagesize
|
query |
integer int32 |
Numero massimo di risorse da includere in una singola risposta. |
|
skip
|
query |
integer int32 |
Offset nella raccolta della prima risorsa da restituire. |
|
top
|
query |
integer int32 |
Numero massimo di risorse da restituire dalla raccolta. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Elenco dei processi di training. |
|
Other Status Codes |
Risposta di errore. |
Sicurezza
AADToken
Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.
Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.
è Authorization URL
specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni di Azure Active Directory.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
* L'utilizzo di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta account personali.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Una chiave di sottoscrizione per una risorsa del servizio linguistico.
Tipo:
apiKey
In:
header
Esempio
Successful List Training Jobs
Esempio di richiesta
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs?api-version=2023-04-01
Risposta di esempio
{
"value": [
{
"result": {
"modelLabel": "model1",
"trainingConfigVersion": "2022-05-01",
"trainingStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T15:45:06.8190649Z",
"endDateTime": "2022-04-18T15:47:19.2639682Z",
"status": "succeeded"
},
"evaluationStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T15:47:19.2734976Z",
"endDateTime": "2022-04-18T15:47:23.8378892Z",
"status": "succeeded"
}
},
"jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
"createdDateTime": "2022-04-18T15:44:44Z",
"lastUpdatedDateTime": "2022-04-18T15:47:50Z",
"expirationDateTime": "2022-04-25T15:44:44Z",
"status": "succeeded"
},
{
"result": {
"modelLabel": "model2",
"trainingConfigVersion": "2022-05-01",
"trainingStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T17:22:39.3663023Z",
"endDateTime": "2022-04-18T17:24:51.9440947Z",
"status": "succeeded"
},
"evaluationStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T17:24:51.9571747Z",
"endDateTime": "2022-04-18T17:24:58.1427823Z",
"status": "succeeded"
}
},
"jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000",
"createdDateTime": "2022-04-18T17:22:11Z",
"lastUpdatedDateTime": "2022-04-18T17:25:23Z",
"expirationDateTime": "2022-04-25T17:22:11Z",
"status": "succeeded"
},
{
"result": {
"modelLabel": "model2",
"trainingConfigVersion": "2022-05-01",
"trainingStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T17:44:41.388358Z",
"endDateTime": "2022-04-18T17:50:29.5675101Z",
"status": "succeeded"
},
"evaluationStatus": {
"percentComplete": 100,
"startDateTime": "2022-04-18T17:50:29.5808461Z",
"endDateTime": "2022-04-18T17:50:35.3482185Z",
"status": "succeeded"
}
},
"jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000",
"createdDateTime": "2022-04-18T17:44:04Z",
"lastUpdatedDateTime": "2022-04-18T17:51:11Z",
"expirationDateTime": "2022-04-25T17:44:04Z",
"status": "succeeded"
}
],
"nextLink": null
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Oggetto error. |
Error |
Codice di errore leggibile. |
Error |
Risposta di errore. |
Inner |
Codice di errore leggibile. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
Stato del processo. |
Text |
Rappresenta lo stato dettagliato di un'operazione secondaria di training. |
Text |
Rappresenta l'output di un processo di training. |
Text |
Rappresenta un elenco di processi di training recuperati. |
Text |
Rappresenta lo stato di un processo di training. |
Text |
Rappresenta un avviso rilevato durante l'esecuzione della richiesta. |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
code |
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. |
ErrorCode
Codice di errore leggibile.
Nome | Tipo | Descrizione |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
Risposta di errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
InnerErrorCode
Codice di errore leggibile.
Nome | Tipo | Descrizione |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
InnerErrorModel
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno dei set definiti dal server di codici di errore. |
|
details |
object |
Dettagli errore. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione degli errori. |
JobStatus
Stato del processo.
Nome | Tipo | Descrizione |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSubTrainingJobState
Rappresenta lo stato dettagliato di un'operazione secondaria di training.
Nome | Tipo | Descrizione |
---|---|---|
endDateTime |
string |
Rappresenta l'ora di fine. |
percentComplete |
integer |
Rappresenta la percentuale di avanzamento. |
startDateTime |
string |
Rappresenta l'ora di inizio. |
status |
Rappresenta lo stato dell'operazione secondaria. |
TextAnalysisAuthoringTrainingJobResult
Rappresenta l'output di un processo di training.
Nome | Tipo | Descrizione |
---|---|---|
estimatedEndDateTime |
string |
Rappresenta l'ora di fine della stima per il training e la valutazione. |
evaluationStatus |
Rappresenta lo stato di valutazione del modello. |
|
modelLabel |
string |
Rappresenta l'etichetta del modello con training. |
trainingConfigVersion |
string |
Rappresenta la versione di configurazione del training. |
trainingStatus |
Rappresenta lo stato del training del modello. |
TextAnalysisAuthoringTrainingJobs
Rappresenta un elenco di processi di training recuperati.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento alla pagina successiva. |
value |
Elenco di processi. |
TextAnalysisAuthoringTrainingJobState
Rappresenta lo stato di un processo di training.
Nome | Tipo | Descrizione |
---|---|---|
createdDateTime |
string |
Data di creazione del processo. |
errors |
Error[] |
Errori rilevati durante l'esecuzione del processo. |
expirationDateTime |
string |
Data di scadenza del processo. |
jobId |
string |
ID processo. |
lastUpdatedDateTime |
string |
Data dell'ultimo aggiornamento del processo. |
result |
Rappresenta il risultato dettagliato delle attività di training. |
|
status |
Stato del processo. |
|
warnings |
Avvisi rilevati durante l'esecuzione del processo. |
TextAnalysisAuthoringWarning
Rappresenta un avviso rilevato durante l'esecuzione della richiesta.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di avviso. |
message |
string |
Messaggio di avviso. |