Få dokumentformat som stöds
Referenstjänst : Azure AI Document Translation API-version: v1.1
Metoden Hämta dokumentformat som stöds returnerar en lista över dokumentformat som stöds av dokumentöversättningstjänsten. Listan innehåller det vanliga filtillägget och innehållstypen om du använder uppladdnings-API:et.
Begärans-URL
Skicka en GET-begäran till:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
Lär dig hur du hittar ditt anpassade domännamn.
Viktigt!
- Alla API-begäranden till dokumentöversättningstjänsten kräver en anpassad domänslutpunkt.
- Du kan inte använda slutpunkten som finns på azure-portalens resursnycklar och slutpunktssida eller den globala translator-slutpunkten –
api.cognitive.microsofttranslator.comför att göra HTTP-begäranden till dokumentöversättning.
Begärandehuvuden
Begärandehuvuden är:
| Sidhuvuden | beskrivning |
|---|---|
| Ocp-Apim-Subscription-Key | Obligatoriskt begärandehuvud |
Svarsstatuskoder
Följande är de möjliga HTTP-statuskoder som en begäran returnerar.
| Statuskod | beskrivning |
|---|---|
| 200 | OK. Returnerar listan över dokumentfilformat som stöds. |
| 500 | Internt serverfel. |
| Andra statuskoder | • För många förfrågningar • Servern är tillfälligt otillgänglig |
Svar på filformat
Lyckat fileFormatListResult-svar
Följande information returneras i ett lyckat svar.
| Namn | Type | Beskrivning |
|---|---|---|
| värde | FileFormat [] | FileFormat[] innehåller den angivna informationen. |
| value.contentTypes | string[] | Innehållstyper som stöds för det här formatet. |
| value.defaultVersion | sträng | Standardversion om ingen har angetts. |
| value.fileExtensions | string[] | Filnamnstillägg som stöds för det här formatet. |
| value.format | sträng | Namnet på formatet. |
| value.versions | sträng [] | Version som stöds. |
Felsvar
| Namn | Type | Beskrivning |
|---|---|---|
| kod | sträng | Uppräkningar som innehåller felkoder på hög nivå. Möjliga värden: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Obehörig |
| meddelande | sträng | Hämtar felmeddelande på hög nivå. |
| innerError | InnerTranslationError | Nytt format för inre fel som överensstämmer med API-riktlinjerna för Azure AI-tjänster. Det här felmeddelandet innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel/värde-par), inre fel (det kan kapslas). |
| innerError.code | sträng | Hämtar kodfelsträngen. |
| innerError.message | sträng | Hämtar felmeddelande på hög nivå. |
| innerError.target | sträng | Hämtar källan till felet. Det skulle till exempel vara documents eller document id för ett ogiltigt dokument. |
Exempel
Exempel på lyckat svar
Följande JSON-objekt är ett exempel på ett lyckat svar.
Statuskod: 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": []
}
]
}
Exempel på felsvar
Följande JSON-objekt är ett exempel på ett felsvar. Schemat för andra felkoder är detsamma.
Statuskod: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Nästa steg
Följ vår snabbstart om du vill veta mer om hur du använder dokumentöversättning och klientbiblioteket.