Abrufen unterstützter Dokumentformate
Referenz
Dienst: Azure KI-Dokumentübersetzung
API-Version: v1.1
Die Methode „Abrufen unterstützter Dokumentformate“ gibt eine Liste von Dokumentformaten zurück, die vom Dokumentübersetzungsdienst unterstützt werden. Die Liste enthält die gemeinsame Dateierweiterung und den Inhaltstyp, wenn die Upload-AP verwendet wird.
Anfrage-URL
Sendet eine GET-Anforderung an:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
Erfahren Sie, wie Sie Ihren benutzerdefinierten Domänennamenfinden.
Wichtig
- Für alle API-Anforderungen an den Dienst für die Dokumentübersetzung muss ein Endpunkt einer benutzerdefinierten Domäne verwendet werden.
- Zum Senden von HTTP-Anforderungen für die Dokumentübersetzung verwenden Sie nicht den Endpunkt, der im Azure-Portal auf der Ressourcenseite Schlüssel und Endpunkt angegeben ist, und auch nicht den globalen Übersetzungsendpunkt
api.cognitive.microsofttranslator.com.
Anforderungsheader
Anforderungsheader:
| Header | BESCHREIBUNG |
|---|---|
| Ocp-Apim-Subscription-Key | Erforderlicher Anforderungsheader |
Antwortstatuscodes
Im Folgenden finden Sie die möglichen HTTP-Statuscodes, die eine Anforderung zurückgeben kann.
| Statuscode | BESCHREIBUNG |
|---|---|
| 200 | OK. Gibt die Liste der unterstützten Dokument Dateiformate zurück. |
| 500 | Interner Serverfehler. |
| Andere Statuscodes | • Zu viele Anforderungen • Temporärer Server nicht verfügbar |
Dateiformat-Antwort
Erfolgreiche „fileFormatListResult“-Antwort
Die folgenden Informationen werden bei erfolgreicher Antwort zurückgegeben.
| Name | Typ | BESCHREIBUNG |
|---|---|---|
| value | FileFormat [] | „FileFormat[]“ enthält die aufgeführten Details. |
| value.contentTypes | string[] | Unterstützte Inhaltstypen für dieses Format. |
| value.defaultVersion | Zeichenfolge | Standardversion, wenn keine angegeben ist. |
| value.fileExtensions | string[] | Unterstützte Dateierweiterung für dieses Format. |
| value.format | Zeichenfolge | Der Name des Formats. |
| value.versions | string [] | Unterstützte Version. |
Fehlerantwort
| Name | Typ | BESCHREIBUNG |
|---|---|---|
| code | Zeichenfolge | Enumerationen, die High-Level-Fehlercodes enthalten. Mögliche Werte: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Unbefugte |
| message | Zeichenfolge | Ruft High-Level-Fehlermeldung ab. |
| innerError | InnerTranslationError | Neues Format für innere Fehler, das den Richtlinien der Azure KI Services-API entspricht. Diese Fehlermeldung enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler (es kann geschachtelt werden). |
| innerError.code | Zeichenfolge | Ruft Code der Fehlerzeichenfolge ab. |
| innerError.message | Zeichenfolge | Ruft High-Level-Fehlermeldung ab. |
| innerError.target | Zeichenfolge | Ruft die Ursache des Fehlers ab. Dies wäre z. B. documents oder document id im Falle eines ungültigen Dokuments. |
Beispiele
Beispiel für erfolgreiche Antwort
Das folgende JSON-Objekt ist ein Beispiel für eine erfolgreiche Antwort.
Statuscode: 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": []
}
]
}
Beispiel für Fehlerantwort
Das folgende JSON-Objekt ist ein Beispiel für eine Fehlerantwort. Das Schema für andere Fehlercodes ist identisch.
Statuscode: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Nächste Schritte
Befolgen Sie unsere Schnellstartanleitung, um mehr über die Verwendung der Dokumentübersetzung und der Clientbibliothek zu erfahren.