Documentstatus op halen

De methode Get Document Status retourneert de status voor een specifiek document. De methode retourneert de vertaalstatus voor een specifiek document op basis van de aanvraag-id en document-id.

Aanvraag-URL

Verzend een GET aanvraag naar:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/batches/{id}/documents/{documentId}

Meer informatie over het vinden van uw aangepaste domeinnaam.

Belangrijk

  • Voor alle API-aanvragen voor de documentvertalingsservice is een aangepast domein-eindpunt vereist.
  • U kunt het eindpunt dat u op uw Azure Portal resourcesleutels en eindpuntpagina hebt gevonden, noch het globale translator-eindpunt gebruiken om HTTP-aanvragen te maken voor api.cognitive.microsofttranslator.com documentvertaling.

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter Vereist Beschrijving
documentId Waar De document-id.
id Waar De batch-id.

Aanvraagheaders

Aanvraagheaders zijn:

Kopteksten Beschrijving
Ocp-Apim-Subscription-Key Vereiste aanvraagheader

Antwoordstatuscodes

Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.

Statuscode Description
200 OK. Geslaagde aanvraag en deze wordt geaccepteerd door de service. De bewerkingsdetails worden geretourneerd. HeadersRetry-After: integerETag: string
401 Onbevoegde. Controleer uw referenties.
404 Niet gevonden. De resource is niet gevonden.
500 Interne serverfout.
Andere statuscodes
  • Te veel aanvragen
  • Server tijdelijk niet beschikbaar

Antwoord van documentstatus op halen

Geslaagd antwoord op documentstatus

Naam Type Description
leertraject tekenreeks Locatie van het document of de map.
Sourcepath tekenreeks Locatie van het brondocument.
createdDateTimeUtc tekenreeks Bewerking datum/tijd gemaakt.
lastActionDateTimeUtc tekenreeks De datum waarop de status van de bewerking is bijgewerkt.
status Tekenreeks Lijst met mogelijke statussen voor een taak of document:
  • Geannuleerd
  • Annuleren
  • Mislukt
  • Niet gestart
  • Wordt uitgevoerd
  • Geslaagd
  • ValidationFailed
tot tekenreeks Tweeletterig taalcode van Naar taal. Zie de lijst met talen.
progress getal Voortgang van de vertaling, indien beschikbaar
id tekenreeks Document-id.
teken in rekening gebracht geheel getal Tekens die in rekening worden gebracht door de API.

Foutbericht

Naam Type Description
code tekenreeks Enums met foutcodes op hoog niveau. Mogelijke waarden:
  • InternalServerError
  • InvalidArgument
  • InvalidRequest
  • RequestRateTooHigh
  • ResourceNotFound
  • ServiceUnavailable
  • Niet geautoriseerd
message tekenreeks Haalt een foutbericht op hoog niveau op.
innerError InnerTranslationError Nieuwe interne foutindeling die voldoet aan Cognitive Services API-richtlijnen. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen target, details(sleutel-waardepaar), interne fout (dit kan worden genest).
innerError.code tekenreeks Haalt de codefoutreeks op.
innerError.message tekenreeks Haalt een foutbericht op hoog niveau op.
innerError.target tekenreeks Haalt de bron van de fout op. Dit zijn bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

Voorbeelden

Voorbeeld van een geslaagd antwoord

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

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

Voorbeeld van een foutbericht

Het volgende JSON-object is een voorbeeld van een foutbericht. 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 Documentvertaling en de clientbibliotheek.