Támogatott dokumentumformátumok lekérése
Referenciafunkció: Azure AI Translator → Document Translation
API-verzió: 2024-05-01
HTTP-módszer: GET
Ez a metódus a Dokumentumfordítás funkció által támogatott dokumentumformátumok listáját adja vissza. A lista gyakori fájlkiterjesztéseket és tartalomtípusokat tartalmaz, ha a feltöltési API-t használja.
URL-cím kérése
Fontos
A Dokumentumfordítás szolgáltatáshoz érkező összes API-kéréshez egyéni tartományvégpont szükséges, amely az Azure Portal erőforrás-áttekintési oldalán található.
curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=document"
Kérésfejlécek
A kérelemfejlécek a következők:
Fejlécek | Leírás |
---|---|
Ocp-Apim-Subscription-Key | Szükséges kérelemfejléc |
Válaszállapot-kódok
A következő lehetséges HTTP-állapotkódokat adja vissza egy kérés.
Állapotkód | Leírás |
---|---|
200 | OK. A támogatott dokumentumfájl-formátumok listáját adja vissza. |
500 | Belső kiszolgálóhiba. |
Egyéb állapotkódok | • Túl sok kérés • A kiszolgáló ideiglenesen nem érhető el |
Fájlformátumra adott válasz
Sikeres fileFormatListResult válasz
A rendszer a következő adatokat adja vissza egy sikeres válaszban.
Név | Típus | Leírás |
---|---|---|
Érték | FileFormat [] | A FileFormat[] a felsorolt adatokat tartalmazza. |
value.contentTypes | sztring[] | Támogatott tartalomtípusok ehhez a formátumhoz. |
value.defaultVersion | húr | Alapértelmezett verzió, ha nincs megadva. |
value.fileExtensions | sztring[] | Ehhez a formátumhoz támogatott fájlkiterjesztés. |
value.format | húr | A formátum neve. |
value.versions | sztring [] | Támogatott verzió. |
Hibaválasz
Név | Típus | Leírás |
---|---|---|
code | húr | Magas szintű hibakódokat tartalmazó enumerálások. Lehetséges értékek: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Illetéktelen |
üzenet | húr | Magas szintű hibaüzenetet kap. |
innerError | InnerTranslationError | Új belső hibaformátum, amely megfelel az Azure AI-szolgáltatások API-irányelveinek. Ez a hibaüzenet tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és opcionális tulajdonságcél, részletek (kulcsértékpár), belső hiba (beágyazható). |
innerError.code | húr | Kódhiba sztringet kap. |
innerError.message | húr | Magas szintű hibaüzenetet kap. |
innerError.target | húr | Lekéri a hiba forrását. Például érvénytelen dokumentumról van szó documents document id . |
Példák
Példa a sikeres válaszra
A következő JSON-objektum egy sikeres válasz példája.
Állapotkó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élda hibaválaszra
Az alábbi JSON-objektum egy példa egy hibaválaszra. A többi hibakód sémája ugyanaz.
Állapotkód: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Következő lépések
A dokumentumfordítás és az ügyféloldali kódtár használatával kapcsolatos további információkért kövesse a rövid útmutatót.