Tüm belgelerin durumunu alma

Başvuru
Özelliği: Azure AI Translator → Belge Çevirisi
API'si Sürümü: 2024-05-01
HTTP yöntemi: GET

• Bir çeviri işi içindeki get documents status tüm belgelerin durumunu istemek için yöntemini kullanın.

• $top, $skipve $maxpagesize sorgu parametreleri, döndürülecek sonuç sayısını ve koleksiyonun uzaklığını belirtmek için kullanılabilir.

  • $top kullanıcının tüm sayfalarda döndürülmek istediği toplam kayıt sayısını gösterir.
  • $skip , belirtilen sıralama yöntemine göre sunucu tarafından tutulan belge durumu listesinden atlanacak kayıt sayısını gösterir. Varsayılan olarak, kayıtlar azalan başlangıç zamanına göre sıralanır.
  • $maxpagesize bir sayfada döndürülen en fazla öğe sayısıdır.
  • aracılığıyla $top daha fazla öğe istenirse (veya $top belirtilmezse ve döndürülecek daha fazla öğe varsa), @nextLink sonraki sayfanın bağlantısını içerir.
  • Yanıttaki belge sayısı disk belleği sınırımızı aşarsa, sunucu tarafı disk belleği kullanılır.
  • Sayfalandırılmış yanıtlar kısmi bir sonucu gösterir ve yanıta bir devamlılık belirteci ekler. Devam belirtecinin olmaması, kullanılabilir başka sayfa olmadığı anlamına gelir.

• $orderBy sorgu parametresi, döndürülen listeyi (örn: $orderBy=createdDateTimeUtc asc veya $orderBy=createdDateTimeUtc desc) sıralamak için kullanılabilir.
• Varsayılan sıralama ölçütüne createdDateTimeUtcgöre azalandır. Bazı sorgu parametreleri, döndürülen listeyi (örn: status=Succeeded,Cancelled) yalnızca başarılı ve iptal edilmiş belgeleri filtrelemek için kullanılabilir.
• ve createdDateTimeUtcStart createdDateTimeUtcEnd sorgu parametreleri, döndürülen listeyi filtrelemek üzere bir tarih saat aralığı belirtmek için birleştirilebilir veya ayrı ayrı kullanılabilir.
• Desteklenen filtreleme sorgusu parametreleri şunlardır: (status, id, createdDateTimeUtcStartve createdDateTimeUtcEnd).
• Hem hem $skip de $top dahil edildiğinde, sunucu önce uygulamalı ve ardından $top koleksiyona uygulanmalıdır$skip.

İstek URL’si

Şuraya bir GET isteği gönderin:

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

Değeri bulma id

• İşi id POST start-batch-translation yöntemi yanıt Üst Bilgi Operation-Location URL'si değerinde bulabilirsiniz. parametresini /document/ izleyen alfasayısal dize, işlemin işidir id:

• Çeviri işlerinin ve işlerinin idlistesini almak için get-translations-status isteği de kullanabilirsiniz.

İstek parametreleri

Sorgu dizesinde geçirilen istek parametreleri şunlardır:

İstek üst bilgileri

İstek üst bilgileri şunlardır:

Yanıt durum kodları

Bir isteğin döndürdüğü olası HTTP durum kodları aşağıdadır.

Belgelerin durum yanıtlarını alma

Başarılı belge alma durumu yanıtı

Başarılı bir yanıtta aşağıdaki bilgiler döndürülür.

Hata yanıtı

Örnekler

Örnek başarılı yanıt

Aşağıdaki JSON nesnesi başarılı bir yanıt örneğidir.

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

Örnek hata yanıtı

Aşağıdaki JSON nesnesi bir hata yanıtı örneğidir. Diğer hata kodlarının şeması aynıdır.

Durum kodu: 500

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

Sonraki adımlar

Belge Çevirisi ve istemci kitaplığını kullanma hakkında daha fazla bilgi edinmek için hızlı başlangıcımızı izleyin.