DocumentTranslationClient.GetSupportedFormatsAsync Method

Definition

Namespace:

Azure.AI.Translation.Document

Assembly:

Azure.AI.Translation.Document.dll

Package:

Azure.AI.Translation.Document v2.0.0-beta.1

Overloads

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.

GetSupportedFormatsAsync(Nullable<FileFormatType>, CancellationToken)

Source:

DocumentTranslationClient.cs

Returns a list of supported document formats.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats>> GetSupportedFormatsAsync (Azure.AI.Translation.Document.FileFormatType? type = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSupportedFormatsAsync : Nullable<Azure.AI.Translation.Document.FileFormatType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats>>
override this.GetSupportedFormatsAsync : Nullable<Azure.AI.Translation.Document.FileFormatType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats>>

Public Overridable Function GetSupportedFormatsAsync (Optional type As Nullable(Of FileFormatType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SupportedFileFormats))

Parameters

type

Nullable<FileFormatType>

the type of format like document or glossary.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<SupportedFileFormats>>

Remarks

The list of supported formats supported by the Document Translation service. The list includes the common file extension, as well as the content-type if using the upload API.

GetSupportedFormatsAsync(String, RequestContext)

Source:

DocumentTranslationClient.cs

[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.

public virtual System.Threading.Tasks.Task<Azure.Response> GetSupportedFormatsAsync (string type, Azure.RequestContext context);

abstract member GetSupportedFormatsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSupportedFormatsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetSupportedFormatsAsync (type As String, context As RequestContext) As Task(Of Response)

Parameters

type

String

the type of format like document or glossary . Allowed values: "document" | "glossary".

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.