Text Analysis Authoring - Get Training Status

Riferimento

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Ottiene lo stato per un processo di training.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ID processo.
projectName	path	True	string	Nome del progetto da usare.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringTrainingJobState	Risultato del processo di training.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Quando è associato 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 basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. 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 riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di 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 dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli account Personali.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio lingua.

Type: apiKey
In: header

Esempio

Successful Get Train Status

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Stato del processo.
TextAnalysisAuthoringSubTrainingJobState	Rappresenta lo stato dettagliato di un'operazione secondaria di training.
TextAnalysisAuthoringTrainingJobResult	Rappresenta l'output di un processo di training.
TextAnalysisAuthoringTrainingJobState	Rappresenta lo stato di un processo di training.
TextAnalysisAuthoringWarning	Rappresenta un avviso rilevato durante l'esecuzione della richiesta.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	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	InnerErrorModel	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 dall'utente.

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	Error	Oggetto error.

InnerErrorCode

Codice di errore leggibile dall'utente.

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 per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli degli errori.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

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 della data di fine.
percentComplete	integer	Rappresenta la percentuale di avanzamento.
startDateTime	string	Rappresenta l'ora della data di inizio.
status	JobStatus	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	TextAnalysisAuthoringSubTrainingJobState	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	TextAnalysisAuthoringSubTrainingJobState	Rappresenta lo stato del training del modello.

TextAnalysisAuthoringTrainingJobState

Rappresenta lo stato di un processo di training.

Nome	Tipo	Descrizione
createdDateTime	string	Data di creazione del processo.
errors	Error[]	Gli errori riscontrati durante l'esecuzione del processo.
expirationDateTime	string	Data di scadenza del processo.
jobId	string	ID processo.
lastUpdatedDateTime	string	L'ultima data di aggiornamento del processo.
result	TextAnalysisAuthoringTrainingJobResult	Rappresenta i risultati dettagliati delle attività di training.
status	JobStatus	Stato del processo.
warnings	TextAnalysisAuthoringWarning[]	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.