Získání podporovaných formátů dokumentů
Referenční
funkce: Azure AI Translator → rozhraní API pro překlad
dokumentů verze: 2024-05-01
METODA HTTP: GET
Tato metoda vrátí seznam formátů dokumentů podporovaných funkcí Překlad dokumentů. Seznam obsahuje běžné přípony souborů a typ obsahu, pokud používáte rozhraní API pro nahrávání.
Adresa URL požadavku
Důležité
Všechny požadavky rozhraní API na funkci Překlad dokumentů vyžadují vlastní koncový bod domény umístěný na stránce přehledu prostředků na webu Azure Portal.
curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=document"
Záhlaví žádosti
Hlavičky požadavku jsou:
| Hlavičky | Popis |
|---|---|
| Ocp-Apim-Subscription-Key | Požadovaná hlavička požadavku |
Stavové kódy odpovědí
Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.
| Kód stavu | Popis |
|---|---|
| 200 | OK. Vrátí seznam podporovaných formátů souborů dokumentů. |
| 500 | Vnitřní chyba serveru. |
| Další stavové kódy | • Příliš mnoho požadavků • Server je dočasný nedostupný |
Odpověď formátu souboru
Úspěšná odpověď fileFormatListResult
Následující informace se vrátí v úspěšné odpovědi.
| Name | Typ | Popis |
|---|---|---|
| hodnota | Formát souboru [] | FileFormat[] obsahuje uvedené podrobnosti. |
| value.contentTypes | string[] | Podporované typy obsahu pro tento formát |
| value.defaultVersion | string | Výchozí verze, pokud není zadána žádná. |
| value.fileExtensions | string[] | Podporované přípony souborů pro tento formát. |
| value.format | string | Název formátu |
| value.versions | řetězec [] | Podporovaná verze |
Chybná odpověď
| Name | Typ | Popis |
|---|---|---|
| code | string | Výčty obsahující kódy chyb vysoké úrovně. Možné hodnoty: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Neautorizovaný |
| zpráva | string | Získá chybovou zprávu vysoké úrovně. |
| innerError | InnerTranslationError | Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Azure AI Tato chybová zpráva obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error(it can be vnořováno). |
| innerError.code | string | Získá řetězec chyby kódu. |
| innerError.message | string | Získá chybovou zprávu vysoké úrovně. |
| innerError.target | string | Získá zdroj chyby. Jedná se documents například o neplatný dokument nebo document id o něj. |
Příklady
Příklad úspěšné odpovědi
Následující objekt JSON je příkladem ú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 odpovědi na chybu
Následující objekt JSON je příkladem 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žití překladu dokumentů a klientské knihovny najdete v našem rychlém startu.