Text Analysis Authoring - Get Export Status
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=2023-04-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Endpoint di Servizi cognitivi supportati, ad esempio https://.api.cognitiveservices.azure.com. |
job
|
path | True |
string |
ID processo. |
project
|
path | True |
string |
Nome del nuovo progetto. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
La richiesta ha avuto esito positivo. |
|
Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
Ocp-Apim-Subscription-Key
Tipo:
apiKey
In:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
URL token:
https://login.microsoftonline.com/common/oauth2/token
Ambiti
Nome | Descrizione |
---|---|
https://cognitiveservices.azure.com/.default |
Esempio
Successful Get Export Status
Esempio di richiesta
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01
Risposta di esempio
{
"resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-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. |
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 |
|
Text |
Rappresenta lo stato di un processo di esportazione. |
Text |
Rappresenta un avviso rilevato durante l'esecuzione della richiesta. |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
code |
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 |
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 di un set definito 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 errore. |
JobStatus
Nome | Tipo | Descrizione |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringExportProjectJobState
Rappresenta lo stato di un processo di esportazione.
Nome | Tipo | Descrizione |
---|---|---|
createdDateTime |
string |
Data di creazione del processo. |
errors |
Error[] |
Errori riscontrati durante l'esecuzione del processo. |
expirationDateTime |
string |
Data di scadenza del processo. |
jobId |
string |
ID processo. |
lastUpdatedDateTime |
string |
Data dell'ultimo aggiornamento del processo. |
resultUrl |
string |
URL da usare per scaricare il progetto esportato. |
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. |