-
Notifications
You must be signed in to change notification settings - Fork 180
/
RecognizePiiEntitiesOptions.yml
210 lines (200 loc) · 7.87 KB
/
RecognizePiiEntitiesOptions.yml
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
### YamlMime:TSType
name: RecognizePiiEntitiesOptions
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions'
package: '@azure/ai-text-analytics'
summary: Options for the recognize PII entities operation.
fullName: RecognizePiiEntitiesOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: categoriesFilter
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.categoriesFilter'
package: '@azure/ai-text-analytics'
summary: >-
Filters entities to ones only included in the specified array of
categories
fullName: categoriesFilter
remarks: ''
isDeprecated: false
syntax:
content: 'categoriesFilter?: string[]'
return:
description: ''
type: string[]
- name: domainFilter
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.domainFilter'
package: '@azure/ai-text-analytics'
summary: |-
Filters entities to ones only included in the specified domain (e.g., if
set to 'PHI', entities in the Protected Healthcare Information domain will
only be returned).
See https://aka.ms/tanerpii for more information.
fullName: domainFilter
remarks: ''
isDeprecated: false
syntax:
content: 'domainFilter?: PROTECTED_HEALTH_INFORMATION'
return:
description: ''
type: >-
<xref
uid="@azure/ai-text-analytics.PiiEntityDomain.PROTECTED_HEALTH_INFORMATION"
/>
- name: stringIndexType
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.stringIndexType'
package: '@azure/ai-text-analytics'
summary: >-
Specifies the measurement unit used to calculate the offset and length
properties.
Possible units are "TextElements_v8", "UnicodeCodePoint", and
"Utf16CodeUnit".
The default is the JavaScript's default which is "Utf16CodeUnit".
fullName: stringIndexType
remarks: ''
isDeprecated: false
syntax:
content: 'stringIndexType?: StringIndexType'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.StringIndexType" />
inheritedProperties:
- name: abortSignal
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.abortSignal'
package: '@azure/ai-text-analytics'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.abortSignal](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.abortSignal)
- name: disableServiceLogs
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.disableServiceLogs'
package: '@azure/ai-text-analytics'
summary: >-
If set to true (the default for `beginAnalyzeHealthcareEntities` and
`recognizePiiEntities`),
you opt-out of having your text input logged for troubleshooting. By
default, Text Analytics
logs your input text for 48 hours, solely to allow for troubleshooting
issues. Setting this
parameter to true, disables input logging and may limit our ability to
remediate issues that
occur.
fullName: disableServiceLogs
remarks: ''
isDeprecated: false
syntax:
content: 'disableServiceLogs?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.disableServiceLogs](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.disableServiceLogs)
- name: includeStatistics
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.includeStatistics'
package: '@azure/ai-text-analytics'
summary: If set to true, response will contain input and document level statistics.
fullName: includeStatistics
remarks: ''
isDeprecated: false
syntax:
content: 'includeStatistics?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.includeStatistics](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.includeStatistics)
- name: modelVersion
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.modelVersion'
package: '@azure/ai-text-analytics'
summary: >-
This value indicates which model will be used for scoring. If a
model-version is
not specified, the API should default to the latest, non-preview version.
For supported model versions, see operation-specific documentation, for
example:
https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning
fullName: modelVersion
remarks: ''
isDeprecated: false
syntax:
content: 'modelVersion?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.modelVersion](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.modelVersion)
- name: onResponse
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.onResponse'
package: '@azure/ai-text-analytics'
summary: |-
A function to be called each time a response is received from the server
while performing the requested operation.
May be called multiple times.
fullName: onResponse
remarks: ''
isDeprecated: false
syntax:
content: 'onResponse?: RawResponseCallback'
return:
description: ''
type: <xref uid="@azure/core-client.RawResponseCallback" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.onResponse](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.onResponse)
- name: requestOptions
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.requestOptions'
package: '@azure/ai-text-analytics'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
description: ''
type: <xref uid="@azure/core-client.OperationRequestOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.requestOptions](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.requestOptions)
- name: serializerOptions
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.serializerOptions'
package: '@azure/ai-text-analytics'
summary: Options to override serialization/de-serialization behavior.
fullName: serializerOptions
remarks: ''
isDeprecated: false
syntax:
content: 'serializerOptions?: SerializerOptions'
return:
description: ''
type: <xref uid="@azure/core-client.SerializerOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.serializerOptions](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.serializerOptions)
- name: tracingOptions
uid: '@azure/ai-text-analytics.RecognizePiiEntitiesOptions.tracingOptions'
package: '@azure/ai-text-analytics'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalyticsOperationOptions.tracingOptions](xref:@azure/ai-text-analytics.TextAnalyticsOperationOptions.tracingOptions)
extends: <xref uid="@azure/ai-text-analytics.TextAnalyticsOperationOptions" />