Text Analysis Authoring - Get Export Status

Référence

Service:: Azure AI Services

Version d'API:: 2023-04-01

Obtient l’état d’un travail d’exportation. Une fois le travail terminé, retourne les métadonnées du projet et les ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string url	Point de terminaison Cognitive Services pris en charge, par exemple, https://.api.cognitiveservices.azure.com.
jobId	path	True	string	ID du travail.
projectName	path	True	string	Nouveau nom du projet.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	TextAnalysisAuthoringExportProjectJobState	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

Successful Get Export Status

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringExportProjectJobState	Représente l’état d’un travail d’exportation.
TextAnalysisAuthoringWarning	Représente un avertissement rencontré lors de l’exécution de la requête.

Error

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
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

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode