Ondersteunde woordenlijstindelingen ophalen
Referentiefunctie: Azure AI Translator → API-versie van documentomzetting
: 2024-05-01
HTTP-methode: GET
Deze methode retourneert een lijst met woordenlijstindelingen die worden ondersteund door de functie Documentvertaling. De lijst bevat de algemene bestandsextensies.
Aanvraag-URL
Belangrijk
Voor alle API-aanvragen voor de functie Documentvertaling is een aangepast domeineindpunt vereist dat zich op de overzichtspagina van uw resource in Azure Portal bevindt.
curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"
Aanvraagheaders
Aanvraagheaders zijn:
Kopteksten | Beschrijving | Voorwaarde |
---|---|---|
Ocp-Apim-Subscription-Key | De API-sleutel van uw Translator-service vanuit Azure Portal. | Vereist |
Ocp-Apim-Subscription-Region | De regio waar uw resource is gemaakt. | Vereist bij het gebruik van een regionale (geografische) resource, zoals VS - west. & opsommingsteken. |
Content-Type | Het inhoudstype van de nettolading. De geaccepteerde waarde is application/json of charset=UTF-8. | Vereist |
Antwoordstatuscodes
Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.
Statuscode | Beschrijving |
---|---|
200 | OK. Retourneert de lijst met ondersteunde woordenlijstbestandsindelingen. |
500 | Interne serverfout. |
Overige statuscodes | • Te veel aanvragen • Server tijdelijk niet beschikbaar |
Antwoord van ondersteunde woordenlijstindelingen ophalen
Basistype voor lijst retourneren in de API voor ondersteunde woordenlijstindelingen ophalen.
Geslaagde weergave van ondersteunde woordenlijstindelingen
Basistype voor lijst retourneren in de API voor ondersteunde woordenlijstindelingen ophalen.
Name | Type | Description |
---|---|---|
waarde | FileFormat [] | FileFormat[] bevat de vermelde details. |
value.contentTypes | tekenreeks [] | Ondersteunde inhoudstypen voor deze indeling. |
value.defaultVersion | tekenreeks | Standaardversie als er geen is opgegeven |
value.fileExtensions | tekenreeks [] | Ondersteunde bestandsextensie voor deze indeling. |
value.format | tekenreeks | Naam van de notatie. |
value.versions | tekenreeks [] | Ondersteunde versie. |
Foutrespons
Name | Type | Description |
---|---|---|
code | tekenreeks | Opsommingen met foutcodes op hoog niveau. Mogelijke waarden: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Ongeoorloofd |
bericht | tekenreeks | Hiermee wordt een foutbericht op hoog niveau weergegeven. |
innerError | InnerTranslationError | Nieuwe interne foutindeling die voldoet aan api-richtlijnen voor Azure AI-services. Dit foutbericht bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (deze kan worden genest). |
innerError.code | tekenreeks | Hiermee haalt u de codefoutreeks op. |
innerError.message | tekenreeks | Hiermee wordt een foutbericht op hoog niveau weergegeven. |
innerError.target | tekenreeks | Hiermee haalt u de bron van de fout op. Dit kan bijvoorbeeld het zijn documents of document id als er een ongeldig document is. |
Voorbeelden
Voorbeeld van geslaagde reactie
Het volgende JSON-object is een voorbeeld van een geslaagd antwoord.
{
"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"
]
}
]
}
Voorbeeld van een foutbericht
Het volgende JSON-object is een voorbeeld van een foutreactie. Het schema voor andere foutcodes is hetzelfde.
Statuscode: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Volgende stappen
Volg onze quickstart voor meer informatie over het gebruik van documentomzetting en de clientbibliotheek.