Hämta dokumentformat som stöds
Metoden Hämta dokumentformat som stöds returnerar en lista över dokumentformat som stöds av tjänsten För dokumentöversättning. Listan innehåller det vanliga filtillägget och innehållstypen om du använder API:et för uppladdning.
Begärans-URL
Skicka en GET begäran till:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/documents/formats
Lär dig hur du hittar ditt anpassade domännamn.
Viktigt
- Alla API-begäranden till tjänsten för dokumentöversättning kräver en anpassad domänslutpunkt.
- Du kan inte använda slutpunkten som finns på din Azure Portal resursnycklar och slutpunktssida eller den globala översättningsslutpunkten– – för
api.cognitive.microsofttranslator.comatt göra HTTP-begäranden till dokumentöversättning.
Begärandehuvuden
Begärandehuvuden är:
| Sidhuvuden | Description |
|---|---|
| Ocp-Apim-Subscription-Key | Begärandehuvud som krävs |
Statuskoder för svar
Följande är de möjliga HTTP-statuskoder som en begäran returnerar.
| Statuskod | Description |
|---|---|
| 200 | OK. Returnerar listan över dokumentfilformat som stöds. |
| 500 | Internt serverfel. |
| Andra statuskoder |
|
Filformatsvar
Lyckat fileFormatListResult-svar
Följande information returneras i ett lyckat svar.
| Namn | Typ | Description |
|---|---|---|
| värde | FileFormat [] | FileFormat[] innehåller informationen nedan. |
| value.contentTypes | sträng[] | Innehållstyper som stöds för det här formatet. |
| value.defaultVersion | sträng | Standardversion om ingen har angetts. |
| value.fileExtensions | sträng[] | 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 | Typ | Description |
|---|---|---|
| kod | sträng | Uppräkningar som innehåller felkoder på hög nivå. Möjliga värden:
|
| meddelande | sträng | Hämtar felmeddelande på hög nivå. |
| innerError | InnerTranslationError | Nytt format för inre fel som överensstämmer Cognitive Services API-riktlinjer. Den innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error (detta 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 kan till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt. |
Exempel
Exempel på lyckat svar
Följande ä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 ä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.