Delen via

Status ophalen voor een specifiek document

  • Artikel

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

Deze methode retourneert de status voor een specifiek document in een taak, zoals aangegeven in de aanvraag door de id en documentId queryparameters.

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

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

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

id De en documentId waarden zoeken

  • U vindt de taak id in de URL-waarde van de POST-methode-antwoordheader start-batch-translation Operation-Location . De laatste parameter van de URL is de taak idvan de bewerking:
Antwoordheader Resultaat-URL
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

Aanvraagheaders

Aanvraagheaders zijn:

Kopteksten Beschrijving
Ocp-Apim-Subscription-Key Vereiste aanvraagheader

Antwoordstatuscodes

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

Statuscode Beschrijving
200 OK. Geslaagde aanvraag geaccepteerd door de service. De details van de bewerking worden geretourneerd. HeadersRetry-After: integerETag: tekenreeks
401 Onbevoegd. Controleer uw referenties.
404 Niet gevonden. De resource is niet gevonden.
500 Interne serverfout.
Overige statuscodes • Te veel aanvragen
• Server tijdelijk niet beschikbaar

Antwoord van documentstatus ophalen

Geslaagd antwoord van documentstatus ophalen

Name Type Description
path tekenreeks Locatie van het document of de map.
sourcePath tekenreeks Locatie van het brondocument.
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
to tekenreeks Taalcode van twee letters van To Language. Bekijk de lijst met talen.
Voortgang Nummer Voortgang van de vertaling, indien beschikbaar
id tekenreeks Document-id.
characterCharged geheel getal Er worden tekens in rekening gebracht door de API.

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 een ongeldig document zijn documents of document id voor een ongeldig document.

Voorbeelden

Voorbeeld van geslaagde reactie

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 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