모든 문서에 대한 상태 가져오기

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

• 이 메서드를 get documents status 사용하여 번역 작업의 모든 문서에 대한 상태를 요청합니다.

• $top, $skip 및 $maxpagesize 쿼리 매개 변수를 사용하여 반환할 결과 수와 컬렉션의 오프셋을 지정할 수 있습니다.

  • $top은 사용자가 모든 페이지에서 반환되기를 원하는 총 레코드 수를 나타냅니다.
  • $skip은 지정된 정렬 방법에 따라 서버가 보유한 문서 상태 목록에서 건너뛸 레코드 수를 나타냅니다. 기본적으로 레코드는 내림차순 시작 시간을 기준으로 정렬됩니다.
  • $maxpagesize은 페이지에 반환된 최대 항목입니다.
  • $top을 통해 추가 항목이 요청된 경우(또는 $top가 지정되지 않았고 반환할 항목이 더 있는 경우) @nextLink에는 다음 페이지에 대한 링크가 포함됩니다.
  • 응답의 문서 수가 페이징 제한을 초과하면 서버 측 페이징이 사용됩니다.
  • 페이지가 매겨진 응답은 부분 결과를 나타내며 응답에 연속 토큰을 포함합니다. 연속 토큰이 없으면 다른 페이지를 사용할 수 없습니다.

• $orderBy 쿼리 매개 변수를 사용하여 반환된 목록(예: $orderBy=createdDateTimeUtc asc 또는 $orderBy=createdDateTimeUtc desc)을 정렬할 수 있습니다.
• 기본 정렬은 다음을 createdDateTimeUtc기준으로 내림차순입니다. 일부 쿼리 매개 변수는 반환된 목록(예: status=Succeeded,Cancelled)을 필터링하는 데 성공 및 취소된 문서만 반환하는 데 사용할 수 있습니다.
• 쿼리 매개 변수와 createdDateTimeUtcEnd 쿼리 매개 변수를 createdDateTimeUtcStart 결합하거나 별도로 사용하여 반환된 목록을 필터링하는 날짜/시간 범위를 지정할 수 있습니다.
• 지원되는 필터링 쿼리 매개 변수는 (status, id, createdDateTimeUtcStart및 createdDateTimeUtcEnd)입니다.
• $top과 $skip가 모두 포함된 경우 서버는 먼저 컬렉션에 $skip을 적용한 다음 $top를 적용해야 합니다.

요청 URL

다음에 GET 요청을 보냅니다.

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

id 값 찾기

• POST start-batch-translation 메서드 응답 헤더 Operation-Location URL 값에서 작업 id를 찾을 수 있습니다. /document/ 매개 변수 다음의 영숫자 문자열은 작업의 작업 id입니다.

• 또한 get-translations-status 요청을 사용하여 번역 작업 및 해당 id 목록을 검색할 수도 있습니다.

요청 매개 변수

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

요청 헤더

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

응답 상태 코드

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

문서 상태 가져오기 응답

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

성공적인 응답에서 반환되는 정보는 다음과 같습니다.

오류 응답

예제

성공적인 응답 예제

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

오류 응답 예

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

상태 코드: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

다음 단계

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