Desteklenen belge biçimlerini alma

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

Desteklenen belge biçimlerini al yöntemi, Belge Çevirisi hizmeti tarafından desteklenen belge biçimlerinin listesini döndürür. Liste ortak dosya uzantısını ve karşıya yükleme API'sini kullanıyorsanız içerik türünü içerir.

İstek URL’si

Şuraya bir GET isteği gönderin:

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

Ö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 ü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. Desteklenen belge dosyası biçimlerinin listesini döndürür.
500 İç Sunucu Hatası.
Diğer Durum Kodları • Çok fazla istek
• Sunucu geçici olarak kullanılamıyor

Dosya biçimi yanıtı

Başarılı fileFormatListResult yanıtı

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

Adı Tür Açıklama
değer Dosya Biçimi [] FileFormat[] listelenen ayrıntıları içerir.
value.contentTypes string[] Bu biçim için desteklenen İçerik Türleri.
value.defaultVersion Dize Hiçbiri belirtilmezse varsayılan sürüm.
value.fileExtensions string[] Bu biçim için desteklenen dosya uzantısı.
value.format Dize Biçimin adı.
value.versions dize [] Desteklenen sürüm.

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.

Durum kodu: 200

{
    "value": [
        {
            "format": "PlainText",
            "fileExtensions": [
                ".txt"
            ],
            "contentTypes": [
                "text/plain"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlWord",
            "fileExtensions": [
                ".docx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlPresentation",
            "fileExtensions": [
                ".pptx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.presentationml.presentation"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlSpreadsheet",
            "fileExtensions": [
                ".xlsx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
            ],
            "versions": []
        },
        {
            "format": "OutlookMailMessage",
            "fileExtensions": [
                ".msg"
            ],
            "contentTypes": [
                "application/vnd.ms-outlook"
            ],
            "versions": []
        },
        {
            "format": "HtmlFile",
            "fileExtensions": [
                ".html",
                ".htm"
            ],
            "contentTypes": [
                "text/html"
            ],
            "versions": []
        },
        {
            "format": "PortableDocumentFormat",
            "fileExtensions": [
                ".pdf"
            ],
            "contentTypes": [
                "application/pdf"
            ],
            "versions": []
        },
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ],
            "versions": []
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ],
            "versions": []
        },
        {
            "format": "RichTextFormat",
            "fileExtensions": [
                ".rtf"
            ],
            "contentTypes": [
                "application/rtf"
            ],
            "versions": []
        },
        {
            "format": "WordDocument",
            "fileExtensions": [
                ".doc"
            ],
            "contentTypes": [
                "application/msword"
            ],
            "versions": []
        },
        {
            "format": "PowerpointPresentation",
            "fileExtensions": [
                ".ppt"
            ],
            "contentTypes": [
                "application/vnd.ms-powerpoint"
            ],
            "versions": []
        },
        {
            "format": "ExcelSpreadsheet",
            "fileExtensions": [
                ".xls"
            ],
            "contentTypes": [
                "application/vnd.ms-excel"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentText",
            "fileExtensions": [
                ".odt"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.text"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentPresentation",
            "fileExtensions": [
                ".odp"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.presentation"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentSpreadsheet",
            "fileExtensions": [
                ".ods"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.spreadsheet"
            ],
            "versions": []
        },
        {
            "format": "Markdown",
            "fileExtensions": [
                ".markdown",
                ".mdown",
                ".mkdn",
                ".md",
                ".mkd",
                ".mdwn",
                ".mdtxt",
                ".mdtext",
                ".rmd"
            ],
            "contentTypes": [
                "text/markdown",
                "text/x-markdown",
                "text/plain"
            ],
            "versions": []
        },
        {
            "format": "Mhtml",
            "fileExtensions": [
                ".mhtml",
                ".mht"
            ],
            "contentTypes": [
                "message/rfc822",
                "application/x-mimearchive",
                "multipart/related"
            ],
            "versions": []
        }
    ]
}

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