Status ophalen voor een specifieke vertaaltaak

Referentiefunctie: Azure AI Translator → API-versie van documentomzetting
: 2024-05-01
HTTP-methode: GET

• Gebruik de get translation status methode om de status van een specifieke vertaaltaak aan te vragen. Het antwoord bevat de algehele taakstatus en de status voor documenten die worden vertaald als onderdeel van die taak.

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/batches/{id}?api-version={date}"

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter	Vereist	Beschrijving
id	Waar	De bewerkings-id.

id De waarde zoeken

U vindt de taak id in de URL-waarde van de POST-methode-antwoordheader start-batch-translation Operation-Location . De alfanumerieke tekenreeks na de /document/ parameter is de taak idvan de bewerking:

Antwoordheader	Antwoord-URL
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• U kunt ook een get-translation-statusaanvraag gebruiken om een lijst met vertaaltaken en hun idtaken op te halen.

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. Geslaagde aanvraag en retourneert de status van de batchvertalingsbewerking. HeadersRetry-After: integerETag: tekenreeks
401	Onbevoegd. Controleer uw referenties.
404	De resource is niet gevonden.
500	Interne serverfout.
Overige statuscodes	• Te veel aanvragen • Server tijdelijk niet beschikbaar

Antwoord van vertaalstatus ophalen

Geslaagd antwoord van vertaalstatus

De volgende informatie wordt geretourneerd in een geslaagd antwoord.

Name	Type	Omschrijving
id	tekenreeks	Id van de bewerking.
createdDateTimeUtc	tekenreeks	Bewerking gemaakt datum/tijd.
lastActionDateTimeUtc	tekenreeks	Datum/tijd waarin de status van de bewerking is bijgewerkt.
status	String	Lijst met mogelijke statussen voor een taak of document: • Geannuleerd •Annuleren •Mislukt • Niet gestart •Lopend •Geslaagd • Validatiefailed
samenvatting	StatusSamenvatting	Samenvatting met de vermelde details.
summary.total	geheel getal	Totaal aantal.
summary.failed	geheel getal	Aantal mislukt.
summary.success	geheel getal	Aantal geslaagde.
summary.inProgress	geheel getal	Het aantal wordt uitgevoerd.
summary.notYetStarted	geheel getal	Aantal nog niet gestart.
summary.cancelled	geheel getal	Aantal geannuleerd.
summary.totalCharacterCharged	geheel getal	Totaal aantal tekens dat door de API wordt in rekening gebracht.

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.
doel	tekenreeks	Hiermee haalt u de bron van de fout op. Dit kan bijvoorbeeld een ongeldig document zijn documents of document id voor een ongeldig document.
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 is documents bijvoorbeeld of document id voor een ongeldig document.

Voorbeelden

Voorbeeld van geslaagde reactie

Het volgende JSON-object is een voorbeeld van een geslaagd antwoord.

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Voorbeeld van een foutbericht

Het volgende JSON-object is een voorbeeld van een foutreactie. Het schema voor andere foutcodes is hetzelfde.

Statuscode: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Volgende stappen

Volg onze quickstart voor meer informatie over het gebruik van documentomzetting en de clientbibliotheek.

Aan de slag met de documentvertaling