Uzyskiwanie obsługiwanych formatów słownika
Funkcja referencyjna
: Azure AI Translator → interfejsu API tłumaczenia
dokumentów Wersja: 2024-05-01
metoda HTTP: GET
Ta metoda zwraca listę formatów słownika obsługiwanych przez funkcję tłumaczenia dokumentów. Lista zawiera typowe rozszerzenia plików.
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=glossary"
Nagłówki żądań
Nagłówki żądań to:
| Nagłówki | opis | Warunek |
|---|---|---|
| Ocp-Apim-Subscription-Key | Klucz interfejsu API usługi Translator z witryny Azure Portal. | Wymagane |
| Ocp-Apim-Subscription-Region | Region, w którym utworzono zasób. | Wymagane w przypadku korzystania z zasobu regionalnego (geograficznego), takiego jak Zachodnie stany USA. &punktor. |
| Typ zawartości | Typ zawartości ładunku. Zaakceptowana wartość to application/json lub charset=UTF-8. | Wymagane |
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 słownika. |
| 500 | Wewnętrzny błąd serwera. |
| Inne kody stanu | • Zbyt wiele żądań • Serwer tymczasowy niedostępny |
Uzyskiwanie odpowiedzi obsługiwanych formatów słownika
Podstawowy typ listy zwracany w interfejsie API Uzyskiwanie obsługiwanych formatów słownika.
Pomyślna odpowiedź dotycząca obsługiwanych formatów słownika
Podstawowy typ listy zwracany w interfejsie API Uzyskiwanie obsługiwanych formatów słownika.
| Nazwisko | Pisz | Opis |
|---|---|---|
| wartość | FileFormat [] | PlikFormat[] zawiera wymienione szczegóły. |
| value.contentTypes | ciąg [] | 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 | ciąg [] | 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 gdyby dokument był nieprawidłowy. |
Przykłady
Przykład pomyślnej odpowiedzi
Poniższy obiekt JSON jest przykładem pomyślnej odpowiedzi.
{
"value": [
{
"format": "XLIFF",
"fileExtensions": [
".xlf"
],
"contentTypes": [
"application/xliff+xml"
],
"defaultVersion": "1.2",
"versions": [
"1.0",
"1.1",
"1.2"
]
},
{
"format": "TSV",
"fileExtensions": [
".tsv",
".tab"
],
"contentTypes": [
"text/tab-separated-values"
]
},
{
"format": "CSV",
"fileExtensions": [
".csv"
],
"contentTypes": [
"text/csv"
]
}
]
}
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.