Hämta status för ett visst översättningsjobb

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

• get translation status Använd metoden för att begära status för ett visst översättningsjobb. Svaret innehåller den övergripande jobbstatusen och statusen för dokument som översätts som en del av jobbet.

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

Parametrar för begäran

Begärandeparametrar som skickas på frågesträngen är:

Frågeparameter	Obligatoriskt	Beskrivning
id	Sant	Åtgärds-ID:t.

Hitta värdet id

Du hittar jobbet id i POST-metodens start-batch-translation svarshuvud-URL-värde Operation-Location . Den alfanumeriska strängen som följer parametern /document/ är åtgärdens jobb id:

Svarsrubrik	Svars-URL
Åtgärdsplats	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• Du kan också använda en begäran om get-translations-status för att hämta en lista över översättningsjobb och deras.id

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. Lyckad begäran och returnerar status för batchöversättningsåtgärden. HeadersRetry-After: integerETag: string
401	Behörighet saknas. Kontrollera dina autentiseringsuppgifter.
404	Det går inte att hitta resursen.
500	Internt serverfel.
Andra statuskoder	• För många förfrågningar • Servern är tillfälligt otillgänglig

Hämta svar om översättningsstatus

Lyckat svar för att hämta översättningsstatus

Följande information returneras i ett lyckat svar.

Namn	Type	Description
id	sträng	ID för åtgärden.
createdDateTimeUtc	sträng	Åtgärden skapade datumtid.
lastActionDateTimeUtc	sträng	Datum då åtgärdens status uppdaterades.
status	String	Lista över möjliga statusar för jobb eller dokument: • Avbröts •Avbryta •Misslyckades • Ej startad •Löpning •Lyckades • ValidationFailed
Sammanfattning	StatusSumma	Sammanfattning som innehåller den angivna informationen.
summary.total	integer	Totalt antal.
summary.failed	integer	Antal misslyckade.
summary.success	integer	Antal lyckade.
summary.inProgress	integer	Antal pågående.
summary.notYetStarted	integer	Antal som ännu inte har startats.
summary.cancelled	integer	Antal avbrutna.
summary.totalCharacterCharged	integer	Totalt antal tecken som debiteras av API:et.

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å.
mål	sträng	Hämtar källan till felet. Det skulle till exempel vara documents eller document id för ett ogiltigt dokument.
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 för ogiltigt dokument.

Exempel

Exempel på lyckat svar

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

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

Exempel på felsvar

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

Statuskod: 401

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

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