-
Notifications
You must be signed in to change notification settings - Fork 257
/
SingleDocumentTranslationClient.xml
431 lines (431 loc) · 36.6 KB
/
SingleDocumentTranslationClient.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<Type Name="SingleDocumentTranslationClient" FullName="Azure.AI.Translation.Document.SingleDocumentTranslationClient">
<TypeSignature Language="C#" Value="public class SingleDocumentTranslationClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SingleDocumentTranslationClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.Translation.Document.SingleDocumentTranslationClient" />
<TypeSignature Language="VB.NET" Value="Public Class SingleDocumentTranslationClient" />
<TypeSignature Language="F#" Value="type SingleDocumentTranslationClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The SingleDocumentTranslation service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SingleDocumentTranslationClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of SingleDocumentTranslationClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient endpoint" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
</Parameters>
<Docs>
<param name="endpoint">
Supported document Translation endpoint, protocol and hostname, for example:
https://{TranslatorResourceName}-doctranslation.cognitiveservices.azure.com
</param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint, Azure.AI.Translation.Document.DocumentTranslationClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AI.Translation.Document.DocumentTranslationClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri,Azure.AI.Translation.Document.DocumentTranslationClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, options As DocumentTranslationClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri * Azure.AI.Translation.Document.DocumentTranslationClientOptions -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient (endpoint, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="options" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
</Parameters>
<Docs>
<param name="endpoint">
Supported document Translation endpoint, protocol and hostname, for example:
https://{TranslatorResourceName}-doctranslation.cognitiveservices.azure.com
</param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri * Azure.AzureKeyCredential -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri * Azure.Core.TokenCredential -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.Translation.Document.DocumentTranslationClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.Translation.Document.DocumentTranslationClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.Translation.Document.DocumentTranslationClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As DocumentTranslationClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri * Azure.AzureKeyCredential * Azure.AI.Translation.Document.DocumentTranslationClientOptions -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SingleDocumentTranslationClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.Translation.Document.DocumentTranslationClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.Translation.Document.DocumentTranslationClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.Translation.Document.DocumentTranslationClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As DocumentTranslationClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.SingleDocumentTranslationClient : Uri * Azure.Core.TokenCredential * Azure.AI.Translation.Document.DocumentTranslationClientOptions -> Azure.AI.Translation.Document.SingleDocumentTranslationClient" Usage="new Azure.AI.Translation.Document.SingleDocumentTranslationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of SingleDocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="DocumentTranslate">
<MemberSignature Language="C#" Value="public virtual Azure.Response<BinaryData> DocumentTranslate (string targetLanguage, Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage = default, string category = default, bool? allowFallback = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.BinaryData> DocumentTranslate(string targetLanguage, class Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage, string category, valuetype System.Nullable`1<bool> allowFallback, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslate(System.String,Azure.AI.Translation.Document.DocumentTranslateContent,System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DocumentTranslate (targetLanguage As String, documentTranslateContent As DocumentTranslateContent, Optional sourceLanguage As String = Nothing, Optional category As String = Nothing, Optional allowFallback As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member DocumentTranslate : string * Azure.AI.Translation.Document.DocumentTranslateContent * string * string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.DocumentTranslate : string * Azure.AI.Translation.Document.DocumentTranslateContent * string * string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<BinaryData>" Usage="singleDocumentTranslationClient.DocumentTranslate (targetLanguage, documentTranslateContent, sourceLanguage, category, allowFallback, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetLanguage" Type="System.String" />
<Parameter Name="documentTranslateContent" Type="Azure.AI.Translation.Document.DocumentTranslateContent" />
<Parameter Name="sourceLanguage" Type="System.String" />
<Parameter Name="category" Type="System.String" />
<Parameter Name="allowFallback" Type="System.Nullable<System.Boolean>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="targetLanguage">
Specifies the language of the output document.
The target language must be one of the supported languages included in the translation scope.
For example if you want to translate the document in German language, then use targetLanguage=de
</param>
<param name="documentTranslateContent"> Document Translate Request Content. </param>
<param name="sourceLanguage">
Specifies source language of the input document.
If this parameter isn't specified, automatic language detection is applied to determine the source language.
For example if the source document is written in English, then use sourceLanguage=en
</param>
<param name="category">
A string specifying the category (domain) of the translation. This parameter is used to get translations
from a customized system built with Custom Translator. Add the Category ID from your Custom Translator
project details to this parameter to use your deployed customized system. Default value is: general.
</param>
<param name="allowFallback">
Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.
Possible values are: true (default) or false.
</param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Submit a single document translation request to the Document Translation service. </summary>
<returns>To be added.</returns>
<remarks> Use this API to submit a single translation request to the Document Translation Service. </remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="targetLanguage" /> or <paramref name="documentTranslateContent" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="DocumentTranslate">
<MemberSignature Language="C#" Value="public virtual Azure.Response DocumentTranslate (string targetLanguage, Azure.Core.RequestContent content, string contentType, string sourceLanguage = default, string category = default, bool? allowFallback = default, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DocumentTranslate(string targetLanguage, class Azure.Core.RequestContent content, string contentType, string sourceLanguage, string category, valuetype System.Nullable`1<bool> allowFallback, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslate(System.String,Azure.Core.RequestContent,System.String,System.String,System.String,System.Nullable{System.Boolean},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DocumentTranslate (targetLanguage As String, content As RequestContent, contentType As String, Optional sourceLanguage As String = Nothing, Optional category As String = Nothing, Optional allowFallback As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DocumentTranslate : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.DocumentTranslate : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="singleDocumentTranslationClient.DocumentTranslate (targetLanguage, content, contentType, sourceLanguage, category, allowFallback, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetLanguage" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="contentType" Type="System.String" />
<Parameter Name="sourceLanguage" Type="System.String" />
<Parameter Name="category" Type="System.String" />
<Parameter Name="allowFallback" Type="System.Nullable<System.Boolean>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="targetLanguage">
Specifies the language of the output document.
The target language must be one of the supported languages included in the translation scope.
For example if you want to translate the document in German language, then use targetLanguage=de
</param>
<param name="content"> The content to send as the body of the request. </param>
<param name="contentType"> Content Type as multipart/form-data. Allowed values: "multipart/form-data". </param>
<param name="sourceLanguage">
Specifies source language of the input document.
If this parameter isn't specified, automatic language detection is applied to determine the source language.
For example if the source document is written in English, then use sourceLanguage=en
</param>
<param name="category">
A string specifying the category (domain) of the translation. This parameter is used to get translations
from a customized system built with Custom Translator. Add the Category ID from your Custom Translator
project details to this parameter to use your deployed customized system. Default value is: general.
</param>
<param name="allowFallback">
Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.
Possible values are: true (default) or false.
</param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Submit a single document translation request to the Document Translation service
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslate(System.String,Azure.AI.Translation.Document.DocumentTranslateContent,System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="targetLanguage" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="DocumentTranslateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<BinaryData>> DocumentTranslateAsync (string targetLanguage, Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage = default, string category = default, bool? allowFallback = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.BinaryData>> DocumentTranslateAsync(string targetLanguage, class Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage, string category, valuetype System.Nullable`1<bool> allowFallback, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslateAsync(System.String,Azure.AI.Translation.Document.DocumentTranslateContent,System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DocumentTranslateAsync (targetLanguage As String, documentTranslateContent As DocumentTranslateContent, Optional sourceLanguage As String = Nothing, Optional category As String = Nothing, Optional allowFallback As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member DocumentTranslateAsync : string * Azure.AI.Translation.Document.DocumentTranslateContent * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>
override this.DocumentTranslateAsync : string * Azure.AI.Translation.Document.DocumentTranslateContent * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>" Usage="singleDocumentTranslationClient.DocumentTranslateAsync (targetLanguage, documentTranslateContent, sourceLanguage, category, allowFallback, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetLanguage" Type="System.String" />
<Parameter Name="documentTranslateContent" Type="Azure.AI.Translation.Document.DocumentTranslateContent" />
<Parameter Name="sourceLanguage" Type="System.String" />
<Parameter Name="category" Type="System.String" />
<Parameter Name="allowFallback" Type="System.Nullable<System.Boolean>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="targetLanguage">
Specifies the language of the output document.
The target language must be one of the supported languages included in the translation scope.
For example if you want to translate the document in German language, then use targetLanguage=de
</param>
<param name="documentTranslateContent"> Document Translate Request Content. </param>
<param name="sourceLanguage">
Specifies source language of the input document.
If this parameter isn't specified, automatic language detection is applied to determine the source language.
For example if the source document is written in English, then use sourceLanguage=en
</param>
<param name="category">
A string specifying the category (domain) of the translation. This parameter is used to get translations
from a customized system built with Custom Translator. Add the Category ID from your Custom Translator
project details to this parameter to use your deployed customized system. Default value is: general.
</param>
<param name="allowFallback">
Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.
Possible values are: true (default) or false.
</param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Submit a single document translation request to the Document Translation service. </summary>
<returns>To be added.</returns>
<remarks> Use this API to submit a single translation request to the Document Translation Service. </remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="targetLanguage" /> or <paramref name="documentTranslateContent" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="DocumentTranslateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DocumentTranslateAsync (string targetLanguage, Azure.Core.RequestContent content, string contentType, string sourceLanguage = default, string category = default, bool? allowFallback = default, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DocumentTranslateAsync(string targetLanguage, class Azure.Core.RequestContent content, string contentType, string sourceLanguage, string category, valuetype System.Nullable`1<bool> allowFallback, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslateAsync(System.String,Azure.Core.RequestContent,System.String,System.String,System.String,System.Nullable{System.Boolean},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DocumentTranslateAsync (targetLanguage As String, content As RequestContent, contentType As String, Optional sourceLanguage As String = Nothing, Optional category As String = Nothing, Optional allowFallback As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DocumentTranslateAsync : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DocumentTranslateAsync : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="singleDocumentTranslationClient.DocumentTranslateAsync (targetLanguage, content, contentType, sourceLanguage, category, allowFallback, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetLanguage" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="contentType" Type="System.String" />
<Parameter Name="sourceLanguage" Type="System.String" />
<Parameter Name="category" Type="System.String" />
<Parameter Name="allowFallback" Type="System.Nullable<System.Boolean>" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="targetLanguage">
Specifies the language of the output document.
The target language must be one of the supported languages included in the translation scope.
For example if you want to translate the document in German language, then use targetLanguage=de
</param>
<param name="content"> The content to send as the body of the request. </param>
<param name="contentType"> Content Type as multipart/form-data. Allowed values: "multipart/form-data". </param>
<param name="sourceLanguage">
Specifies source language of the input document.
If this parameter isn't specified, automatic language detection is applied to determine the source language.
For example if the source document is written in English, then use sourceLanguage=en
</param>
<param name="category">
A string specifying the category (domain) of the translation. This parameter is used to get translations
from a customized system built with Custom Translator. Add the Category ID from your Custom Translator
project details to this parameter to use your deployed customized system. Default value is: general.
</param>
<param name="allowFallback">
Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.
Possible values are: true (default) or false.
</param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Submit a single document translation request to the Document Translation service
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.SingleDocumentTranslationClient.DocumentTranslateAsync(System.String,Azure.AI.Translation.Document.DocumentTranslateContent,System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="targetLanguage" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Translation.Document.SingleDocumentTranslationClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.AI.Translation.Document.SingleDocumentTranslationClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>