Text Analysis Authoring - Get Export Status

Služba:

Azure AI Services

Verze rozhraní API:

2022-05-01

Získá stav úlohy exportu. Po dokončení úlohy vrátí metadata projektu a prostředky.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ID úlohy.
projectName	path	True	string maxLength: 100	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Klíč předplatného pro prostředek služby jazyka.

Odpovědi

Name	Typ	Description
200 OK	TextAnalysisAuthoringExportProjectJobState	Stav dlouhotrvající operace.
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby jazyka.

Typ: apiKey
V: header

Příklady

Successful Get Export Status

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Stav úlohy.
TextAnalysisAuthoringExportProjectJobState	Představuje stav úlohy exportu.
TextAnalysisAuthoringWarning	Představuje upozornění, ke kterému došlo při provádění požadavku.

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

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

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Zpráva o chybě.
target	string	Cíl chyby

JobStatus

Výčet

Stav úlohy.

Hodnota	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Objekt

Představuje stav úlohy exportu.

Name	Typ	Description
createdDateTime	string (date-time)	Datum vytvoření úlohy.
errors	Error[]	Při provádění úlohy došlo k chybám.
expirationDateTime	string (date-time)	Datum vypršení platnosti úlohy.
jobId	string	ID úlohy.
lastUpdatedDateTime	string (date-time)	Datum posledního data, kdy byla úloha aktualizována.
resultUrl	string	Adresa URL, která se má použít ke stažení exportovaného projektu.
status	JobStatus	Stav úlohy.
warnings	TextAnalysisAuthoringWarning[]	Upozornění, ke kterým došlo při provádění úlohy.

TextAnalysisAuthoringWarning

Objekt

Představuje upozornění, ke kterému došlo při provádění požadavku.

Name	Typ	Description
code	string	Kód upozornění.
message	string	Zpráva s upozorněním