Text Analysis Authoring - Get Export Status

Szolgáltatás:

Azure AI Services

API-verzió:

2022-05-01

Lekéri egy exportálási feladat állapotát. A feladat befejeződése után visszaadja a projekt metaadatait és eszközeit.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (például https://.api.cognitiveservices.azure.com).
jobId	path	True	string	A feladat azonosítója.
projectName	path	True	string maxLength: 100	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Egy language service-erőforrás előfizetési kulcsa.

Válaszok

Name	Típus	Description
200 OK	TextAnalysisAuthoringExportProjectJobState	A hosszú ideig futó művelet állapota.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Egy language service-erőforrás előfizetési kulcsa.

Típus: apiKey
In: header

Példák

Successful Get Export Status

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
}

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	A feladat állapota.
TextAnalysisAuthoringExportProjectJobState	Egy exportálási feladat állapotát jelöli.
TextAnalysisAuthoringWarning	A kérés végrehajtása során észlelt figyelmeztetést jelöli.

Error

Objektum

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Enumerálás

Ember által olvasható hibakód.

Érték	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Objektum

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Enumerálás

Ember által olvasható hibakód.

Érték	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objektum

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

JobStatus

Enumerálás

A feladat állapota.

Érték	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Objektum

Egy exportálási feladat állapotát jelöli.

Name	Típus	Description
createdDateTime	string (date-time)	A feladat létrehozási dátuma.
errors	Error[]	A feladat végrehajtása során észlelt hibák.
expirationDateTime	string (date-time)	A feladat lejárati dátuma.
jobId	string	A feladat azonosítója.
lastUpdatedDateTime	string (date-time)	A feladat utolsó frissítésének dátuma.
resultUrl	string	Az exportált projekt letöltéséhez használandó URL-cím.
status	JobStatus	A feladat állapota.
warnings	TextAnalysisAuthoringWarning[]	A feladat végrehajtása során észlelt figyelmeztetések.

TextAnalysisAuthoringWarning

Objektum

A kérés végrehajtása során észlelt figyelmeztetést jelöli.

Name	Típus	Description
code	string	A figyelmeztető kód.
message	string	A figyelmeztető üzenet.