-
Notifications
You must be signed in to change notification settings - Fork 255
/
PiiDetectionSkill.xml
196 lines (196 loc) · 13 KB
/
PiiDetectionSkill.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
<Type Name="PiiDetectionSkill" FullName="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill">
<TypeSignature Language="C#" Value="public class PiiDetectionSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PiiDetectionSkill extends Azure.Search.Documents.Indexes.Models.SearchIndexerSkill" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill" />
<TypeSignature Language="VB.NET" Value="Public Class PiiDetectionSkill
Inherits SearchIndexerSkill" />
<TypeSignature Language="F#" Value="type PiiDetectionSkill = class
 inherit SearchIndexerSkill" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Search.Documents.Indexes.Models.SearchIndexerSkill</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PiiDetectionSkill (System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1<class Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs, class System.Collections.Generic.IEnumerable`1<class Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.#ctor(System.Collections.Generic.IEnumerable{Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry},System.Collections.Generic.IEnumerable{Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (inputs As IEnumerable(Of InputFieldMappingEntry), outputs As IEnumerable(Of OutputFieldMappingEntry))" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.PiiDetectionSkill : seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> -> Azure.Search.Documents.Indexes.Models.PiiDetectionSkill" Usage="new Azure.Search.Documents.Indexes.Models.PiiDetectionSkill (inputs, outputs)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="inputs" Type="System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry>" />
<Parameter Name="outputs" Type="System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry>" />
</Parameters>
<Docs>
<param name="inputs"> Inputs of the skills could be a column in the source data set, or the output of an upstream skill. </param>
<param name="outputs"> The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. </param>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="inputs" /> or <paramref name="outputs" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="DefaultLanguageCode">
<MemberSignature Language="C#" Value="public string DefaultLanguageCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DefaultLanguageCode" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.DefaultLanguageCode" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultLanguageCode As String" />
<MemberSignature Language="F#" Value="member this.DefaultLanguageCode : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.DefaultLanguageCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating which language code to use. Default is en. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Domain">
<MemberSignature Language="C#" Value="public string Domain { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Domain" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.Domain" />
<MemberSignature Language="VB.NET" Value="Public Property Domain As String" />
<MemberSignature Language="F#" Value="member this.Domain : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.Domain" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Mask">
<MemberSignature Language="C#" Value="public string Mask { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Mask" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.Mask" />
<MemberSignature Language="VB.NET" Value="Public Property Mask As String" />
<MemberSignature Language="F#" Value="member this.Mask : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.Mask" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaskingMode">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode? MaskingMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode> MaskingMode" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.MaskingMode" />
<MemberSignature Language="VB.NET" Value="Public Property MaskingMode As Nullable(Of PiiDetectionSkillMaskingMode)" />
<MemberSignature Language="F#" Value="member this.MaskingMode : Nullable<Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode> with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.MaskingMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode></ReturnType>
</ReturnValue>
<Docs>
<summary> A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinPrecision">
<MemberSignature Language="C#" Value="public double? MinPrecision { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> MinPrecision" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.MinPrecision" />
<MemberSignature Language="VB.NET" Value="Public Property MinPrecision As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.MinPrecision : Nullable<double> with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.MinPrecision" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary> A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ModelVersion">
<MemberSignature Language="C#" Value="public string ModelVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelVersion" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.ModelVersion" />
<MemberSignature Language="VB.NET" Value="Public Property ModelVersion As String" />
<MemberSignature Language="F#" Value="member this.ModelVersion : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.ModelVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PiiCategories">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> PiiCategories { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> PiiCategories" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.PiiCategories" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PiiCategories As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.PiiCategories : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.Indexes.Models.PiiDetectionSkill.PiiCategories" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary> A list of PII entity categories that should be extracted and masked. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>