Ondersteunde documentindelingen krijgen

De methode Ondersteunde documentindelingen krijgen retourneert een lijst met documentindelingen die worden ondersteund door de documentvertalingsservice. De lijst bevat de algemene bestandsextensie en het inhoudstype als u de upload-API gebruikt.

Aanvraag-URL

Verzend een GET aanvraag naar:

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

Meer informatie over het vinden van uw aangepaste domeinnaam.

Belangrijk

  • Voor alle API-aanvragen voor de documentvertalingsservice is een aangepast domein-eindpunt vereist.
  • U kunt het eindpunt dat u op uw Azure Portal resourcesleutels en eindpuntpagina hebt gevonden, noch het globale translator-eindpunt gebruiken om HTTP-aanvragen te maken voor api.cognitive.microsofttranslator.com documentvertaling.

Aanvraagheaders

Aanvraagheaders zijn:

Kopteksten Beschrijving
Ocp-Apim-Subscription-Key Vereiste aanvraagheader

Antwoordstatuscodes

Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.

Statuscode Beschrijving
200 OK. Retourneert de lijst met ondersteunde bestandsindelingen voor documenten.
500 Interne serverfout.
Andere statuscodes
  • Te veel aanvragen
  • Server tijdelijk niet beschikbaar

Antwoord bestandsindeling

Geslaagd fileFormatListResult-antwoord

De volgende informatie wordt geretourneerd als een geslaagd antwoord.

Naam Type Beschrijving
waarde FileFormat [] FileFormat[] bevat de hieronder vermelde details.
value.contentTypes tekenreeks[] Ondersteunde inhoudstypen voor deze indeling.
value.defaultVersion tekenreeks Standaardversie als er geen is opgegeven.
value.fileExtensions tekenreeks[] Ondersteunde bestandsextensie voor deze indeling.
value.format tekenreeks Naam van de indeling.
value.versions tekenreeks [] Ondersteunde versie.

Foutbericht

Naam Type Beschrijving
code tekenreeks Enums met foutcodes op hoog niveau. Mogelijke waarden:
  • InternalServerError
  • InvalidArgument
  • InvalidRequest
  • RequestRateTooHigh
  • ResourceNotFound
  • ServiceUnavailable
  • Niet geautoriseerd
message tekenreeks Haalt een foutbericht op hoog niveau op.
innerError InnerTranslationError Nieuwe interne foutindeling die voldoet aan Cognitive Services API-richtlijnen. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen target, details(sleutel-waardepaar), interne fout (dit kan worden genest).
innerError.code tekenreeks Haalt de codefoutreeks op.
innerError.message tekenreeks Haalt een foutbericht op hoog niveau op.
innerError.target tekenreeks Haalt de bron van de fout op. Dit zijn bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

Voorbeelden

Voorbeeld van een geslaagd antwoord

Hier volgt een voorbeeld van een geslaagd antwoord.

Statuscode: 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": []
        }
    ]
}

Voorbeeld van een foutbericht

Hier volgt een voorbeeld van een foutbericht. Het schema voor andere foutcodes is hetzelfde.

Statuscode: 500

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

Volgende stappen

Volg onze quickstart voor meer informatie over het gebruik van Documentvertaling en de clientbibliotheek.