Pobieranie stanu dla wszystkich zadań tłumaczenia

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

• get translations status Użyj metody , aby zażądać listy i stanu wszystkich zadań tłumaczenia przesłanych przez użytkownika (skojarzonego z zasobem).

• $topparametrów , $skipi $maxpagesize zapytania można użyć do określenia liczby wyników do zwrócenia i przesunięcia dla kolekcji.

  • $top wskazuje łączną liczbę rekordów, które mają być zwracane na wszystkich stronach.
  • $skip wskazuje liczbę rekordów do pominięcia z listy partii na podstawie określonej metody sortowania. Domyślnie rekordy są sortowane według malejącego czasu rozpoczęcia.
  • $maxpagesize to maksymalna liczba elementów zwracanych na stronie.
  • Jeśli więcej elementów zostanie żądanych za pośrednictwem $top (lub $top nie zostanie określonych i zostanie zwróconych więcej elementów), @nextLink będzie zawierać link do następnej strony.
  • Serwer honoruje wartości określone przez klienta. Jednak klienci muszą być przygotowani do obsługi odpowiedzi zawierających inny rozmiar strony lub token kontynuacji.
  • Po dołączeniu obu $top tych $skip elementów serwer będzie najpierw stosowany $skip , a następnie $top w kolekcji.

Uwaga

Jeśli serwer nie może honorować $top i/lub $skip, serwer musi zwrócić błąd do klienta informującego o nim zamiast ignorować opcje zapytania. Zmniejsza to ryzyko podejmowania przez klienta założeń dotyczących zwracanych danych.

• $orderBy Parametr zapytania może służyć do sortowania zwracanej listy (np. $orderBy=createdDateTimeUtc asc lub $orderBy=createdDateTimeUtc desc).
  • Domyślne sortowanie jest malejące według createdDateTimeUtcwartości . Niektóre parametry zapytania mogą służyć do filtrowania zwracanej listy (np. status=Succeeded,Cancelled) zwraca zakończone powodzeniem i anulowane operacje.
  • Parametry createdDateTimeUtcStart zapytania i createdDateTimeUtcEnd mogą być używane w połączeniu lub oddzielnie, aby określić zakres daty/godziny filtrowania zwracanej listy.
  • Obsługiwane parametry zapytania filtrowania to (status, id, createdDateTimeUtcStarti createdDateTimeUtcEnd).

Adres URL żądania

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

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.

Parametry żądania

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

Parametr zapytania	W	Wymagania	Type	Opis
$maxpagesize	zapytanie	Fałsz	liczba całkowita int32	$maxpagesize to maksymalna liczba elementów zwracanych na stronie. Jeśli więcej elementów zostanie żądanych za pośrednictwem $top (lub $top nie zostanie określonych i zostanie zwróconych więcej elementów), @nextLink będzie zawierać link do następnej strony. Klienci MOGĄ żądać stronicowania opartego na serwerze o określonym rozmiarze strony, określając preferencję $maxpagesize . Serwer powinien przestrzegać tej preferencji, jeśli określony rozmiar strony jest mniejszy niż domyślny rozmiar strony serwera.
$orderBy	zapytanie	Fałsz	tablica	Zapytanie sortowania dla kolekcji (np. CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip	zapytanie	Fałsz	liczba całkowita int32	$skip wskazuje liczbę rekordów do pominięcia z listy rekordów przechowywanych przez serwer na podstawie określonej metody sortowania. Domyślnie sortujemy według malejącego czasu rozpoczęcia. Klienci MOGĄ używać $top parametrów zapytania i $skip określać liczbę wyników do zwrócenia i przesunięcie do kolekcji. Gdy klient zwróci wartości i $top $skip, serwer POWINIEN najpierw zastosować $skip , a następnie $top w kolekcji. Uwaga: Jeśli serwer nie może honorować $top i/lub $skip, serwer MUSI zwrócić błąd do klienta informujący o nim zamiast ignorować opcje zapytania.
$top	zapytanie	Fałsz	liczba całkowita int32	$top wskazuje łączną liczbę rekordów, które użytkownik chce zwrócić na wszystkich stronach. Klienci MOGĄ używać $top parametrów zapytania i $skip określać liczbę wyników do zwrócenia i przesunięcie do kolekcji. Gdy klient zwróci wartości i $top $skip, serwer POWINIEN najpierw zastosować $skip , a następnie $top w kolekcji. Uwaga: Jeśli serwer nie może honorować $top i/lub $skip, serwer MUSI zwrócić błąd do klienta informujący o nim zamiast ignorować opcje zapytania.
createdDateTimeUtcEnd	zapytanie	Fałsz	ciąg daty i godziny	Data/godzina zakończenia pobierania elementów przed.
createdDateTimeUtcStart	zapytanie	Fałsz	ciąg daty i godziny	Data/godzina rozpoczęcia pobierania elementów po.
ids	zapytanie	Fałsz	tablica	Identyfikatory do użycia w filtrowaniu.
statuses	zapytanie	Fałsz	tablica	Stany do użycia w filtrowaniu.

Nagłówki żądań

Nagłówki żądań to:

Nagłówki	opis	Warunek
Ocp-Apim-Subscription-Key	Klucz interfejsu API usługi Translator z witryny Azure Portal.	Wymagane
Ocp-Apim-Subscription-Region	Region, w którym utworzono zasób.	Wymagane w przypadku korzystania z zasobu regionalnego (geograficznego), takiego jak Zachodnie stany USA. &punktor.
Typ zawartości	Typ zawartości ładunku. Zaakceptowana wartość to application/json lub charset=UTF-8.	Wymagane

Kody stanu odpowiedzi

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

Kod stanu	opis
200	OK. Pomyślne żądanie i zwraca stan wszystkich operacji. HeadersRetry-After: integerETag: string
400	Nieprawidłowe żądanie. Nieprawidłowa prośba. Sprawdź parametry wejściowe.
401	Brak autoryzacji. Sprawdź poświadczenia.
500	Wewnętrzny błąd serwera.
Inne kody stanu	• Zbyt wiele żądań • Serwer tymczasowy niedostępny

Uzyskiwanie odpowiedzi na stan tłumaczenia

Pomyślna odpowiedź na stan tłumaczenia

Następujące informacje są zwracane w pomyślnej odpowiedzi.

Nazwisko	Pisz	Opis
@nextLink	string	Adres URL następnej strony. Wartość null, jeśli nie ma więcej dostępnych stron.
wartość	TranslationStatus[]	TranslationStatus[] Tablica
value.id	string	Identyfikator operacji.
value.createdDateTimeUtc	string	Operacja utworzona data/godzina.
value.lastActionDateTimeUtc	string	Data i godzina aktualizacji stanu operacji.
value.status	String	Lista możliwych stanów zadania lub dokumentu: • Anulowana •Anulowanie •Nie powiodło się • Niestartowane •Bieganie •Zakończyła się pomyślnie • ValidationFailed
value.summary	StatusSummary[]	Podsumowanie zawierające wymienione szczegóły.
value.summary.total	integer	Liczba wszystkich dokumentów.
value.summary.failed	integer	Liczba dokumentów nie powiodła się.
value.summary.success	integer	Liczba pomyślnie przetłumaczonych dokumentów.
value.summary.inProgress	integer	Liczba dokumentów w toku.
value.summary.notYetStarted	integer	Liczba dokumentów, które nie rozpoczęły jeszcze przetwarzania.
value.summary.cancelled	integer	Liczba anulowanych dokumentów.
value.summary.totalCharacterCharged	integer	Łączna liczba znaków, które są naliczane.

Odpowiedź błędna

Nazwisko	Pisz	Opis
code	string	Wyliczenia zawierające kody błędów wysokiego poziomu. Możliwe wartości: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Nieautoryzowanych
wiadomość	string	Pobiera komunikat o błędzie wysokiego poziomu.
target	string	Pobiera źródło błędu. Na przykład byłoby documents to lub document id gdyby dokument był nieprawidłowy.
innerError	InnerTranslationError	Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług AI platformy Azure. 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	string	Pobiera ciąg błędu kodu.
innerError.message	string	Pobiera komunikat o błędzie wysokiego poziomu.
innerError.target	string	Pobiera źródło błędu. Na przykład byłoby documents to lub document id gdyby dokument był nieprawidłowy.

Przykłady

Napiwek

Za pomocą tej metody można pobrać parametr zadania id dla ciągu zapytania get-translation-status .

Przykład pomyślnej odpowiedzi

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

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

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: 500

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

Następne kroki

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

Wprowadzenie do tłumaczenia dokumentów