Azure Document Translation biblioteka kliencka dla JavaScript - wersja 1.0.0

Translation dokumentów to funkcja tłumaczenia maszynowego oparta na chmurze w usłudze Tłumacz platformy Azure AI. Możesz tłumaczyć wiele i złożonych dokumentów na wszystkie obsługiwane języki i dialekty, zachowując oryginalną strukturę dokumentu i format danych. Interfejs API tłumaczenia dokumentów obsługuje dwa procesy tłumaczenia:

Asynchroniczne tłumaczenie wsadowe obsługuje przetwarzanie wielu dokumentów i dużych plików. Proces tłumaczenia wsadowego wymaga konta usługi Azure Blob Storage z kontenerami przechowywania dla dokumentów źródłowych i przetłumaczonych.

Synchroniczne tłumaczenie pojedynczego pliku wspiera przetwarzanie tłumaczeń pojedynczych plików. Proces tłumaczenia plików nie wymaga konta usługi Azure Blob Storage. Ostateczna odpowiedź zawiera przetłumaczony dokument i jest zwracana bezpośrednio do klienta wywołującego.

Funkcja Translation dokumentów obsługuje następujące operacje:

  • Synchroniczne tłumaczenie dokumentów: Używane do synchronicznego tłumaczenia pojedynczego dokumentu. Metoda nie wymaga konta usługi Azure Blob Storage.
  • Rozpocznij tłumaczenie wsadowe: Służy do wykonania asynchronicznego żądania tłumaczenia wsadowego. Metoda wymaga konta usługi Azure Blob Storage z kontenerami magazynu dla źródłowych i przetłumaczonych dokumentów.
  • Uzyskaj status wszystkich ofert tłumaczeniowych: Służy do żądania listy oraz statusu wszystkich zgłoszeń tłumaczeniowych przesłanych przez użytkownika (powiązanych z zasobem).
  • Uzyskaj status konkretnej pracy tłumaczającej: Używana do zapytania o status konkretnej pracy tłumaczającej. Odpowiedź zawiera ogólny stan zadania i stan dokumentów, które są tłumaczone w ramach tego zadania.
  • Uzyskaj status wszystkich dokumentów: Używany do żądania statusu wszystkich dokumentów w pracy tłumaczającej.
  • Status dla konkretnego dokumentu: Zwraca status konkretnego dokumentu w zadaniu, zgodnie z zapytaniem zaznaczonym parametrami zapytania id i documentId.
  • Anuluj tłumaczenie: Anuluje zadanie tłumaczenia, które jest obecnie przetwarzane lub w kolejce (w trakcie oczekiwania). Operacja nie jest anulowana, jeśli została jeszcze ukończona, nie powiodła się lub nadal anuluje.
  • Uzyskaj obsługiwane formaty: Zwraca listę formatów dokumentów lub słowniczek obsługiwanych przez funkcję Translation dokumentów.

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Wymagania wstępne

Instalowanie pakietu @azure/ai-translation-document

Zainstaluj bibliotekę klienta Azure Document Translation dla JavaScript z :npm

npm install @azure/ai-translation-document

Set up Azure Blob Storage account

Tłumaczenie wsadowe wymaga konta Azure Blob Storage. Więcej informacji o tworzeniu konta Azure Blob Storage znajdziesz tutaj. Aby tworzyć kontenery dla plików źródłowych i docelowych, zobacz tutaj. Upewnij się, że autoryzujesz dostęp do zasobów tłumacza, więcej informacji tutaj.

Gdy "Zezwalaj na dostęp do klucza do konta magazynowego" jest wyłączone na koncie pamięci, na zasobach translatora jest włączona Managed Identity i przypisana jest rola "Storage Blob Data Contributor" na koncie pamięci, wtedy można bezpośrednio korzystać z URL-ów kontenerów i nie będzie trzeba generować żadnych URI SAS.

Uwierzytelnianie klienta

Ta biblioteka udostępnia dwóch klientów:

  • DocumentTranslationClient do operacji tłumaczenia wsadowego i statusu tłumaczenia.
  • SingleDocumentTranslationClient do synchronicznego tłumaczenia pojedynczego dokumentu.

Obaj klienci mogą uwierzytelniać się za pomocą danych Microsoft Entra lub klucza API.

Korzystanie z poświadczenia Microsoft Entra

Możesz uwierzytelnić się za pomocą Microsoft Entra ID, używając poświadczenia z biblioteki @azure/identity. Aby użyć domyślnego dostawcyAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację Microsoft Entra i przyznać dostęp do zasobu Translator, przypisując odpowiednią rolę swojemu przedstawicielowi usługi.

Korzystając z środowisk podobnych do Node.js i Node, możesz użyć DefaultAzureCredential klasy do uwierzytelniania klienta:

import { DocumentTranslationClient } from "@azure/ai-translation-document";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<translator-instance>.cognitiveservices.azure.com";
const client = new DocumentTranslationClient(endpoint, new DefaultAzureCredential());

W środowiskach przeglądarkowych użyj z pakietu @azure/identity do InteractiveBrowserCredential uwierzytelnienia:

import { InteractiveBrowserCredential } from "@azure/identity";
import { DocumentTranslationClient } from "@azure/ai-translation-document";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new DocumentTranslationClient("<endpoint>", credential);

Używanie klucza API

Możesz także uwierzytelnić się za pomocą klucza API zasobu, używając :KeyCredential

import { KeyCredential } from "@azure/core-auth";
import { DocumentTranslationClient } from "@azure/ai-translation-document";

const endpoint = "https://<translator-instance>.cognitiveservices.azure.com";
const credential: KeyCredential = { key: "YOUR_SUBSCRIPTION_KEY" };
const client = new DocumentTranslationClient(endpoint, credential);

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

Klient DocumentTranslationClient

DocumentTranslationClient jest interfejsem do asynchronicznego tłumaczenia wsadowego oraz do zapytań o tłumaczenie i status dokumentów. Tłumaczenie wsadowe wymaga konta Azure Blob Storage z kontenerami na dokumenty źródłowe i przetłumaczone.

SingleDocumentTranslationClient

SingleDocumentTranslationClient jest interfejsem synchronicznego tłumaczenia pojedynczego dokumentu. Nie wymaga konta Azure Blob Storage; przetłumaczony dokument jest zwracany bezpośrednio w odpowiedzi.

Przykłady

Poniższa sekcja zawiera kilka fragmentów kodu obejmujących główne funkcje tej biblioteki klienckiej.

Synchroniczne tłumaczenie dokumentów

Używany do synchronicznego tłumaczenia pojedynczego dokumentu. Metoda nie wymaga konta usługi Azure Blob Storage.

import { SingleDocumentTranslationClient } from "@azure/ai-translation-document";
import { DefaultAzureCredential } from "@azure/identity";
import { writeFile } from "node:fs/promises";

const endpoint = "https://<translator-instance>.cognitiveservices.azure.com";
const client = new SingleDocumentTranslationClient(endpoint, new DefaultAzureCredential());
const response = await client.translate("hi", {
  document: {
    contents: "This is a test.",
    contentType: "text/html",
    filename: "test-input.txt",
  },
});
if (response.readableStreamBody) {
  await writeFile("test-output.txt", response.readableStreamBody);
}

Tłumaczenie dokumentów wsadowych

Używany do wykonywania asynchronicznego żądania tłumaczenia wsadowego. Metoda wymaga konta usługi Azure Blob Storage z kontenerami magazynu dla źródłowych i przetłumaczonych dokumentów. Podaj źródłowe i docelowe adresy URL kontenerów (z tokenami SAS, jeśli są potrzebne) i pytaj do zakończenia operacji.

import { DocumentTranslationClient } from "@azure/ai-translation-document";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<translator-instance>.cognitiveservices.azure.com";
const client = new DocumentTranslationClient(endpoint, new DefaultAzureCredential());
const poller = client.startTranslation({
  inputs: [
    {
      source: { sourceUrl: "<source container SAS URL>" },
      targets: [{ targetUrl: "<target container SAS URL>", language: "fr" }],
    },
  ],
});
const result = await poller.pollUntilDone();
console.log(`Translation status: ${result.status}`);

Pobierz wspierane formaty

Zwraca listę formatów dokumentów obsługiwanych przez funkcję Translation Dokumentów.

import { DocumentTranslationClient } from "@azure/ai-translation-document";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<translator-instance>.cognitiveservices.azure.com";
const client = new DocumentTranslationClient(endpoint, new DefaultAzureCredential());
const formats = await client.getSupportedFormats("Document");
for (const format of formats.value) {
  console.log(format.format);
}

Troubleshooting

Przemysł drzewny

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on