특정 번역 작업의 상태 가져오기
참조
기능: Azure AI Translator → 문서 번역
API 버전: 2024-05-01
HTTP 메서드: GET
- 메서드를
get translation status
사용하여 특정 번역 작업의 상태를 요청합니다. 응답에는 전체 작업 상태 및 해당 작업의 일부로 번역되는 문서의 상태가 포함됩니다.
요청 URL
Important
문서 번역 기능에 대한 모든 API 요청에는 Azure Portal의 리소스 개요 페이지에 있는 사용자 지정 도메인 엔드포인트가 필요합니다.
curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"
요청 매개 변수
쿼리 문자열에 전달된 요청 매개 변수는 다음과 같습니다.
쿼리 매개 변수 | Required | 설명 |
---|---|---|
id |
True | 작업 ID입니다. |
id
값 찾기
POST start-batch-translation
메서드 응답 헤더 Operation-Location
URL 값에서 작업 id
를 찾을 수 있습니다. /document/
매개 변수 다음의 영숫자 문자열은 작업의 작업 id
입니다.
응답 헤더 | 응답 URL |
---|---|
Operation-Location | {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec ?api-version=2024-05-01 |
- 또한 get-translations-status 요청을 사용하여 번역 작업 및 해당
id
목록을 검색할 수도 있습니다.
요청 헤더
요청 헤더는 다음과 같습니다.
헤더 | 설명 | 조건 |
---|---|---|
Ocp-Apim-Subscription-Key | Azure Portal의 Translator Service API 키입니다. | Required |
Ocp-Apim-Subscription-Region | 리소스를 만든 지역입니다. | 미국 서부와 같은 지역(지리적) 리소스를 사용할 때 필요합니다. 글머리 기호입니다. |
Content-Type | 페이로드의 콘텐츠 형식입니다. 허용되는 값은 application/json 또는 charset=UTF-8입니다. | Required |
응답 상태 코드
요청을 반환하는 가능한 HTTP 상태 코드는 다음과 같습니다.
상태 코드 | Description |
---|---|
200 | OK. 성공적으로 요청하고 일괄 처리 번역 작업의 상태를 반환합니다. HeadersRetry-After: integerETag: string |
401 | 권한이 없습니다. 자격 증명을 확인합니다. |
404 | 리소스를 찾을 수 없습니다. |
500 | 내부 서버 오류. |
기타 상태 코드 | • 요청이 너무 많음 • 서버를 일시적으로 사용할 수 없음 |
번역 상태 응답 가져오기
번역 상태 응답 가져오기 성공
성공적인 응답에서 반환되는 정보는 다음과 같습니다.
속성 | 형식 | 설명 |
---|---|---|
id |
string | 작업의 ID입니다. |
createdDateTimeUtc | string | 작업에서 만든 날짜 시간입니다. |
lastActionDateTimeUtc | string | 작업 상태가 업데이트된 날짜 시간입니다. |
status | 문자열 | 작업 또는 문서의 가능한 상태 목록: • 취소됨 •취소 •실패 • NotStarted •달리기 •성공 • ValidationFailed |
요약 | StatusSummary | 나열된 세부 정보가 포함된 요약입니다. |
summary.total | 정수 | 총 개수입니다. |
summary.failed | 정수 | 실패 횟수입니다. |
summary.success | 정수 | 성공한 횟수입니다. |
summary.inProgress | 정수 | 진행 중인 수입니다. |
summary.notYetStarted | 정수 | 아직 시작되지 않은 횟수입니다. |
summary.cancelled | 정수 | 취소된 개수입니다. |
summary.totalCharacterCharged | 정수 | API에서 청구되는 총 문자 수입니다. |
오류 응답
속성 | 형식 | 설명 |
---|---|---|
코드 | string | 상위 수준 오류 코드를 포함하는 열거형입니다. 가능한 값: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •무단 |
message | string | 상위 수준 오류 메시지를 가져옵니다. |
target | string | 오류의 원인을 가져옵니다. 예를 들어 유효하지 않은 문서의 경우 documents 또는 document id 입니다. |
innerError | InnerTranslationError | Azure AI 서비스 API 지침을 준수하는 새로운 내부 오류 형식입니다. 이 오류 메시지에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, details(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다. |
innerError.code | string | 코드 오류 문자열을 가져옵니다. |
innerError.message | string | 상위 수준 오류 메시지를 가져옵니다. |
innerError.target | string | 오류의 원인을 가져옵니다. 예를 들어 유효하지 않은 문서의 경우 documents 또는 document id 입니다. |
예제
성공적인 응답 예제
다음 JSON 개체는 성공적인 응답의 예입니다.
{
"id": "727bf148-f327-47a0-9481-abae6362f11e",
"createdDateTimeUtc": "2020-03-26T00:00:00Z",
"lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
"status": "Succeeded",
"summary": {
"total": 10,
"failed": 1,
"success": 9,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 0
}
}
오류 응답 예
다음 JSON 객체는 오류 응답의 예입니다. 다른 오류 코드에 대한 스키마는 동일합니다.
상태 코드: 401
{
"error": {
"code": "Unauthorized",
"message": "User is not authorized",
"target": "Document",
"innerError": {
"code": "Unauthorized",
"message": "Operation is not authorized"
}
}
}
다음 단계
빠른 시작에 따라 문서 번역 및 클라이언트 라이브러리 사용에 대해 자세히 알아보세요.