De vertaalstatus op halen

De methode Get translations status retourneert een lijst met verzonden batchaanvragen en de status voor elke aanvraag. Deze lijst bevat alleen batchaanvragen die door de gebruiker zijn ingediend (op basis van de resource).

Als het aantal aanvragen onze pagineringslimiet overschrijdt, wordt paginering aan de serverzijde gebruikt. Ge pagineerde antwoorden geven een gedeeltelijk resultaat aan en bevatten een vervolg-token in het antwoord. Het ontbreken van een vervolg-token betekent dat er geen andere pagina's beschikbaar zijn.

$top, $skip en $maxpagesize queryparameters kunnen worden gebruikt om een aantal te retourneren resultaten en een offset voor de verzameling op te geven.

$top geeft het totale aantal records aan dat de gebruiker wil geretourneerd op alle pagina's. $skip geeft het aantal records aan dat moet worden overgeslagen uit de lijst met batches op basis van de opgegeven sorteermethode. Standaard sorteren we op aflopende begintijd. $maxpagesize is het maximum aantal items dat op een pagina wordt geretourneerd. Als er meer items worden aangevraagd via $top (of als $top niet is opgegeven en er meer items moeten worden geretourneerd), bevat de koppeling naar @nextLink de volgende pagina.

$orderBy queryparameter kan worden gebruikt om de geretourneerde lijst te sorteren (bijvoorbeeld '$orderBy=createdDateTimeUtc asc' of '$orderBy=createdDateTimeUtc desc'). De standaardseaming is aflopend op createdDateTimeUtc. Sommige queryparameters kunnen worden gebruikt om de geretourneerde lijst te filteren (bijvoorbeeld : "status=Geslaagd,Geannuleerd") retourneert alleen de bewerkingen geslaagd en geannuleerd. createdDateTimeUtcStart en createdDateTimeUtcEnd kunnen worden gecombineerd of afzonderlijk worden gebruikt om een datum/tijd-bereik op te geven waarop de geretourneerde lijst moet worden gefilterd. De ondersteunde filterqueryparameters zijn (status, ID's, createdDateTimeUtcStart, createdDateTimeUtcEnd).

De server respecteert de waarden die zijn opgegeven door de client. Clients moeten echter worden voorbereid op het verwerken van antwoorden die een ander paginaformaat of een vervolg-token bevatten.

Wanneer zowel $top als $skip zijn opgenomen, moet de server eerst $skip toepassen en vervolgens $top op de verzameling.

Notitie

Als de server geen rekening kan houden met $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 veronderstellingen maakt over de geretourneerde gegevens.

Aanvraag-URL

Verzend een GET aanvraag naar:

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

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 In Vereist Type Beschrijving
$maxpagesize query Niet waar integer int32 $maxpagesize is het maximum aantal items dat op een pagina wordt geretourneerd. Als er meer items worden aangevraagd via $top (of als $top niet is opgegeven en er meer items moeten worden geretourneerd), bevat de koppeling naar @nextLink de volgende pagina. Clients kunnen servergestuurde paginering met een specifieke paginagrootte aanvragen door een specifieke $maxpagesize opgeven. De server moet aan deze voorkeur houden als de opgegeven paginagrootte kleiner is dan de standaardpaginagrootte van de server.
$orderBy query Niet waar matrix De sorteerquery voor de verzameling (bijvoorbeeld ' CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')
$skip query Niet waar integer int32 $skip geeft het aantal records aan dat moet worden overgeslagen uit de lijst met records die door de server worden opgeslagen op basis van de opgegeven sorteermethode. Standaard sorteren we op aflopende begintijd. Clients kunnen gebruikmaken $top en $skip queryparameters om een aantal resultaten op te geven dat moet worden retourneert en een offset in de verzameling. Wanneer zowel $top als $skip worden opgegeven door een client, moet de server eerst $skip toepassen en vervolgens $top op de verzameling. Opmerking: als de server de $top en/of $skip niet kan eren, moet de server een fout retourneren aan de client die erover informeert in plaats van alleen de queryopties te negeren.
$top query Niet waar integer int32 $top geeft het totale aantal records aan dat de gebruiker wil geretourneerd op alle pagina's. Clients kunnen gebruikmaken $top en $skip queryparameters om een aantal resultaten op te geven dat moet worden retourneert en een offset in de verzameling. Wanneer zowel $top als $skip worden opgegeven door een client, moet de server eerst $skip toepassen en vervolgens $top op de verzameling. Opmerking: als de server de $top en/of $skip niet kan eren, moet de server een fout retourneren aan de client die erover informeert in plaats van alleen de queryopties te negeren.
createdDateTimeUtcEnd query Niet waar datum/tijd van tekenreeks De einddatum/-tijd waarop items vóór moeten worden op halen.
createdDateTimeUtcStart query Niet waar datum/tijd van tekenreeks De begindatum/-tijd waarop items na moeten worden op halen.
ids query Niet waar matrix Te gebruiken bij het filteren van de ID's.
Statussen query Niet waar matrix De statussen die moeten worden gebruikt bij het filteren.

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 en retourneert de status van alle bewerkingen. HeadersRetry-After: integerETag: string
400 Slechte aanvraag. Ongeldige aanvraag. Controleer de invoerparameters.
401 Onbevoegde. Controleer uw referenties.
500 Interne serverfout.
Andere statuscodes
  • Te veel aanvragen
  • Server tijdelijk niet beschikbaar

Antwoord op vertaalstatus krijgen

Geslaagde get translations status response

De volgende informatie wordt geretourneerd als een geslaagd antwoord.

Naam Type Description
@nextLink tekenreeks URL voor de volgende pagina. Null als er geen pagina's meer beschikbaar zijn.
waarde TranslationStatus[] De matrix TranslationStatus[] die hieronder wordt vermeld
value.id tekenreeks Id van de bewerking.
value.createdDateTimeUtc tekenreeks Datum/tijd van bewerking gemaakt.
value.lastActionDateTimeUtc tekenreeks De datum waarop de status van de bewerking is bijgewerkt.
value.status Tekenreeks Lijst met mogelijke statussen voor een taak of document:
  • Geannuleerd
  • Annuleren
  • Mislukt
  • Niet gestart
  • Wordt uitgevoerd
  • Geslaagd
  • ValidationFailed
value.summary StatusSummary[] Samenvatting met de details die hieronder worden vermeld.
value.summary.total geheel getal Telling van het totale aantal documenten.
value.summary.failed geheel getal Het aantal documenten is mislukt.
value.summary.success geheel getal Aantal documenten dat is vertaald.
value.summary.inProgress geheel getal Aantal documenten dat wordt uitgevoerd.
value.summary.notYetStarted geheel getal Aantal documenten dat nog niet is verwerkt.
value.summary.cancelled geheel getal Aantal geannuleerde documenten.
value.summary.totalCharacterCharged geheel getal Totaal aantal tekens in rekening gebracht.

Foutbericht

Naam Type Beschrijving
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.
Doel tekenreeks Haalt de bron van de fout op. Dit zijn bijvoorbeeld documenten of document-id's als er een ongeldig document is.
innerError InnerTranslationError Nieuwe interne foutindeling die voldoet aan Cognitive Services API-richtlijnen. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, 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's als er een ongeldig document is.

Voorbeelden

Voorbeeld van een geslaagd antwoord

Hier volgt een voorbeeld van een geslaagd antwoord.

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?$top=5&$skip=15"
}

Voorbeeld van een foutbericht

Hier volgt een voorbeeld van een foutbericht. 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 Documentvertaling en de clientbibliotheek.