Text Analysis Authoring - Get Training Status

Ottiene lo stato di un processo di training.

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

Parametri dell'URI

Name In Required Type Description
Endpoint
path True
  • string

Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).

jobId
path True
  • string

ID processo.

projectName
path True
  • string

Nome del progetto da utilizzare.

api-version
query True
  • string

Versione API client.

Intestazione della richiesta

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Risposte

Name Type Description
200 OK

Risultato del processo di training.

Other Status Codes

Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Type: apiKey
In: header

Esempio

Successful Get Train Status

Sample Request

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

Sample Response

{
  "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

Error

Oggetto error.

ErrorCode

Codice di errore leggibile.

ErrorResponse

Risposta di errore.

InnerErrorCode

Codice di errore leggibile.

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.

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.

Name Type Description
code

Uno dei set definiti dal server di codici di errore.

details

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.

Name Type Description
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.

Name Type Description
error

Oggetto error.

InnerErrorCode

Codice di errore leggibile.

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.

TextAnalysisAuthoringTrainingJobState

Rappresenta lo stato di un processo di training.

Name Type Description
createdDateTime
  • string

Data di creazione del processo.

errors

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.

Name Type Description
code
  • string

Codice di avviso.

message
  • string

Messaggio di avviso.