Pobieranie stanu dla wszystkich dokumentów

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

• get documents status Użyj metody , aby zażądać stanu wszystkich dokumentów w zadaniu tłumaczenia.

• $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 użytkownik chce zwrócić na wszystkich stronach.
  • $skip wskazuje liczbę rekordów do pominięcia z listy stanu dokumentu przechowywanego przez serwer 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.
  • Jeśli liczba dokumentów w odpowiedzi przekracza limit stronicowania, używane jest stronicowanie po stronie serwera.
  • Odpowiedzi podzielone na strony wskazują częściowy wynik i zawierają token kontynuacji w odpowiedzi. Brak tokenu kontynuacji oznacza, że żadne inne strony nie są dostępne.

• $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 tylko zakończone powodzeniem i anulowane dokumenty.
• createdDateTimeUtcStart Parametry zapytania i createdDateTimeUtcEnd można łączyć lub używać oddzielnie, aby określić zakres daty/godziny filtrowania zwróconej listy.
• Obsługiwane parametry zapytania filtrowania to (status, id, createdDateTimeUtcStarti createdDateTimeUtcEnd).
• Po dołączeniu obu $top elementów $skip i serwer powinien najpierw mieć zastosowanie $skip , a następnie $top w kolekcji.

Adres URL żądania

Wyślij żądanie GET do:

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

Lokalizowanie id wartości

• Zadanie id można znaleźć w wartości adresu URL nagłówka start-batch-translation odpowiedzi metody POSTOperation-Location. Ciąg alfanumeryczny po parametrze /document/ jest zadaniem idoperacji :

• Możesz również użyć żądania get-translations-status, aby pobrać listę zadań tłumaczenia i ich ids.

Parametry żądania

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

Nagłówki żądań

Nagłówki żądań to:

Kody stanu odpowiedzi

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

Uzyskiwanie odpowiedzi na stan dokumentów

Pomyślna odpowiedź na stan dokumentów

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

Odpowiedź błędna

Przykłady

Przykład pomyślnej odpowiedzi

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

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

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 o korzystaniu z tłumaczenia dokumentów i biblioteki klienta.