Delen via

Status ophalen voor alle documenten

  • Artikel

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

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.

  • Gebruik de get documents status methode om de status voor alle documenten in een vertaaltaak aan te vragen.

  • $top, $skipen $maxpagesize queryparameters kunnen worden gebruikt om het aantal resultaten op te geven dat moet worden geretourneerd en een offset voor de verzameling.

    • $top geeft het totale aantal records aan dat de gebruiker op alle pagina's wil retourneren.
    • $skip geeft het aantal records aan dat moet worden overgeslagen uit de lijst met documentstatussen die door de server worden bewaard op basis van de opgegeven sorteermethode. Records worden standaard gesorteerd op aflopende begintijd.
    • $maxpagesize is het maximum aantal items dat op een pagina wordt geretourneerd.
    • Als er meer items worden aangevraagd via $top (of $top niet is opgegeven en er meer items moeten worden geretourneerd), @nextLink bevat deze de koppeling naar de volgende pagina.
    • Als het aantal documenten in het antwoord de limiet voor paging overschrijdt, wordt paging aan de serverzijde gebruikt.
    • Gepagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolgtoken in het antwoord. Het ontbreken van een vervolgtoken betekent dat er geen andere pagina's beschikbaar zijn.

Notitie

Als de server niet kan voldoen $top en/of $skip, moet de server een fout retourneren aan de client die erover informeert in plaats van alleen de queryopties te negeren. Dit vermindert het risico dat de client aannames doet over de geretourneerde gegevens.

  • $orderBy queryparameter kan worden gebruikt om de geretourneerde lijst te sorteren (bijvoorbeeld: $orderBy=createdDateTimeUtc asc of $orderBy=createdDateTimeUtc desc).
  • De standaardsortering is aflopend op createdDateTimeUtc. Sommige queryparameters kunnen worden gebruikt om de geretourneerde lijst te filteren (bijvoorbeeld: status=Succeeded,Cancelled) retourneert alleen voltooide en geannuleerde documenten.
  • De createdDateTimeUtcStart parameters en createdDateTimeUtcEnd query's kunnen worden gecombineerd of afzonderlijk worden gebruikt om een bereik van datum/tijd op te geven om de geretourneerde lijst te filteren.
  • De ondersteunde filterqueryparameters zijn (status, id, createdDateTimeUtcStarten createdDateTimeUtcEnd).
  • Wanneer beide $top en $skip zijn opgenomen, moet de server eerst van toepassing zijn $skip en vervolgens $top op de verzameling.

Aanvraag-URL

Een aanvraag GET versturen naar:

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents?api-version={date}"

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

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter In Vereist Type Description
id path Waar tekenreeks De bewerkings-id.
$maxpagesize query Onwaar geheel getal int32 $maxpagesize is het maximum aantal items dat op een pagina wordt geretourneerd. Als er meer items worden aangevraagd via $top (of $top niet is opgegeven en er meer items moeten worden geretourneerd), @nextLink bevat deze de koppeling naar de volgende pagina. Clients kunnen servergestuurde paging aanvragen met een specifiek paginaformaat door een $maxpagesize voorkeur op te geven. De server MOET deze voorkeur respecteren als het opgegeven paginaformaat kleiner is dan het standaardpaginaformaat van de server.
$orderBy query Onwaar matrix De sorteerquery voor de verzameling (bijvoorbeeld: CreatedDateTimeUtc asc, CreatedDateTimeUtc desc).
$skip query Onwaar geheel getal int32 $skip geeft het aantal records aan dat moet worden overgeslagen uit de lijst met records die door de server worden bewaard op basis van de opgegeven sorteermethode. Standaard sorteren we op aflopende begintijd. Clients kunnen $top en $skip queryparameters gebruiken om het aantal resultaten op te geven dat moet worden geretourneerd en een offset in de verzameling. Wanneer de client beide $top retourneert en $skip, moet de server eerst van toepassing zijn $skip en vervolgens $top op de verzameling. Als de server niet kan voldoen $top en/of $skip, moet de server een fout retourneren aan de client die erover informeert in plaats van alleen de queryopties te negeren.
$top query Onwaar geheel getal int32 $top geeft het totale aantal records aan dat de gebruiker op alle pagina's wil retourneren. Clients kunnen parameters gebruiken $top en $skip query's uitvoeren om het aantal resultaten op te geven dat moet worden geretourneerd en een offset in de verzameling. Wanneer de client beide $top retourneert en $skip, moet de server eerst van toepassing zijn $skip en vervolgens $top op de verzameling. Als de server niet kan voldoen $top en/of $skip, moet de server een fout retourneren aan de client die erover informeert in plaats van alleen de queryopties te negeren.
createdDateTimeUtcEnd query Onwaar tekenreeksdatum/-tijd De einddatum om items eerder op te halen.
createdDateTimeUtcStart query Onwaar tekenreeksdatum/-tijd De begindatum/tijd waarna items worden weergegeven.
ids query Onwaar matrix Id's die moeten worden gebruikt bij filteren.
Statussen query Onwaar matrix Statussen die moeten worden gebruikt bij filteren.

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
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 documenten. HeadersRetry-After: integerETag: tekenreeks
400 Ongeldige aanvraag. Controleer de invoerparameters.
401 Onbevoegd. Controleer uw referenties.
404 De resource is niet gevonden.
500 Interne serverfout.
Overige statuscodes • Te veel aanvragen
• De server is tijdelijk niet beschikbaar

Antwoord op status van documenten ophalen

Geslaagd antwoord op status van documenten ophalen

De volgende informatie wordt geretourneerd in een geslaagd antwoord.

Name Type Description
@nextLink tekenreeks URL voor de volgende pagina. Null als er geen pagina's meer beschikbaar zijn.
waarde DocumentStatus [] De detailstatuslijst van afzonderlijke documenten.
value.path tekenreeks Locatie van het document of de map.
value.sourcePath tekenreeks Locatie van het brondocument.
value.createdDateTimeUtc tekenreeks Bewerking gemaakt datum/tijd.
value.lastActionDateTimeUtc tekenreeks Datum/tijd waarin de status van de bewerking wordt bijgewerkt.
value.status status Lijst met mogelijke statussen voor een taak of document.
• Geannuleerd
•Annuleren
•Mislukt
• Niet gestart
•Lopend
•Geslaagd
• Validatiefailed
value.to tekenreeks Naar taal.
value.progress Nummer Voortgang van de vertaling, indien beschikbaar.
value.id tekenreeks Document-id.
value.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.
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 kan bijvoorbeeld het zijn documents of document id als er een ongeldig document is.

Voorbeelden

Tip

Gebruik deze methode om de parameter voor de documentId queryreeks get-document-status op te halen.

Voorbeeld van geslaagde reactie

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

Voorbeeld van een foutbericht

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

Statuscode: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Volgende stappen

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

Aan de slag met de documentvertaling