Text Analysis Authoring - Get Import Status

서비스:

Azure AI Services

API 버전:

2022-05-01

가져오기의 상태를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
jobId	path	True	string	작업 ID입니다.
projectName	path	True	string maxLength: 100	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	언어 서비스 리소스에 대한 구독 키입니다.

응답

Name	형식	Description
200 OK	TextAnalysisAuthoringImportProjectJobState	장기 실행 작업의 세부 정보입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

형식: apiKey
In(다음 안에): header

예제

Successful Get Import Status

샘플 요청

HTTP

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

샘플 응답

상태 코드:

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

정의

Name	Description
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	작업 상태입니다.
TextAnalysisAuthoringImportProjectJobState	가져오기 작업의 상태를 나타냅니다.
TextAnalysisAuthoringWarning	요청을 실행하는 동안 발생한 경고를 나타냅니다.

Error

Object

오류 개체입니다.

Name	형식	Description
code	ErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

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

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

InnerErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

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

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	InnerErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

JobStatus

열거형

작업 상태입니다.

값	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringImportProjectJobState

Object

가져오기 작업의 상태를 나타냅니다.

Name	형식	Description
createdDateTime	string (date-time)	작업의 생성 날짜 시간입니다.
errors	Error[]	작업을 실행하는 동안 발생한 오류입니다.
expirationDateTime	string (date-time)	작업의 만료 날짜 시간입니다.
jobId	string	작업 ID입니다.
lastUpdatedDateTime	string (date-time)	작업이 업데이트된 마지막 날짜입니다.
status	JobStatus	작업 상태입니다.
warnings	TextAnalysisAuthoringWarning[]	작업을 실행하는 동안 발생한 경고입니다.

TextAnalysisAuthoringWarning

Object

요청을 실행하는 동안 발생한 경고를 나타냅니다.

Name	형식	Description
code	string	경고 코드입니다.
message	string	경고 메시지입니다.