Text Analysis Authoring - Get Export Status

Servizio:

Azure AI Services

Versione API:

2022-05-01

Ottiene lo stato di un processo di esportazione. Al termine del processo, restituisce i metadati del progetto e gli asset.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}?api-version=2022-05-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).
jobId	path	True	string	ID processo.
projectName	path	True	string maxLength: 100	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave di sottoscrizione per una risorsa del servizio di linguaggio.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringExportProjectJobState	Stato dell'operazione a esecuzione prolungata.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio di linguaggio.

Tipo: apiKey
In: header

Esempio

Successful Get Export Status

Esempio di richiesta

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01

Risposta di esempio

Codice di stato:

200

{
  "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01",
  "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
  "createdDateTime": "2022-04-18T15:23:07Z",
  "lastUpdatedDateTime": "2022-04-18T15:23:08Z",
  "expirationDateTime": "2022-04-25T15:23:07Z",
  "status": "succeeded"
}

Definizioni

Nome	Descrizione
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.
TextAnalysisAuthoringExportProjectJobState	Rappresenta lo stato di un processo di esportazione.
TextAnalysisAuthoringWarning	Rappresenta un avviso rilevato durante l'esecuzione della richiesta.

Error

Object

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

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

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	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

JobStatus

Enumerazione

Stato del processo.

Valore	Descrizione
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Object

Rappresenta lo stato di un processo di esportazione.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Data di creazione del processo.
errors	Error[]	Errori riscontrati durante l'esecuzione del processo.
expirationDateTime	string (date-time)	Data di scadenza del processo.
jobId	string	ID processo.
lastUpdatedDateTime	string (date-time)	Data dell'ultimo aggiornamento del processo.
resultUrl	string	URL da usare per scaricare il progetto esportato.
status	JobStatus	Stato del processo.
warnings	TextAnalysisAuthoringWarning[]	Avvisi rilevati durante l'esecuzione del processo.

TextAnalysisAuthoringWarning

Object

Rappresenta un avviso rilevato durante l'esecuzione della richiesta.

Nome	Tipo	Descrizione
code	string	Codice di avviso.
message	string	Messaggio di avviso.