Sdílet prostřednictvím

Zrušit překlad

  • Článek

Referenční
funkce: Azure AI Translator → verze rozhraní API pro překlad
dokumentů: 2024-05-01
HTTP metoda: DELETE

  • Tato metoda zruší úlohu překladu, která se aktuálně zpracovává nebo zařadí do fronty (čeká), jak je uvedeno v požadavku parametrem id dotazu.
  • Operace se nezruší, pokud už je dokončená, selhala nebo stále probíhá. V těchto případech se vrátí chybný požadavek.
  • Dokončené překlady nejde zrušit a účtují se vám poplatky.

Adresa URL požadavku

Důležité

Všechny požadavky rozhraní API na funkci Překlad dokumentů vyžadují vlastní koncový bod domény umístěný na stránce přehledu prostředků na webu Azure Portal.

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

Parametry požadavku

Parametry požadavku předané v řetězci dotazu jsou:

Parametr dotazu Požadováno Popis
id True ID operace.

Vyhledání id hodnoty

Úlohu id najdete v hodnotě adresy URL hlavičky Operation-Location odpovědi metody POSTstart-batch-translation. Alfanumerický řetězec za /document/ parametrem je úloha idoperace:

Hlavička odpovědi Adresa URL odpovědi
Umístění operace {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Záhlaví žádosti

Hlavičky požadavku jsou:

Hlavičky Popis
Ocp-Apim-Subscription-Key Požadovaná hlavička požadavku

Stavové kódy odpovědí

Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.

Kód stavu Popis
200 OK. Žádost o zrušení odeslaná
401 Neautorizováno Zkontrolujte přihlašovací údaje.
404 Nenalezena. Prostředek nebyl nalezen.
500 Vnitřní chyba serveru.
Další stavové kódy • Příliš mnoho požadavků
• Server je dočasný nedostupný

Zrušit odpověď na překlad

Úspěšná odpověď

Následující informace se vrátí v úspěšné odpovědi.

Name Typ Description
id string ID operace.
createdDateTimeUtc string Operace vytvořila datum a čas.
lastActionDateTimeUtc string Datum a čas, kdy se aktualizuje stav operace.
stav Řetězcové Seznam možných stavů pro úlohu nebo dokument: • Zrušeno
•Zrušení
•Se nezdařilo
• NotStarted
•Spuštění
•Podařilo
• Ověření se nezdařilo.
Souhrn StatusSummary Souhrn obsahující seznam podrobností
summary.total integer Počet celkového počtu dokumentů
summary.failed integer Počet dokumentů se nezdařil.
summary.success integer Počet dokumentů byl úspěšně přeložen.
summary.inProgress integer Počet probíhajících dokumentů
summary.notYetStarted integer Počet dokumentů ještě nezačala zpracovávat.
summary.cancelled integer Počet zrušených
summary.totalCharacterCharged integer Celkový počet znaků účtovaných rozhraním API

Chybná odpověď

Name Typ Popis
code string Výčty obsahující kódy chyb vysoké úrovně. Možné hodnoty:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Neoprávněným
zpráva string Získá chybovou zprávu vysoké úrovně.
target string Získá zdroj chyby. Může to být například "dokumenty" nebo document id neplatný dokument.
innerError InnerTranslationError Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Azure AI Tato chybová zpráva obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details (key value pair), inner error (může být vnořeno).
innerError.code string Získá řetězec chyby kódu.
innerError.message string Získá chybovou zprávu vysoké úrovně.
innerError.target string Získá zdroj chyby. Může se documents jednat například o neplatný dokument nebo document id o neplatný dokument.

Příklady

Příklad úspěšné odpovědi

Následující objekt JSON je příkladem úspěšné odpovědi.

Stavový kód: 200

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Příklad odpovědi na chybu

Následující objekt JSON je příkladem chybové odpovědi. Schéma pro jiné kódy chyb je stejné.

Stavový kód: 500

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

Další kroky

Další informace o použití překladu dokumentů a klientské knihovny najdete v našem rychlém startu.

Začínáme s překladem dokumentů