Text Analysis Authoring - Get Import Status

Service:

Azure AI Services

Version d'API:

2022-05-01

Obtient l’état d’une importation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	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 maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Clé d’abonnement pour une ressource de service de langage.

Réponses

Nom	Type	Description
200 OK	TextAnalysisAuthoringImportProjectJobState	Détails de l’opération de longue durée.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Clé d’abonnement pour une ressource de service de langage.

Type: apiKey
Dans: header

Exemples

Successful Get Import Status

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{
  "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000",
  "createdDateTime": "2022-04-18T15:17:20Z",
  "lastUpdatedDateTime": "2022-04-18T15:17:22Z",
  "expirationDateTime": "2022-04-25T15:17:20Z",
  "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	État du travail.
TextAnalysisAuthoringImportProjectJobState	Représente l’état d’un travail d’importation.
TextAnalysisAuthoringWarning	Représente un avertissement rencontré lors de l’exécution de la requête.

Error

Object

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

Énumération

Code d’erreur lisible par l’homme.

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

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

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

InnerErrorModel

Object

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.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

JobStatus

Énumération

État du travail.

Valeur	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringImportProjectJobState

Object

Représente l’état d’un travail d’importation.

Nom	Type	Description
createdDateTime	string (date-time)	Heure de création du travail.
errors	Error[]	Les erreurs rencontrées lors de l’exécution du travail.
expirationDateTime	string (date-time)	Heure d’expiration du travail.
jobId	string	ID du travail.
lastUpdatedDateTime	string (date-time)	Date de la dernière mise à jour du travail.
status	JobStatus	État du travail.
warnings	TextAnalysisAuthoringWarning[]	Avertissements rencontrés lors de l’exécution du travail.

TextAnalysisAuthoringWarning

Object

Représente un avertissement rencontré lors de l’exécution de la requête.

Nom	Type	Description
code	string	Code d’avertissement.
message	string	Message d’avertissement.