Tüm belgelerin durumunu alma

Makale
06/01/2024

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

Önemli

Belge Çevirisi özelliğine yönelik tüm API istekleri, Azure portalındaki kaynağınıza genel bakış sayfasında bulunan özel bir etki alanı uç noktası gerektirir.

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.

Not

Sunucu ve/veya $skipdeğerini karşılayamazsa$top, sunucu yalnızca sorgu seçeneklerini yoksaymak yerine istemciye bu konuda bilgi veren bir hata döndürmelidir. Bu, istemcinin döndürülen veriler hakkında varsayımlarda bulunma riskini azaltır.

$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 createdDateTimeUtcStartcreatedDateTimeUtcEnd 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:

Yanıt üst bilgisi	Yanıt URL'si
İşlem Konumu	{document-translation-endpoint}/translator/document/`9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec`?api-version=2024-05-01

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

İstek parametreleri

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

Sorgu parametresi	İçinde	Zorunlu	Türü	Açıklama
`id`	yol	Doğru	Dize	İşlem kimliği.
`$maxpagesize`	query	False	tamsayı int32	`$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. İstemciler, bir tercih belirterek `$maxpagesize` belirli bir sayfa boyutuyla sunucu temelli disk belleği isteyebilir. Belirtilen sayfa boyutu sunucunun varsayılan sayfa boyutundan küçükse sunucu bu tercihe göre olmalıdır.
$orderBy	query	False	dizi	Koleksiyon için sıralama sorgusu (örn: `CreatedDateTimeUtc asc`, `CreatedDateTimeUtc desc`).
`$skip`	query	False	tamsayı int32	$skip, belirtilen sıralama yöntemine göre sunucu tarafından tutulan kayıt listesinden atlanacak kayıt sayısını gösterir. Varsayılan olarak, azalan başlangıç zamanına göre sıralarız. İstemciler, döndürülecek sonuç sayısını ve koleksiyona uzaklığı belirtmek için $top ve `$skip` sorgu parametrelerini kullanabilir. İstemci hem hem `$skip`de `$top` döndürdüğünde, sunucu önce uygulamalı ve ardından `$top` koleksiyona uygulanmalıdır`$skip`. Sunucu ve/veya `$skip`değerini karşılayamazsa`$top`, sunucu yalnızca sorgu seçeneklerini yoksaymak yerine istemciye bu konuda bilgi veren bir hata döndürmelidir.
`$top`	query	False	tamsayı int32	`$top` kullanıcının tüm sayfalarda döndürülmek istediği toplam kayıt sayısını gösterir. İstemciler döndürülecek sonuç sayısını ve `$skip` koleksiyona uzaklığı belirtmek için parametreleri kullanabilir `$top` ve sorgulayabilir. İstemci hem hem `$skip`de `$top` döndürdüğünde, sunucu önce uygulamalı ve ardından `$top` koleksiyona uygulanmalıdır`$skip`. Sunucu ve/veya `$skip`değerini karşılayamazsa`$top`, sunucu yalnızca sorgu seçeneklerini yoksaymak yerine istemciye bu konuda bilgi veren bir hata döndürmelidir.
createdDateTimeUtcEnd	query	False	dize tarih-saat	Öğeleri daha önce almak için bitiş tarihi saat.
createdDateTimeUtcStart	query	False	dize tarih-saat	Sonraki öğeleri almak için başlangıç tarih saati.
`ids`	query	False	dizi	Filtrelemede kullanılacak kimlikler.
Durum	query	False	dizi	Filtrelemede kullanılacak durumlar.

İstek üst bilgileri

İstek üst bilgileri şunlardır:

Üst Bilgiler	Açıklama	Koşul
Ocp-Apim-Subscription-Key	Azure portalından Çeviri hizmet API anahtarınız.	Zorunlu
Ocp-Apim-Subscription-Region	Kaynağınızın oluşturulduğu bölge.	• Batı ABD gibi bölgesel (coğrafi) bir kaynak kullanılırken gereklidir. & madde işareti.
İçerik Türü	Yükün içerik türü. Kabul edilen değer application/json veya charset=UTF-8'dir.	• Gerekli

Yanıt durum kodları

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

Durum Kodu	Açıklama
200	Tamam. Başarılı istek ve belgelerin durumunu döndürür. HeadersRetry-After: integerETag: string
400	Geçersiz istek. Giriş parametrelerini denetleyin.
Kategori 401	Yetkisiz. Kimlik bilgilerinizi denetleyin.
404	Kaynak bulunamadı.
500	İç Sunucu Hatası.
Diğer Durum Kodları	• Çok fazla istek • Sunucu geçici olarak kullanılamıyor

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.

Adı	Tür	Açıklama
@nextLink	Dize	Sonraki sayfanın URL'si. Başka sayfa yoksa null.
değer	DocumentStatus []	Tek tek belgelerin ayrıntı durum listesi.
value.path	Dize	Belgenin veya klasörün konumu.
value.sourcePath	Dize	Kaynak belgenin konumu.
value.createdDateTimeUtc	Dize	İşlem oluşturma tarihi saati.
value.lastActionDateTimeUtc	Dize	İşlemin durumunun güncelleştirildiği tarih saati.
value.status	durum	İş veya belge için olası durumların listesi. • İptal Edildi •Iptal •Başarısız • Başlamadı •Çalışan •Başarılı • ValidationFailed
value.to	Dize	Dile.
value.progress	Numara	Varsa çevirinin ilerleme durumu.
value.id	Dize	Belge Kimliği.
value.characterCharged	integer	API tarafından ücretlendirilen karakterler.

Hata yanıtı

Adı	Tür	Açıklama
kod	Dize	Üst düzey hata kodları içeren sabit listeleri. Olası değerler: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Yetki -siz
ileti	Dize	Üst düzey hata iletisi alır.
hedef	Dize	Hatanın kaynağını alır. Örneğin, geçersiz bir belge için veya `document id` olabilir`documents`.
innerError	InnerTranslationError	Azure AI hizmetleri API Yönergelerine uygun yeni İç Hata biçimi. Bu hata iletisi gerekli ErrorCode, ileti ve isteğe bağlı özellikler hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe yerleştirilmiş olabilir) özelliklerini içerir.
innerError.code	Dize	Kod hata dizesini alır.
innerError.message	Dize	Üst düzey hata iletisi alır.
innerError.target	Dize	Hatanın kaynağını alır. Örneğin, `documentsdocument id` veya geçersiz bir belge varsa olabilir.

Örnekler

İpucu

Get-document-status sorgu dizesinin parametresini almak documentId için bu yöntemi kullanın.

Ö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.

Belge Çevirisi ile çalışmaya başlama

Aracılığıyla paylaş

Tüm belgelerin durumunu alma

İstek URL’si

Değeri bulma `id`

İstek parametreleri

İstek üst bilgileri

Yanıt durum kodları

Belgelerin durum yanıtlarını alma

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

Hata yanıtı

Örnekler

Örnek başarılı yanıt

Örnek hata yanıtı

Sonraki adımlar

Ek kaynaklar

Aracılığıyla paylaş

Tüm belgelerin durumunu alma

İstek URL’si

Değeri bulma id

İstek parametreleri

İstek üst bilgileri

Yanıt durum kodları

Belgelerin durum yanıtlarını alma

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

Hata yanıtı

Örnekler

Örnek başarılı yanıt

Örnek hata yanıtı

Sonraki adımlar

Ek kaynaklar

Değeri bulma `id`