Udostępnij przez

Uzyskiwanie stanu określonego dokumentu

Funkcja referencyjna
: Azure Translator → Interfejs API tłumaczenia
dokumentów Wersja: 2024-05-01
metoda HTTP: GET

Ta metoda zwraca stan określonego dokumentu w zadaniu, jak wskazano w żądaniu przez id parametry zapytania i documentId .

Adres URL żądania

Ważne

Wszystkie żądania interfejsu API do funkcji tłumaczenia dokumentów wymagają niestandardowego punktu końcowego domeny znajdującego się na stronie przeglądu zasobu w witrynie Azure Portal.

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

Parametry żądania

Parametry żądania przekazane w ciągu zapytania to:

Parametr zapytania Wymagania opis
documentId Prawda Identyfikator dokumentu.
id Prawda Identyfikator partii.

Lokalizowanie id wartości i documentId

  • Zadanie id można znaleźć w wartości adresu URL nagłówka start-batch-translation odpowiedzi metody POSTOperation-Location. Ostatnim parametrem adresu URL jest zadanie idoperacji :
Nagłówek odpowiedzi Adres URL wyniku
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

  • Możesz również użyć żądania stanu tłumaczenia GET, aby pobrać parametry zadania id dla ciągu zapytania.

  • Parametr można znaleźć documentId w odpowiedzi metody get-documents-status.

Nagłówki żądań

Nagłówki żądań to:

Nagłówki opis
Ocp-Apim —Subscription-Key Wymagany nagłówek żądania

Kody stanu odpowiedzi

Poniżej przedstawiono możliwe kody stanu HTTP zwracane przez żądanie.

Kod stanu opis
200 OK. Pomyślne żądanie zaakceptowane przez usługę. Zwracane są szczegóły operacji. HeadersRetry-After: integerETag: string
401 Brak autoryzacji. Sprawdź poświadczenia.
404 Nie znaleziono. Nie można odnaleźć zasobu.
500 Wewnętrzny błąd serwera.
Inne kody stanu • Zbyt wiele żądań
• Serwer tymczasowy niedostępny

Uzyskiwanie odpowiedzi na stan dokumentu

Pomyślna odpowiedź na stan dokumentu

Nazwisko Typ opis
ścieżka ciąg Lokalizacja dokumentu lub folderu.
sourcePath (ścieżka źródłowa) ciąg Lokalizacja dokumentu źródłowego.
createdDateTimeUtc ciąg Operacja utworzona data/godzina.
lastActionDateTimeUtc ciąg Data i godzina aktualizacji stanu operacji.
stan Sznurek Lista możliwych stanów zadania lub dokumentu:
• Anulowana
•Anulowanie
•Nie powiodło się
• Niestartowane
•Bieganie
•Zakończyła się pomyślnie
• ValidationFailed
na wartość ciąg Dwuliterowy kod języka to language. Zobacz listę języków.
Postęp Liczba Postęp tłumaczenia, jeśli jest dostępny
id ciąg Identyfikator dokumentu.
characterCharged liczba całkowita Znaki naliczane przez interfejs API.

Odpowiedź błędna

Nazwisko Typ opis
kod ciąg Wyliczenia zawierające kody błędów wysokiego poziomu. Zaakceptowane wartości:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Nieautoryzowanych
komunikat ciąg Pobiera komunikat o błędzie wysokiego poziomu.
błąd wewnętrzny InnerTranslationError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API narzędzi Foundry Tools. Ten komunikat o błędzie zawiera wymagane właściwości ErrorCode, message i optional properties target, details(key value pair), wewnętrzny błąd (można go zagnieżdżać).
innerError.code ciąg Pobiera ciąg błędu kodu.
wiadomośćBłęduWewnętrznego ciąg Pobiera komunikat o błędzie wysokiego poziomu.
innerError.target ciąg Pobiera źródło błędu. Na przykład byłoby documents to lub document id dla nieprawidłowego dokumentu.

Przykłady

Przykład pomyślnej odpowiedzi

Poniższy obiekt JSON jest przykładem pomyślnej odpowiedzi.

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

Przykładowa odpowiedź na błąd

Poniższy obiekt JSON jest przykładem odpowiedzi na błąd. Schemat innych kodów błędów jest taki sam.

Kod stanu: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Następne kroki

Postępuj zgodnie z naszym przewodnikiem Szybki start, aby dowiedzieć się więcej o korzystaniu z tłumaczenia dokumentów i biblioteki klienta.

Wprowadzenie do tłumaczenia dokumentów

  • Last updated on