Hämta ordlisteformat som stöds

Artikel
11/23/2024

Referensfunktion
: Azure AI Translator → API-version för dokumentöversättning
: HTTP-metoden 2024-05-01
: GET

Den här metoden returnerar en lista över ordlisteformat som stöds av funktionen Dokumentöversättning. Listan innehåller de vanliga filnamnstilläggen.

Begärans-URL

Viktigt!

Alla API-begäranden till funktionen Dokumentöversättning kräver en anpassad domänslutpunkt som finns på resursöversiktssidan i Azure Portal.

curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"

Begärandehuvuden

Begärandehuvuden är:

Sidhuvuden	beskrivning	Villkor
Ocp-Apim-Subscription-Key	Din TRANSLATOR-tjänst-API-nyckel från Azure Portal.	Krävs
Ocp-Apim-Subscription-Region	Den region där resursen skapades.	Krävs när du använder en regional (geografisk) resurs som USA, västra. &punkt.
Innehållstyp	Nyttolastens innehållstyp. Det godkända värdet är application/json eller charset=UTF-8.	Krävs

Svarsstatuskoder

Följande är de möjliga HTTP-statuskoder som en begäran returnerar.

Statuskod	beskrivning
200	OK. Returnerar listan över ordlistefilformat som stöds.
500	Internt serverfel.
Andra statuskoder	• För många förfrågningar • Servern är tillfälligt otillgänglig

Få svar på ordlisteformat som stöds

Bastyp för listretur i API:et Hämta ordlisteformat som stöds.

Svar om ordlisteformat som stöds har lyckats

Bastyp för listretur i API:et Hämta ordlisteformat som stöds.

Namn	Type	Beskrivning
värde	FileFormat []	FileFormat[] innehåller den angivna informationen.
value.contentTypes	sträng []	Innehållstyper som stöds för det här formatet.
value.defaultVersion	sträng	Standardversion om ingen har angetts
value.fileExtensions	sträng []	Filnamnstillägg som stöds för det här formatet.
value.format	sträng	Namnet på formatet.
value.versions	sträng []	Version som stöds.

Felsvar

Namn	Type	Beskrivning
kod	sträng	Uppräkningar som innehåller felkoder på hög nivå. Möjliga värden: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Obehörig
meddelande	sträng	Hämtar felmeddelande på hög nivå.
innerError	InnerTranslationError	Nytt format för inre fel som överensstämmer med API-riktlinjerna för Azure AI-tjänster. Det här felmeddelandet innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel/värde-par), inre fel (det kan kapslas).
innerError.code	sträng	Hämtar kodfelsträngen.
innerError.message	sträng	Hämtar felmeddelande på hög nivå.
innerError.target	sträng	Hämtar källan till felet. Det skulle till exempel vara `documents` eller `document id` om det fanns ett ogiltigt dokument.

Exempel

Exempel på lyckat svar

Följande JSON-objekt är ett exempel på ett lyckat svar.

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

Exempel på felsvar

Följande JSON-objekt är ett exempel på ett felsvar. Schemat för andra felkoder är detsamma.

Statuskod: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Nästa steg

Följ vår snabbstart om du vill veta mer om hur du använder dokumentöversättning och klientbiblioteket.

Kom igång med dokumentöversättning

Dela via