DocumentTranslationClient Class

Begin translating the document(s) in your source container to your target container in the given language.

For supported languages and document formats, see the service documentation: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview

begin_translation(source_url: str, target_url: str, target_language: str, *, source_language: str | None = None, prefix: str | None = None, suffix: str | None = None, storage_type: str | StorageInputType | None = None, category_id: str | None = None, glossaries: List[TranslationGlossary] | None = None, **kwargs: Any) -> DocumentTranslationLROPoller[ItemPaged[DocumentStatus]]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Translate the documents in your storage container.

   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.translation.document import DocumentTranslationClient

   endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
   key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
   source_container_url = os.environ["AZURE_SOURCE_CONTAINER_URL"]
   target_container_url = os.environ["AZURE_TARGET_CONTAINER_URL"]

   client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))

   poller = client.begin_translation(source_container_url, target_container_url, "fr")
   result = poller.result()

   print(f"Status: {poller.status()}")
   print(f"Created on: {poller.details.created_on}")
   print(f"Last updated on: {poller.details.last_updated_on}")
   print(f"Total number of translations on documents: {poller.details.documents_total_count}")

   print("\nOf total documents...")
   print(f"{poller.details.documents_failed_count} failed")
   print(f"{poller.details.documents_succeeded_count} succeeded")

   for document in result:
       print(f"Document ID: {document.id}")
       print(f"Document status: {document.status}")
       if document.status == "Succeeded":
           print(f"Source document location: {document.source_document_url}")
           print(f"Translated document location: {document.translated_document_url}")
           print(f"Translated to language: {document.translated_to}\n")
       elif document.error:
           print(f"Error Code: {document.error.code}, Message: {document.error.message}\n")

Cancel a currently processing or queued translation operation. A translation will not be canceled if it is already completed, failed, or canceling. All documents that have completed translation will not be canceled and will be charged. If possible, all pending documents will be canceled. :param str translation_id: The translation operation ID. :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError or ~azure.core.exceptions.ResourceNotFoundError:

cancel_translation(translation_id: str, **kwargs: Any) -> None

Parameters

Close the DocumentTranslationClient session.

close() -> None

Returns the status for a specific document.

Returns the translation status for a specific document based on the request Id and document Id.

get_document_status(translation_id: str, document_id: str, **kwargs: Any) -> DocumentStatus

Parameters

Returns

Exceptions

Get the list of the document formats supported by the Document Translation service.

get_supported_document_formats(**kwargs: Any) -> List[DocumentTranslationFileFormat]

Returns

Exceptions

Get the list of the glossary formats supported by the Document Translation service.

get_supported_glossary_formats(**kwargs: Any) -> List[DocumentTranslationFileFormat]

Returns

Exceptions

Returns the status for a document translation request.

Returns the status for a document translation request. The status includes the overall request status, as well as the status for documents that are being translated as part of that request.

get_translation_status(translation_id: str, **kwargs: Any) -> TranslationStatus

Parameters

Returns

Exceptions

List all the document statuses for a given translation operation.

list_document_statuses(translation_id: str, *, top: int | None = None, skip: int | None = None, document_ids: List[str] | None = None, statuses: List[str] | None = None, created_after: str | datetime | None = None, created_before: str | datetime | None = None, order_by: List[str] | None = None, **kwargs: Any) -> ItemPaged[DocumentStatus]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

List all the document statuses as they are being translated.

   import os
   import time
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.translation.document import DocumentTranslationClient

   endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
   key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
   source_container_url = os.environ["AZURE_SOURCE_CONTAINER_URL"]
   target_container_url = os.environ["AZURE_TARGET_CONTAINER_URL"]

   client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))

   poller = client.begin_translation(source_container_url, target_container_url, "es")

   completed_docs = []
   while not poller.done():
       time.sleep(30)

       doc_statuses = client.list_document_statuses(poller.id)
       for document in doc_statuses:
           if document.id not in completed_docs:
               if document.status == "Succeeded":
                   print(
                       f"Document at {document.source_document_url} was translated to {document.translated_to} "
                       f"language. You can find translated document at {document.translated_document_url}"
                   )
                   completed_docs.append(document.id)
               if document.status == "Failed" and document.error:
                   print(
                       f"Document at {document.source_document_url} failed translation. "
                       f"Error Code: {document.error.code}, Message: {document.error.message}"
                   )
                   completed_docs.append(document.id)
               if document.status == "Running":
                   print(
                       f"Document ID: {document.id}, translation progress is "
                       f"{document.translation_progress * 100} percent"
                   )

   print("\nTranslation completed.")

List all the submitted translation operations under the Document Translation resource.

list_translation_statuses(*, top: int | None = None, skip: int | None = None, translation_ids: List[str] | None = None, statuses: List[str] | None = None, created_after: str | datetime | None = None, created_before: str | datetime | None = None, order_by: List[str] | None = None, **kwargs: Any) -> ItemPaged[TranslationStatus]

Keyword-Only Parameters

Returns

Exceptions

Examples

List all submitted translations under the resource.

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.translation.document import DocumentTranslationClient

   endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
   key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]

   client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))
   operations = client.list_translation_statuses()

   for operation in operations:
       print(f"ID: {operation.id}")
       print(f"Status: {operation.status}")
       print(f"Created on: {operation.created_on}")
       print(f"Last updated on: {operation.last_updated_on}")
       print(f"Total number of operations on documents: {operation.documents_total_count}")
       print(f"Total number of characters charged: {operation.total_characters_charged}")

       print("\nOf total documents...")
       print(f"{operation.documents_failed_count} failed")
       print(f"{operation.documents_succeeded_count} succeeded")
       print(f"{operation.documents_canceled_count} canceled\n")

Runs the network request through the client's chained policies.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse

Parameters

Keyword-Only Parameters

Returns