DocumentTranslationClient Class

Definition

Namespace:: Azure.AI.Translation.Document

Assembly:: Azure.AI.Translation.Document.dll

Package:: Azure.AI.Translation.Document v2.0.0

Package:: Azure.AI.Translation.Document v2.0.0-beta.2

Source:: DocumentTranslationClient.cs

Source:: DocumentTranslationClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The DocumentTranslation service client.

public class DocumentTranslationClient

type DocumentTranslationClient = class

Public Class DocumentTranslationClient

Inheritance: Object
DocumentTranslationClient

Constructors

Name	Description
DocumentTranslationClient()	Protected constructor to allow mocking.
DocumentTranslationClient(Uri, AzureKeyCredential, DocumentTranslationClientOptions)	Initializes a new instance of DocumentTranslationClient.
DocumentTranslationClient(Uri, AzureKeyCredential)	Initializes a new instance of DocumentTranslationClient class for the specified service instance.
DocumentTranslationClient(Uri, TokenCredential, DocumentTranslationClientOptions)	Initializes a new instance of DocumentTranslationClient.
DocumentTranslationClient(Uri, TokenCredential)	Initializes a new instance of the DocumentTranslationClient class for the specified service instance.

Properties

Name	Description
Pipeline	The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name	Description
CancelTranslation(Guid, CancellationToken)	Cancel a currently processing or queued translation.
CancelTranslation(Guid, RequestContext)	[Protocol Method] Cancel a currently processing or queued translation This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CancelTranslation(Guid, CancellationToken) convenience overload with strongly typed models first.
CancelTranslationAsync(Guid, CancellationToken)	Cancel a currently processing or queued translation.
CancelTranslationAsync(Guid, RequestContext)	[Protocol Method] Cancel a currently processing or queued translation This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CancelTranslationAsync(Guid, CancellationToken) convenience overload with strongly typed models first.
GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)	Returns the status for all documents in a batch document translation request.
GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext)	[Protocol Method] Returns the status for all documents in a batch document translation request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetDocumentsStatusAsync(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)	Returns the status for all documents in a batch document translation request.
GetDocumentsStatusAsync(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext)	[Protocol Method] Returns the status for all documents in a batch document translation request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDocumentsStatusAsync(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetDocumentStatus(Guid, Guid, CancellationToken)	Returns the status for a specific document.
GetDocumentStatus(Guid, Guid, RequestContext)	[Protocol Method] Returns the status for a specific document This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDocumentStatus(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
GetDocumentStatusAsync(Guid, Guid, CancellationToken)	Returns the status for a specific document.
GetDocumentStatusAsync(Guid, Guid, RequestContext)	[Protocol Method] Returns the status for a specific document This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDocumentStatusAsync(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
GetDocumentTranslationClient(String)	Initializes a new instance of DocumentTranslation.
GetSupportedFormats(Nullable<FileFormatType>, CancellationToken)	Returns a list of supported document formats.
GetSupportedFormats(String, RequestContext)	[Protocol Method] Returns a list of supported document formats This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSupportedFormats(Nullable<FileFormatType>, CancellationToken) convenience overload with strongly typed models first.
GetSupportedFormatsAsync(Nullable<FileFormatType>, CancellationToken)	Returns a list of supported document formats.
GetSupportedFormatsAsync(String, RequestContext)	[Protocol Method] Returns a list of supported document formats This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSupportedFormatsAsync(Nullable<FileFormatType>, CancellationToken) convenience overload with strongly typed models first.
GetTranslationsStatus(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)	Returns a list of batch requests submitted and the status for each request.
GetTranslationsStatus(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext)	[Protocol Method] Returns a list of batch requests submitted and the status for each request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTranslationsStatus(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)	Returns a list of batch requests submitted and the status for each request.
GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext)	[Protocol Method] Returns a list of batch requests submitted and the status for each request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetTranslationStatus(Guid, CancellationToken)	Returns the status for a document translation request.
GetTranslationStatus(Guid, RequestContext)	[Protocol Method] Returns the status for a document translation request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTranslationStatus(Guid, CancellationToken) convenience overload with strongly typed models first.
GetTranslationStatusAsync(Guid, CancellationToken)	Returns the status for a document translation request.
GetTranslationStatusAsync(Guid, RequestContext)	[Protocol Method] Returns the status for a document translation request This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTranslationStatusAsync(Guid, CancellationToken) convenience overload with strongly typed models first.
GetTranslationStatuses(GetTranslationStatusesOptions, CancellationToken)	Get the status results for submitted translation operations.
GetTranslationStatusesAsync(GetTranslationStatusesOptions, CancellationToken)	Get the status results for submitted translation operations.
StartTranslation(DocumentTranslationInput, CancellationToken)	Starts a translation operation which translates the document(s) in your source container to your TranslationTarget(s) in the given language. For document length limits, maximum batch size, and supported document formats, see .
StartTranslation(IEnumerable<DocumentTranslationInput>, CancellationToken)	Starts a translation operation which translates the document(s) in your source container to your TranslationTarget(s) in the given language. For document length limits, maximum batch size, and supported document formats, see .
StartTranslation(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Submit a document translation request to the Document Translation service This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StartTranslation(WaitUntil, TranslationBatch, CancellationToken) convenience overload with strongly typed models first.
StartTranslation(WaitUntil, StartTranslationDetails, CancellationToken)	Submit a document translation request to the Document Translation service.
StartTranslation(WaitUntil, TranslationBatch, CancellationToken)	Submit a document translation request to the Document Translation service.
StartTranslationAsync(DocumentTranslationInput, CancellationToken)	Starts a translation operation which translates the document(s) in your source container to your TranslationTarget(s) in the given language. For document length limits, maximum batch size, and supported document formats, see .
StartTranslationAsync(IEnumerable<DocumentTranslationInput>, CancellationToken)	Starts a translation operation which translates the document(s) in your source container to your TranslationTarget(s) in the given language. For document length limits, maximum batch size, and supported document formats, see .
StartTranslationAsync(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Submit a document translation request to the Document Translation service This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StartTranslationAsync(WaitUntil, TranslationBatch, CancellationToken) convenience overload with strongly typed models first.
StartTranslationAsync(WaitUntil, StartTranslationDetails, CancellationToken)	Submit a document translation request to the Document Translation service.
StartTranslationAsync(WaitUntil, TranslationBatch, CancellationToken)	Submit a document translation request to the Document Translation service.

Applies to

Feedback

Was this page helpful?