DocumentTranslationClient class

Tworzy instancję DocumentTranslationClient.

new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)

Parametry

Potok używany przez tego klienta do tworzenia żądań

pipeline: Pipeline

Wartość właściwości

Anuluj obecnie przetwarzanie lub tłumaczenie w kolejce. Tłumaczenie nie zostanie anulowane, jeśli zostało ono już ukończone lub nie powiodło się lub anulowało. Zostanie zwrócone nieprawidłowe żądanie. Wszystkie dokumenty, które zostały ukończone tłumaczenie, nie zostaną anulowane i zostaną naliczone opłaty. Wszystkie oczekujące dokumenty zostaną anulowane, jeśli to możliwe.

function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>

Parametry

Zwraca

Zwraca stan tłumaczenia określonego dokumentu na podstawie identyfikatora żądania i identyfikatora dokumentu.

function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>

Parametry

Zwraca

Lista obsługiwanych formatów obsługiwanych przez usługę tłumaczenia dokumentów. Lista zawiera wspólne rozszerzenie pliku, a także typ zawartości w przypadku korzystania z interfejsu API przekazywania.

function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>

Parametry

Zwraca

Zwraca stan żądania tłumaczenia dokumentu. Stan obejmuje ogólny stan żądania, a także stan dokumentów, które są tłumaczone w ramach tego żądania.

function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>

Parametry

Zwraca

Zwraca stan wszystkich dokumentów w żądaniu tłumaczenia dokumentów wsadowych.

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 dodatkowe strony nie są dostępne.

opcje top, skip i maxPageSize można wykorzystać do określenia liczby wyników do zwrócenia oraz przesunięcia dla kolekcji.

top oznacza łączną liczbę rekordów, które użytkownik chce zwrócić na wszystkich stronach. Skip wskazuje liczbę rekordów do pominięcia z listy statusu dokumentu przechowywanej przez serwer w zależności od określonej metody sortowania. Domyślnie sortujemy według malejącego czasu rozpoczęcia. maxPageSize to maksymalna liczba elementów zwracanych na stronie. Jeśli kolejne przedmioty są zamawiane przez górę (lub góra nie jest określona i jest więcej przedmiotów do zwrotu),

function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>

Parametry

Zwraca

Zwraca listę przesłanych żądań wsadowych i stan każdego żądania. Ta lista zawiera tylko żądania wsadowe przesłane przez użytkownika (na podstawie zasobu).

Jeśli liczba żądań 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 dodatkowe strony nie są dostępne.

opcje top, skip i maxPageSize można wykorzystać do określenia liczby wyników do zwrócenia oraz przesunięcia dla kolekcji.

top oznacza łączną liczbę rekordów, które użytkownik chce zwrócić na wszystkich stronach. Skip wskazuje liczbę rekordów do pominięcia z listy partii zgodnie z podaną metodą sortowania. Domyślnie sortujemy według malejącego czasu rozpoczęcia. maxPageSize to maksymalna liczba elementów zwracanych na stronie. Jeśli kolejne przedmioty są zamawiane przez górę (lub góra nie jest określona i jest więcej przedmiotów do zwrotu),

function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>

Parametry

Zwraca

Użyj tego interfejsu API, aby przesłać żądanie tłumaczenia zbiorczego (wsadowego) do usługi tłumaczenia dokumentów. Każde żądanie może zawierać wiele dokumentów i musi zawierać kontener źródłowy i docelowy dla każdego dokumentu.

Filtr prefiksu i sufiksu (jeśli podano) są używane do filtrowania folderów. Prefiks jest stosowany do ścieżki podrzędnej po nazwie kontenera.

Słowniki/pamięć tłumaczenia można uwzględnić w żądaniu i są stosowane przez usługę podczas tłumaczenia dokumentu.

Jeśli słownik jest nieprawidłowy lub nie jest osiągalny podczas tłumaczenia, w stanie dokumentu jest wyświetlany błąd. Jeśli plik o tej samej nazwie już istnieje w miejscu docelowym, zostanie zastąpiony. Element targetUrl dla każdego języka docelowego musi być unikatowy.

function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>

Parametry

Zwraca