Hämta dokumentstatus
Referenstjänst
: Azure AI Document Translation
API-version: v1.1
Metoden Hämta dokumentstatus returnerar statusen för ett visst dokument. Metoden returnerar översättningsstatus för ett visst dokument baserat på begärande-ID och dokument-ID.
Begärans-URL
Skicka en GET
-begäran till:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents/{documentId}
Lär dig hur du hittar ditt anpassade domännamn.
Viktigt!
- Alla API-begäranden till dokumentöversättningstjänsten kräver en anpassad domänslutpunkt.
- Du kan inte använda slutpunkten som finns på azure-portalens resursnycklar och slutpunktssida eller den globala translator-slutpunkten –
api.cognitive.microsofttranslator.com
för att göra HTTP-begäranden till dokumentöversättning.
Parametrar för begäran
Begärandeparametrar som skickas på frågesträngen är:
Frågeparameter | Obligatoriskt | Beskrivning |
---|---|---|
documentId | Sant | Dokument-ID:t. |
id |
Sant | Batch-ID:t. |
Begärandehuvuden
Begärandehuvuden är:
Sidhuvuden | beskrivning |
---|---|
Ocp-Apim-Subscription-Key | Obligatoriskt begärandehuvud |
Svarsstatuskoder
Följande är de möjliga HTTP-statuskoder som en begäran returnerar.
Statuskod | beskrivning |
---|---|
200 | OK. En lyckad begäran har godkänts av tjänsten. Åtgärdsinformationen returneras. HeadersRetry-After: integerETag: string |
401 | Behörighet saknas. Kontrollera dina autentiseringsuppgifter. |
404 | Hittades inte. 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 på dokumentstatus
Hämta dokumentstatussvaret lyckades
Namn | Type | Beskrivning |
---|---|---|
path | sträng | Plats för dokumentet eller mappen. |
sourcePath | sträng | Källdokumentets plats. |
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 •Kör •Lyckades • ValidationFailed |
to | sträng | Språkkod med två bokstäver för Till språk. Se listan över språk. |
Förlopp | Nummer | Översättningens förlopp om det är tillgängligt |
id |
sträng | Dokument-ID. |
characterCharged | integer | 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å. |
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 ett ogiltigt dokument. |
Exempel
Exempel på lyckat svar
Följande JSON-objekt är ett exempel på ett lyckat svar.
{
"path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
"sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
"createdDateTimeUtc": "2020-03-26T00:00:00Z",
"lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
"status": "Running",
"to": "fr",
"progress": 0.1,
"id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
"characterCharged": 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.