Status ophalen voor alle vertaaltaken

Artikel
06/01/2024

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

Gebruik de get translations status methode om een lijst en de status aan te vragen van alle vertaaltaken die door de gebruiker zijn ingediend (gekoppeld aan de resource).
$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 moet worden 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. 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.
- De server respecteert de waarden die zijn opgegeven door de client. Clients moeten echter voorbereid zijn op het verwerken van antwoorden die een ander paginaformaat bevatten of een vervolgtoken bevatten.
- Wanneer beide $top $skip en zijn opgenomen, wordt de server eerst toegepast $skip en vervolgens $top op de verzameling.

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 geslaagde en geannuleerde bewerkingen.
- 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).

Aanvraag-URL

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

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.

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter	In	Vereist	Type	Description
`$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 parameters gebruiken `$top` en `$skip` opvragen 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. Opmerking: 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` opvragen 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. Opmerking: 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.
`statuses`	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 Vertalen-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. & opsommingsteken.
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 alle bewerkingen. HeadersRetry-After: integerETag: tekenreeks
400	Ongeldig verzoek. Ongeldige aanvraag. Controleer de invoerparameters.
401	Onbevoegd. Controleer uw referenties.
500	Interne serverfout.
Overige statuscodes	• Te veel aanvragen • Server tijdelijk niet beschikbaar

Antwoord van vertalingenstatus ophalen

Geslaagd antwoord van vertalingenstatus 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	TranslationStatus[]	TranslationStatus[] Matrix
value.id	tekenreeks	Id van de bewerking.
value.createdDateTimeUtc	tekenreeks	Bewerking gemaakt datum/tijd.
value.lastActionDateTimeUtc	tekenreeks	Datum/tijd waarin de status van de bewerking is bijgewerkt.
value.status	String	Lijst met mogelijke statussen voor een taak of document: • Geannuleerd •Annuleren •Mislukt • Niet gestart •Met •Geslaagd • Validatiefailed
value.summary	StatusSamenvatting[]	Samenvatting met de vermelde details.
value.summary.total	geheel getal	Het aantal totale documenten.
value.summary.failed	geheel getal	Het aantal documenten is mislukt.
value.summary.success	geheel getal	Het aantal documenten is vertaald.
value.summary.inProgress	geheel getal	Het aantal documenten dat wordt uitgevoerd.
value.summary.notYetStarted	geheel getal	Het aantal documenten dat nog niet is verwerkt.
value.summary.cancelled	geheel getal	Aantal geannuleerde documenten.
value.summary.totalCharacterCharged	geheel getal	Totaal aantal in rekening gebrachte tekens.

Foutrespons

Name	Type	Description
code	tekenreeks	Opsommingen met foutcodes op hoog niveau. Mogelijke waarden: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Onbevoegde
bericht	tekenreeks	Hiermee wordt een foutbericht op hoog niveau weergegeven.
doel	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.
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

U kunt deze methode gebruiken om de taakparameter id voor de queryreeks get-translation-status op te halen.

Voorbeeld van geslaagde reactie

Het volgende JSON-object is 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.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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

Delen via