Získání podporovaných formátů glosáře

Článek
06/01/2024

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ů glosáře podporovaných funkcí Překlad dokumentu. Seznam obsahuje běžné přípony souborů.

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=glossary"

Záhlaví žádosti

Hlavičky požadavku jsou:

Hlavičky	Popis	Podmínka
Ocp-Apim-Subscription-Key	Klíč rozhraní API služby Translator z webu Azure Portal.	Požaduje se
Ocp-Apim-Subscription-Region	Oblast, ve které byl prostředek vytvořen.	• Vyžaduje se při použití regionálního (geografického) prostředku, jako je USA – západ. & odrážka.
Typ obsahu	Typ obsahu datové části. Přijatá hodnota je application/json nebo charset=UTF-8.	• Povinné

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ů glosáře.
500	Vnitřní chyba serveru.
Další stavové kódy	• Příliš mnoho požadavků • Server je dočasný nedostupný

Získání odpovědi na podporované formáty glosáře

Základní typ pro vrácení seznamu v rozhraní API podporovaných formátů glosáře

Úspěšná odpověď na podporované formáty glosáře

Základní typ pro vrácení seznamu v rozhraní API podporovaných formátů glosáře

Name	Typ	Popis
hodnota	Formát souboru []	FileFormat[] obsahuje uvedené podrobnosti.
value.contentTypes	řetězec []	Podporované typy obsahu pro tento formát
value.defaultVersion	string	Výchozí verze, pokud není zadána žádná
value.fileExtensions	řetězec []	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 •Neoprávněným
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. Například by to bylo `documents` nebo `document id` pokud byl neplatný dokument.

Příklady

Příklad úspěšné odpovědi

Následující objekt JSON je příkladem úspěšné odpovědi.

{
    "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"
            ]
        }
    ]
}

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.

Začínáme s překladem dokumentů

Sdílet prostřednictvím