De ondersteunde documentindelingen ophalen

Reference
Service: Azure AI Document Translation
API Version: v1.1

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

Aanvraag-URL

Een aanvraag GET versturen naar:

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

Meer informatie over het vinden van uw aangepaste domeinnaam.

Belangrijk

• Voor alle API-aanvragen voor de documentomzettingsservice is een aangepast domeineindpunt vereist.
• U kunt het eindpunt dat is gevonden op de azure-portal-resourcesleutels en -eindpunten en het globale translator-eindpuntapi.cognitive.microsofttranslator.com, niet gebruiken om HTTP-aanvragen te maken voor documentomzetting.

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 documentbestandsindelingen.
500	Interne serverfout.
Overige statuscodes	• Te veel aanvragen • Server tijdelijk niet beschikbaar

Bestandsindelingsantwoord

Geslaagd fileFormatListResult-antwoord

De volgende informatie wordt geretourneerd in een geslaagd antwoord.

Name	Type	Description
waarde	FileFormat []	FileFormat[] bevat de 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 notatie.
value.versions	tekenreeks []	Ondersteunde versie.

Foutrespons

Name	Type	Description
code	tekenreeks	Opsommingen met foutcodes op hoog niveau. Mogelijke waarden: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Onbevoegde
bericht	tekenreeks	Hiermee wordt een foutbericht op hoog niveau weergegeven.
innerError	InnerTranslationError	Nieuwe interne foutindeling die voldoet aan api-richtlijnen voor Azure AI-services. Dit foutbericht bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (deze kan worden genest).
innerError.code	tekenreeks	Hiermee haalt u de codefoutreeks op.
innerError.message	tekenreeks	Hiermee wordt een foutbericht op hoog niveau weergegeven.
innerError.target	tekenreeks	Hiermee haalt u de bron van de fout op. Dit kan bijvoorbeeld een ongeldig document zijn documents of document id voor een ongeldig document.

Voorbeelden

Voorbeeld van geslaagde reactie

Het volgende JSON-object is 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

Het volgende JSON-object is een voorbeeld van een foutreactie. 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 documentomzetting en de clientbibliotheek.

Aan de slag met de documentvertaling