Pobieranie obsługiwanych formatów dokumentów
Funkcja referencyjna
: Azure AI Translator → interfejsu API tłumaczenia
dokumentów Wersja: 2024-05-01
metoda HTTP: GET
Ta metoda zwraca listę formatów dokumentów obsługiwanych przez funkcję tłumaczenia dokumentów. Lista zawiera typowe rozszerzenia plików i typ zawartości w przypadku korzystania z interfejsu API przekazywania.
Adres URL żądania
Ważne
Wszystkie żądania interfejsu API do funkcji tłumaczenia dokumentów wymagają niestandardowego punktu końcowego domeny znajdującego się na stronie przeglądu zasobu w witrynie Azure Portal.
curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=document"
Nagłówki żądań
Nagłówki żądań to:
| Nagłówki | opis |
|---|---|
| Ocp-Apim-Subscription-Key | Wymagany nagłówek żądania |
Kody stanu odpowiedzi
Poniżej przedstawiono możliwe kody stanu HTTP zwracane przez żądanie.
| Kod stanu | opis |
|---|---|
| 200 | OK. Zwraca listę obsługiwanych formatów plików dokumentów. |
| 500 | Wewnętrzny błąd serwera. |
| Inne kody stanu | • Zbyt wiele żądań • Serwer tymczasowy niedostępny |
Odpowiedź na format pliku
Pomyślna odpowiedź fileFormatListResult
Następujące informacje są zwracane w pomyślnej odpowiedzi.
| Nazwisko | Pisz | Opis |
|---|---|---|
| wartość | FileFormat [] | PlikFormat[] zawiera wymienione szczegóły. |
| value.contentTypes | string[] | Obsługiwane typy zawartości dla tego formatu. |
| value.defaultVersion | string | Wersja domyślna, jeśli żadna z nich nie jest określona. |
| value.fileExtensions | string[] | Obsługiwane rozszerzenie pliku dla tego formatu. |
| value.format | string | Nazwa formatu. |
| value.versions | ciąg [] | Obsługiwana wersja. |
Odpowiedź błędna
| Nazwisko | Pisz | Opis |
|---|---|---|
| code | string | Wyliczenia zawierające kody błędów wysokiego poziomu. Możliwe wartości: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Nieautoryzowanych |
| wiadomość | string | Pobiera komunikat o błędzie wysokiego poziomu. |
| innerError | InnerTranslationError | Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług AI platformy Azure. Ten komunikat o błędzie zawiera wymagane właściwości ErrorCode, message i optional properties target, details(key value pair), wewnętrzny błąd (można go zagnieżdżać). |
| innerError.code | string | Pobiera ciąg błędu kodu. |
| innerError.message | string | Pobiera komunikat o błędzie wysokiego poziomu. |
| innerError.target | string | Pobiera źródło błędu. Na przykład byłoby documents to lub document id dla nieprawidłowego dokumentu. |
Przykłady
Przykład pomyślnej odpowiedzi
Poniższy obiekt JSON jest przykładem pomyślnej odpowiedzi.
Kod stanu: 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": []
}
]
}
Przykładowa odpowiedź na błąd
Poniższy obiekt JSON jest przykładem odpowiedzi na błąd. Schemat innych kodów błędów jest taki sam.
Kod stanu: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Następne kroki
Postępuj zgodnie z naszym przewodnikiem Szybki start, aby dowiedzieć się więcej na temat korzystania z tłumaczenia dokumentów i biblioteki klienta.