Dela via

Hämta status för alla översättningsjobb

  • Artikel

Referensfunktion
: Azure AI Translator → API-version för dokumentöversättning
: HTTP-metoden 2024-05-01
: GET

  • Använd metoden get translations status för att begära en lista och status för alla översättningsjobb som skickats av användaren (associerad med resursen).

  • $top, $skip, och $maxpagesize frågeparametrar kan användas för att ange antalet resultat som ska returneras och en förskjutning för samlingen.

    • $top anger det totala antalet poster som ska returneras på alla sidor.
    • $skip anger antalet poster som ska hoppa från listan över batchar baserat på den angivna sorteringsmetoden. Som standard sorteras posterna efter fallande starttid.
    • $maxpagesize är det högsta antalet objekt som returneras på en sida.
    • Om fler objekt begärs via $top (eller $top inte har angetts och det finns fler objekt som ska returneras) @nextLink innehåller länken till nästa sida.
    • Servern respekterar de värden som anges av klienten. Klienter måste dock vara beredda att hantera svar som innehåller en annan sidstorlek eller som innehåller en fortsättningstoken.
    • När både $top och $skip ingår tillämpas $skip servern först och sedan $top på samlingen.

Kommentar

Om servern inte kan uppfylla $top och/eller $skipmåste servern returnera ett fel till klienten som informerar om det i stället för att bara ignorera frågealternativen. Detta minskar risken för att klienten gör antaganden om de data som returneras.

  • $orderBy frågeparametern kan användas för att sortera den returnerade listan (t.ex. $orderBy=createdDateTimeUtc asc eller $orderBy=createdDateTimeUtc desc).
    • Standardsortering är fallande efter createdDateTimeUtc. Vissa frågeparametrar kan användas för att filtrera den returnerade listan (till exempel status=Succeeded,Cancelled) returnerar lyckade och avbrutna åtgärder.
    • Frågeparametrarna createdDateTimeUtcStart och createdDateTimeUtcEnd kan användas tillsammans eller separat för att ange ett intervall med datetime för att filtrera den returnerade listan.
    • De filtreringsfrågaparametrar som stöds är (status, id, createdDateTimeUtcStartoch createdDateTimeUtcEnd).

Begärans-URL

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

Viktigt!

Alla API-begäranden till funktionen Dokumentöversättning kräver en anpassad domänslutpunkt som finns på resursöversiktssidan i Azure Portal.

Parametrar för begäran

Begärandeparametrar som skickas på frågesträngen är:

Frågeparameter I Obligatoriskt Type Beskrivning
$maxpagesize query Falsk heltals-int32 $maxpagesize är det högsta antalet objekt som returneras på en sida. Om fler objekt begärs via $top (eller $top inte har angetts och det finns fler objekt som ska returneras) @nextLink innehåller länken till nästa sida. Klienter kan begära serverdriven växling med en specifik sidstorlek genom att ange en $maxpagesize inställning. Servern BÖR uppfylla den här inställningen om den angivna sidstorleken är mindre än serverns standardstorlek för sidan.
$orderBy query Falsk matris Sorteringsfrågan för samlingen (t.ex. CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip query Falsk heltals-int32 $skip anger antalet poster som ska hoppa från listan över poster som lagras av servern baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. Klienter kan använda $top och $skip frågeparametrar för att ange antalet resultat som ska returneras och en förskjutning i samlingen. När klienten returnerar både $top och $skipska servern först tillämpas $skip och sedan $top på samlingen. Obs! Om servern inte kan uppfylla $top och/eller $skipmåste servern returnera ett fel till klienten som informerar om det i stället för att bara ignorera frågealternativen.
$top query Falsk heltals-int32 $top anger det totala antalet poster som användaren vill returnera på alla sidor. Klienter kan använda $top och $skip frågeparametrar för att ange antalet resultat som ska returneras och en förskjutning i samlingen. När klienten returnerar både $top och $skipska servern först tillämpas $skip och sedan $top på samlingen. Obs! Om servern inte kan uppfylla $top och/eller $skipmåste servern returnera ett fel till klienten som informerar om det i stället för att bara ignorera frågealternativen.
createdDateTimeUtcEnd query Falsk strängdatum-tid Slutdatumet för att hämta objekt innan.
createdDateTimeUtcStart query Falsk strängdatum-tid Startdatumtid för att hämta objekt efter.
ids query Falsk matris ID:t som ska användas vid filtrering.
statuses query Falsk matris Statusar som ska användas vid filtrering.

Begärandehuvuden

Begärandehuvuden är:

Sidhuvuden beskrivning Villkor
Ocp-Apim-Subscription-Key Din TRANSLATOR-tjänst-API-nyckel från Azure Portal. Krävs
Ocp-Apim-Subscription-Region Den region där resursen skapades. Krävs när du använder en regional (geografisk) resurs som USA, västra.
&punkt.
Innehållstyp Nyttolastens innehållstyp. Det godkända värdet är application/json eller charset=UTF-8. Krävs

Svarsstatuskoder

Följande är de möjliga HTTP-statuskoder som en begäran returnerar.

Statuskod beskrivning
200 OK. Lyckad begäran och returnerar status för alla åtgärder. HeadersRetry-After: integerETag: string
400 Felaktig begäran. Ogiltig begäran Kontrollera indataparametrar.
401 Behörighet saknas. Kontrollera dina autentiseringsuppgifter.
500 Internt serverfel.
Andra statuskoder • För många förfrågningar
• Servern är tillfälligt otillgänglig

Hämta statussvar för översättningar

Statussvar för att hämta översättningar lyckades

Följande information returneras i ett lyckat svar.

Namn Type Beskrivning
@nextLink sträng Url till nästa sida. Null om det inte finns fler tillgängliga sidor.
värde TranslationStatus[] TranslationStatus[] Matris
value.id sträng ID för åtgärden.
value.createdDateTimeUtc sträng Åtgärden skapade datumtid.
value.lastActionDateTimeUtc sträng Datum då åtgärdens status uppdaterades.
value.status String Lista över möjliga statusar för jobb eller dokument:
• Avbröts
•Avbryta
•Misslyckades
• Ej startad
•Löpning
•Lyckades
• ValidationFailed
value.summary StatusSummary[] Sammanfattning som innehåller den angivna informationen.
value.summary.total integer Antal dokument totalt.
value.summary.failed integer Antalet dokument misslyckades.
value.summary.success integer Antal dokument som har översatts.
value.summary.inProgress integer Antal dokument som pågår.
value.summary.notYetStarted integer Antalet dokument som ännu inte har börjat bearbetas.
value.summary.cancelled integer Antal dokument som har avbrutits.
value.summary.totalCharacterCharged integer Totalt antal tecken som debiteras.

Felsvar

Namn Type Beskrivning
kod sträng Uppräkningar som innehåller felkoder på hög nivå. Möjliga värden:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Obehörig
meddelande sträng Hämtar felmeddelande på hög nivå.
mål sträng Hämtar källan till felet. Det skulle till exempel vara documents eller document id om det fanns ett ogiltigt dokument.
innerError InnerTranslationError Nytt format för inre fel som överensstämmer med API-riktlinjerna för Azure AI-tjänster. Det här felmeddelandet innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper, information (nyckelvärdespar), inre fel (det kan kapslas).
innerError.code sträng Hämtar kodfelsträngen.
innerError.message sträng Hämtar felmeddelande på hög nivå.
innerError.target sträng Hämtar källan till felet. Det skulle till exempel vara documents eller document id om det fanns ett ogiltigt dokument.

Exempel

Dricks

Du kan använda den här metoden för att hämta jobbparametern id för frågesträngen get-translation-status .

Exempel på lyckat svar

Följande JSON-objekt är ett exempel på ett lyckat svar.

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

Exempel på felsvar

Följande JSON-objekt är ett exempel på ett felsvar. Schemat för andra felkoder är detsamma.

Statuskod: 500

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

Nästa steg

Följ vår snabbstart om du vill veta mer om hur du använder dokumentöversättning och klientbiblioteket.

Kom igång med dokumentöversättning