Získání podporovaných formátů dokumentů
Metoda Get supported document formats (Získat podporované formáty dokumentů) vrátí seznam formátů dokumentů podporovaných službou Překlad dokumentů. Seznam obsahuje společnou příponu souboru a typ obsahu, pokud používáte rozhraní API pro nahrávání.
Adresa URL požadavku
Odešlete GET požadavek na:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/documents/formats
Zjistěte, jak najít vlastní název domény.
Důležité
- Všechny požadavky rozhraní API na službu překladu dokumentů vyžadují vlastní koncový bod domény.
- Koncový bod, který najdete na stránce klíčů a koncových bodů prostředku Azure Portal, ani globálního koncového bodu překladače – – nemůžete použít k požadavkům
api.cognitive.microsofttranslator.comHTTP na překlad dokumentů.
Hlavičky požadavku
Hlavičky požadavku jsou:
| Hlavičky | Description |
|---|---|
| Ocp-Apim-Subscription-Key | Požadovaná hlavička požadavku |
Stavové kódy odpovědí
Níže jsou uvedená možná zobrazení stavových kódů HTTP, které požadavek vrátí.
| Stavový kód | Description |
|---|---|
| 200 | OK. Vrátí seznam podporovaných formátů souborů dokumentů. |
| 500 | Vnitřní chyba serveru. |
| Další stavové kódy |
|
Odpověď na formát souboru
Úspěšná odpověď fileFormatListResult
V úspěšné odpovědi se vrátí následující informace.
| Název | Typ | Description |
|---|---|---|
| hodnota | Formát souboru [] | FileFormat[] obsahuje podrobnosti uvedené níže. |
| value.contentTypes | string[] | Podporované typy obsahu pro tento formát |
| value.defaultVersion | řetězec | Výchozí verze, pokud není zadaná. |
| value.fileExtensions | string[] | Podporovaná přípona souboru pro tento formát. |
| value.format | řetězec | Název formátu. |
| value.versions | string [] | Podporovaná verze. |
Chybová odpověď
| Název | Typ | Description |
|---|---|---|
| kód | řetězec | Výčty obsahující kódy chyb vysoké úrovně. Možné hodnoty:
|
| zpráva | řetězec | Zobrazí se chybová zpráva vysoké úrovně. |
| vnitřní chyba | InnerTranslationError | Nový formát vnitřních chyb, který odpovídá Cognitive Services API Guidelines. Obsahuje požadované vlastnosti ErrorCode, zprávy a volitelné vlastnosti cíl, details(pár klíč-hodnota), vnitřní chyba (to může být vnořené). |
| innerError.code | řetězec | Získá řetězec chyby kódu. |
| innerError.message | řetězec | Zobrazí se chybová zpráva vysoké úrovně. |
| innerError.target | řetězec | Získá zdroj chyby. V případě neplatného dokumentu by se například jedná o "documents" nebo "id dokumentu". |
Příklady
Příklad úspěšné odpovědi
Následuje příklad úspěšné odpovědi.
Stavový kód: 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": []
}
]
}
Příklad chybové odpovědi
Následuje příklad chybové odpovědi. Schéma pro jiné kódy chyb je stejné.
Stavový kód: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Další kroky
Další informace o používání překladu dokumentů a klientské knihovny najdete v našem rychlém startu.