Dela via

Hämta status för alla dokument

  • Artikel

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

Viktigt!

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

  • 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.

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 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:
Svarsrubrik Svars-URL
Åtgärdsplats {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Parametrar för begäran

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

Frågeparameter I Obligatoriskt Type Beskrivning
id path Sant sträng Åtgärds-ID:t.
$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. 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åga parametrar 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. 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.
Status 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-portalen. Obligatoriskt
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 dokumenten. HeadersRetry-After: integerETag: string
400 Ogiltig begäran. Kontrollera indataparametrar.
401 Behörighet saknas. Kontrollera dina autentiseringsuppgifter.
404 Det går inte att hitta resursen.
500 Internt serverfel.
Andra statuskoder • För många förfrågningar
• Servern är tillfälligt otillgänglig

Hämta dokumentstatussvar

Statussvar för att hämta dokument har lyckats

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 DocumentStatus [] Informationsstatuslistan för enskilda dokument.
value.path sträng Plats för dokumentet eller mappen.
value.sourcePath sträng Källdokumentets plats.
value.createdDateTimeUtc sträng Åtgärden skapade datumtid.
value.lastActionDateTimeUtc sträng Datum då åtgärdens status uppdateras.
value.status status Lista över möjliga statusar för jobb eller dokument.
• Avbröts
•Avbryta
•Misslyckades
• Ej startad
•Kör
•Lyckades
• ValidationFailed
value.to sträng Till språk.
value.progress Nummer Översättningens förlopp om det är tillgängligt.
value.id sträng Dokument-ID.
value.characterCharged integer Tecken som debiteras av API:et.

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 för 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

Använd den här metoden för att hämta parametern documentId för frågesträngen get-document-status .

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.

Kom igång med dokumentöversättning