Hämta status för alla dokument

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

• Använd metoden get documents status för att begära status för alla dokument i ett översättningsjobb.

• $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 användaren vill returnera på alla sidor.
  • $skip anger antalet poster som ska hoppa från listan över dokumentstatus som lagras av servern 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.
  • Om antalet dokument i svaret överskrider vår växlingsgräns används växling på serversidan.
  • Sidnumrerade svar anger ett partiellt resultat och innehåller en fortsättningstoken i svaret. Avsaknaden av en fortsättningstoken innebär att inga andra sidor är tillgängliga.

• $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 endast slutförda och avbrutna dokument.
• 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).
• När både $top och $skip ingår bör servern först tillämpas $skip och sedan $top på samlingen.

Begärans-URL

Skicka en GET-begäran till:

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

Hitta värdet id

• Du hittar jobbet id i POST-metodens start-batch-translation svarshuvud-URL-värde Operation-Location . Den alfanumeriska strängen som följer parametern /document/ är åtgärdens jobb id:

• Du kan också använda en begäran om get-translations-status för att hämta en lista över översättningsjobb och deras.id

Parametrar för begäran

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

Begärandehuvuden

Begärandehuvuden är:

Svarsstatuskoder

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

Hämta dokumentstatussvar

Statussvar för att hämta dokument har lyckats

Följande information returneras i ett lyckat svar.

Felsvar

Exempel

Exempel på lyckat svar

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

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

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.