다음을 통해 공유

특정 문서의 상태 가져오기

참조
기능: Azure AI Translator → 문서 번역
API 버전: 2024-05-01
HTTP 메서드: GET

이 메서드는 요청 iddocumentId 및 쿼리 매개 변수에 표시된 대로 작업의 특정 문서에 대한 상태를 반환합니다.

요청 URL

중요합니다

문서 번역 기능에 대한 모든 API 요청에는 Azure Portal의 리소스 개요 페이지에 있는 사용자 지정 도메인 엔드포인트가 필요합니다.

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}?api-version={date}"

요청 매개 변수

쿼리 문자열에 전달된 요청 매개 변수는 다음과 같습니다.

쿼리 매개 변수 필수 설명
documentId 진실 문서 ID입니다.
id 진실 일괄 처리 ID입니다.

및 id 값 찾기 documentId

  • POST id 메서드 응답 헤더 start-batch-translation URL 값에서 작업 Operation-Location를 찾을 수 있습니다. URL의 마지막 매개 변수는 작업의 작업 id입니다.
응답 헤더 결과 URL
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

요청 헤더

요청 헤더는 다음과 같습니다.

헤더 설명
Ocp-Apim-Subscription-Key 필수 요청 헤더

응답 상태 코드

요청을 반환하는 가능한 HTTP 상태 코드는 다음과 같습니다.

상태 코드 설명
200 그래. 서비스에서 수락된 성공적인 요청입니다. 작업 세부 정보가 반환됩니다. HeadersRetry-After: integerETag: string
401 권한이 없습니다. 자격 증명을 확인합니다.
404 찾을 수 없음. 리소스를 찾을 수 없습니다.
500 내부 서버 오류.
기타 상태 코드 • 요청이 너무 많음
• 서버를 일시적으로 사용할 수 없음

문서 상태 응답 가져오기

문서 상태 응답 가져오기 성공

속성 형식 설명
경로 문자열 문서 또는 폴더의 위치입니다.
sourcePath 문자열 원본 문서의 위치입니다.
createdDateTimeUtc 문자열 작업에서 만든 날짜 시간입니다.
lastActionDateTimeUtc 문자열 작업 상태가 업데이트된 날짜 시간입니다.
상태 문자열 작업 또는 문서의 가능한 상태 목록:
• 취소됨
•취소
•실패
• NotStarted
•달리기
•성공
• ValidationFailed
끝 문자열 To Language의 두 문자 언어 코드입니다. 언어 목록을 참조하세요.
진행률 번호 사용 가능한 경우 번역의 진행률입니다.
id 문자열 문서 ID입니다.
characterCharged 정수 API로 청구되는 문자 수입니다.

오류 응답

속성 형식 설명
코드 문자열 상위 수준 오류 코드를 포함하는 열거형입니다. 허용되는 값:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•무단
메시지 문자열 상위 수준 오류 메시지를 가져옵니다.
내부 오류 InnerTranslationError Azure AI 서비스 API 지침을 준수하는 새로운 내부 오류 형식입니다. 이 오류 메시지에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, details(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
innerError.코드 문자열 코드 오류 문자열을 가져옵니다.
내부오류.메시지 문자열 상위 수준 오류 메시지를 가져옵니다.
innerError.target 문자열 오류의 원인을 가져옵니다. 예를 들어 유효하지 않은 문서의 경우 documents 또는 document id입니다.

예제

성공적인 응답 예제

다음 JSON 개체는 성공적인 응답의 예입니다.

{
  "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
  "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Running",
  "to": "fr",
  "progress": 0.1,
  "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
  "characterCharged": 0
}

오류 응답 예

다음 JSON 객체는 오류 응답의 예입니다. 다른 오류 코드에 대한 스키마는 동일합니다.

상태 코드: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

다음 단계

빠른 시작에 따라 문서 번역 및 클라이언트 라이브러리 사용에 대해 자세히 알아보세요.

문서 번역 시작