Text Analysis Authoring - Get Export Status

Service:

Azure AI Services

API-versie:

2022-05-01

Hiermee haalt u de status van een exporttaak op. Zodra de taak is voltooid, worden de metagegevens en assets van het project geretourneerd.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
jobId	path	True	string	De taak-id.
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een Taalserviceresource.

Antwoorden

Name	Type	Description
200 OK	TextAnalysisAuthoringExportProjectJobState	De status van de langdurige bewerking.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een Taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Get Export Status

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	De taakstatus.
TextAnalysisAuthoringExportProjectJobState	Vertegenwoordigt de status van een exporttaak.
TextAnalysisAuthoringWarning	Vertegenwoordigt een waarschuwing die is opgetreden tijdens het uitvoeren van de aanvraag.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

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

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

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

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

JobStatus

Inventarisatie

De taakstatus.

Waarde	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Object

Vertegenwoordigt de status van een exporttaak.

Name	Type	Description
createdDateTime	string (date-time)	De aanmaakdatum van de taak.
errors	Error[]	De fouten die zijn opgetreden tijdens het uitvoeren van de taak.
expirationDateTime	string (date-time)	De vervaldatum van de taak.
jobId	string	De taak-id.
lastUpdatedDateTime	string (date-time)	De laatste datum waarop de taak is bijgewerkt.
resultUrl	string	De URL die moet worden gebruikt om het geëxporteerde project te downloaden.
status	JobStatus	De taakstatus.
warnings	TextAnalysisAuthoringWarning[]	De waarschuwingen die zijn opgetreden tijdens het uitvoeren van de taak.

TextAnalysisAuthoringWarning

Object

Vertegenwoordigt een waarschuwing die is opgetreden tijdens het uitvoeren van de aanvraag.

Name	Type	Description
code	string	De waarschuwingscode.
message	string	Het waarschuwingsbericht.