Belge durumunu alma

  • Makale

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

Belge Durumunu Al yöntemi, belirli bir belgenin durumunu döndürür. yöntemi, istek kimliğine ve belge kimliğine göre belirli bir belgenin çeviri durumunu döndürü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/{id}/documents/{documentId}

Ö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 Zorunlu Açıklama
Documentıd True Belge kimliği.
id True Toplu iş kimliği.

İ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. Hizmet tarafından kabul edilen başarılı istek. İşlem ayrıntıları döndürülür. HeadersRetry-After: integerETag: string
Kategori 401 Yetkisiz. Kimlik bilgilerinizi denetleyin.
404 Bulunamadı. Kaynak bulunamadı.
500 İç Sunucu Hatası.
Diğer Durum Kodları • Çok fazla istek
• Sunucu geçici olarak kullanılamıyor

Belge durumu yanıtı alma

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

Adı Tür Açıklama
yol Dize Belgenin veya klasörün konumu.
Sourcepath Dize Kaynak belgenin konumu.
createdDateTimeUtc Dize İşlem oluşturma tarihi saati.
lastActionDateTimeUtc Dize İşlemin durumunun güncelleştirildiği tarih saati.
durum String İş veya belge için olası durumların listesi:
• İptal Edildi
•Iptal
•Başarısız
• Başlamadı
•Çalışan
•Başarılı
• ValidationFailed
kullanıcısı Dize To Language için iki harfli dil kodu. Dil listesine bakın.
ilerleme Numara Varsa çevirinin ilerleme durumu
id Dize Belge Kimliği.
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.
innerError InnerTranslationError Azure AI hizmetleri API Yönergelerine uygun yeni İç Hata biçimi. Bu hata iletisi gerekli ErrorCode, ileti ve isteğe bağlı özellik hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe 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, geçersiz bir belge için veya document id olabilirdocuments.

Örnekler

Örnek başarılı yanıt

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

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

Ö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: 401

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

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