Share via

Çevirilerin durumunu alma

  • Makale

Başvuru
Hizmeti: Azure AI Belge Çevirisi
API Sürümü: v1.1

Çevirileri al durum yöntemi, gönderilen toplu isteklerin listesini ve her isteğin durumunu döndürür. Bu liste yalnızca kullanıcı tarafından gönderilen toplu iş isteklerini içerir (kaynağa göre).

İstek 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.

$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 toplu iş listesinden atlanacak kayıt sayısını gösterir. Varsayılan olarak, azalan başlangıç zamanına göre sıralarız. $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.

$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, createdDateTimeUtc tarafından azalan düzendedir. Bazı sorgu parametreleri, döndürülen listeyi filtrelemek için kullanılabilir (örneğin: "status=Succeeded,Canceled") başarılı ve iptal edilmiş işlemler döndürür. createdDateTimeUtcStart ve createdDateTimeUtcEnd, döndürülen listeyi filtrelemek üzere bir tarih saat aralığı belirtmek için birlikte veya ayrı ayrı kullanılabilir. Desteklenen filtreleme sorgusu parametreleri şunlardır (status, IDs, createdDateTimeUtcStart, createdDateTimeUtcEnd).

Sunucu, istemci tarafından belirtilen değerleri kabul eder. Ancak, istemcilerin farklı bir sayfa boyutu veya devamlılık belirteci içeren yanıtları işlemeye hazır olması gerekir.

Hem hem $skip de $top dahil edildiğinde, sunucu önce uygulamalı ve ardından $top koleksiyona uygulanmalıdır$skip.

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.

İstek URL’si

Şuraya bir GET isteği gönderin:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches

Özel etki alanı adınızı bulmayı öğrenin.

Önemli

  • Belge Çevirisi hizmetine yönelik tüm API istekleri için özel bir etki alanı uç noktası gerekir.
  • Belge Çevirisi'ne HTTP isteklerinde bulunmak için Azure portalı kaynak Anahtarlar ve Uç Nokta sayfanızda bulunan uç noktayı veya genel çeviri uç noktasınıapi.cognitive.microsofttranslator.com kullanamazsınız.

İstek parametreleri

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

Sorgu parametresi İçinde Zorunlu Türü Açıklama
$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, 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 $skip koleksiyona uzaklığı belirtmek için parametreleri kullanabilir $top ve sorgular. İstemci hem hem $skipde $top döndürdüğünde, sunucu önce uygulamalı ve ardından $top koleksiyona uygulanmalıdır$skip. 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.
$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 sorgular. İstemci hem hem $skipde $top döndürdüğünde, sunucu önce uygulamalı ve ardından $top koleksiyona uygulanmalıdır$skip. 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.
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
Ocp-Apim-Subscription-Key Gerekli istek üst bilgisi

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 tüm işlemlerin durumunu döndürür. HeadersRetry-After: integerETag: string
400 Hatalı İstek. Geçersiz istek. Giriş parametrelerini denetleyin.
Kategori 401 Yetkisiz. Kimlik bilgilerinizi denetleyin.
500 İç Sunucu Hatası.
Diğer Durum Kodları • Çok fazla istek
• Sunucu geçici olarak kullanılamıyor

Çeviri durum yanıtlarını alma

Çevirileri alma durumu yanıtı başarılı

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 TranslationStatus[] TranslationStatus[] Dizisi
value.id Dize İşlemin kimliği.
value.createdDateTimeUtc Dize İşlem oluşturma tarihi saati.
value.lastActionDateTimeUtc Dize İşlemin durumunun güncelleştirildiği tarih saati.
value.status String İş veya belge için olası durumların listesi:
• İptal Edildi
•Iptal
•Başarısız
• Başlamadı
•Çalışan
•Başarılı
• ValidationFailed
value.summary StatusSummary[] Listelenen ayrıntıları içeren özet.
value.summary.total integer Toplam belge sayısı.
value.summary.failed integer Başarısız olan belge sayısı.
value.summary.success integer Başarıyla çevrilen belgelerin sayısı.
value.summary.inProgress integer Devam eden belge sayısı.
value.summary.notYetStarted integer Henüz işlenmeyen belgelerin sayısı.
value.summary.cancelled integer İptal edilen belge sayısı.
value.summary.totalCharacterCharacterChar integer Ücretlendirilen karakterlerin toplam sayısı.

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, documentsdocument id veya geçersiz bir belge varsa olabilir.
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

Örnek başarılı yanıt

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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