-
Notifications
You must be signed in to change notification settings - Fork 256
/
TextModeration.xml
223 lines (223 loc) · 17.6 KB
/
TextModeration.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
<Type Name="TextModeration" FullName="Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration">
<TypeSignature Language="C#" Value="public class TextModeration : Microsoft.Azure.CognitiveServices.ContentModerator.ITextModeration, Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TextModeration extends System.Object implements class Microsoft.Azure.CognitiveServices.ContentModerator.ITextModeration, class Microsoft.Rest.IServiceOperations`1<class Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration" />
<TypeSignature Language="VB.NET" Value="Public Class TextModeration
Implements IServiceOperations(Of ContentModeratorClient), ITextModeration" />
<TypeSignature Language="F#" Value="type TextModeration = class
 interface IServiceOperations<ContentModeratorClient>
 interface ITextModeration" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.ContentModerator</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.CognitiveServices.ContentModerator.ITextModeration</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
TextModeration operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TextModeration (Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration.#ctor(Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (client As ContentModeratorClient)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration : Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient -> Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration" Usage="new Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration client" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.ContentModerator</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="client" Type="Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient" />
</Parameters>
<Docs>
<param name="client">
Reference to the service client.
</param>
<summary>
Initializes a new instance of the TextModeration class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration.Client" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Client As ContentModeratorClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient" Usage="Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.ContentModerator</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.ContentModerator.ContentModeratorClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the ContentModeratorClient
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetectLanguageWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.DetectedLanguage>> DetectLanguageWithHttpMessagesAsync (string textContentType, System.IO.Stream textContent, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.ContentModerator.Models.DetectedLanguage>> DetectLanguageWithHttpMessagesAsync(string textContentType, class System.IO.Stream textContent, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration.DetectLanguageWithHttpMessagesAsync(System.String,System.IO.Stream,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DetectLanguageWithHttpMessagesAsync (textContentType As String, textContent As Stream, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of DetectedLanguage))" />
<MemberSignature Language="F#" Value="abstract member DetectLanguageWithHttpMessagesAsync : string * System.IO.Stream * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.DetectedLanguage>>
override this.DetectLanguageWithHttpMessagesAsync : string * System.IO.Stream * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.DetectedLanguage>>" Usage="textModeration.DetectLanguageWithHttpMessagesAsync (textContentType, textContent, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.ContentModerator.ITextModeration.DetectLanguageWithHttpMessagesAsync(System.String,System.IO.Stream,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.ContentModerator</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.DetectedLanguage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="textContentType" Type="System.String" />
<Parameter Name="textContent" Type="System.IO.Stream" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="textContentType">
The content type. Possible values include: 'text/plain', 'text/html',
'text/xml', 'text/markdown'
</param>
<param name="textContent">
Content to screen.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
This operation will detect the language of given input content. Returns the
<a href="http://www-01.sil.org/iso639-3/codes.asp">ISO 639-3
code</a> for the predominant language comprising the submitted text.
Over 110 languages supported.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.ContentModerator.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="ScreenTextWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>> ScreenTextWithHttpMessagesAsync (string textContentType, System.IO.Stream textContent, string language = default, bool? autocorrect = False, bool? pII = False, string listId = default, bool? classify = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>> ScreenTextWithHttpMessagesAsync(string textContentType, class System.IO.Stream textContent, string language, valuetype System.Nullable`1<bool> autocorrect, valuetype System.Nullable`1<bool> pII, string listId, valuetype System.Nullable`1<bool> classify, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.ContentModerator.TextModeration.ScreenTextWithHttpMessagesAsync(System.String,System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ScreenTextWithHttpMessagesAsync (textContentType As String, textContent As Stream, Optional language As String = Nothing, Optional autocorrect As Nullable(Of Boolean) = False, Optional pII As Nullable(Of Boolean) = False, Optional listId As String = Nothing, Optional classify As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Screen))" />
<MemberSignature Language="F#" Value="abstract member ScreenTextWithHttpMessagesAsync : string * System.IO.Stream * string * Nullable<bool> * Nullable<bool> * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>>
override this.ScreenTextWithHttpMessagesAsync : string * System.IO.Stream * string * Nullable<bool> * Nullable<bool> * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>>" Usage="textModeration.ScreenTextWithHttpMessagesAsync (textContentType, textContent, language, autocorrect, pII, listId, classify, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.ContentModerator.ITextModeration.ScreenTextWithHttpMessagesAsync(System.String,System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.ContentModerator</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="textContentType" Type="System.String" />
<Parameter Name="textContent" Type="System.IO.Stream" />
<Parameter Name="language" Type="System.String" />
<Parameter Name="autocorrect" Type="System.Nullable<System.Boolean>" />
<Parameter Name="pII" Type="System.Nullable<System.Boolean>" />
<Parameter Name="listId" Type="System.String" />
<Parameter Name="classify" Type="System.Nullable<System.Boolean>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="textContentType">
The content type. Possible values include: 'text/plain', 'text/html',
'text/xml', 'text/markdown'
</param>
<param name="textContent">
Content to screen.
</param>
<param name="language">
Language of the text.
</param>
<param name="autocorrect">
Autocorrect text.
</param>
<param name="pII">
Detect personal identifiable information.
</param>
<param name="listId">
The list Id.
</param>
<param name="classify">
Classify input.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Detect profanity and match against custom and shared blacklists
</summary>
<returns>To be added.</returns>
<remarks>
Detects profanity in more than 100 languages and match against custom and
shared blacklists.
</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.ContentModerator.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
</Members>
</Type>