Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Use this article to find the entity categories that can be returned by the PII detection feature. This feature runs a predictive model to identify, categorize, and redact sensitive information from an input document.
The PII feature includes the ability to detect personal (PII) and health (PHI) information.
Entity categories
Note
To detect protected health information (PHI), use the ___domain=phi parameter and model version 2020-04-01 or later.
The following entity categories are returned when you're sending API requests PII feature.
Category: Person
This category contains the following entity:
Entity
Person
Details
Names of people. Returned as both PII and PHI.
To get this entity category, add Person to the piiCategories parameter. Person will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Category: PersonType
This category contains the following entity:
Entity
PersonType
Details
Job types or roles held by a person.
To get this entity category, add PersonType to the piiCategories parameter. PersonType will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Category: PhoneNumber
This category contains the following entity:
Entity
PhoneNumber
Details
Phone numbers (US and EU phone numbers only). Returned as both PII and PHI.
To get this entity category, add PhoneNumber to the piiCategories parameter. PhoneNumber will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh-hans, ja, ko, pt-pt pt-br
Category: Organization
This category contains the following entity:
Entity
Organization
Details
Companies, political groups, musical bands, sport clubs, government bodies, and public organizations. Nationalities and religions are not included in this entity type. Returned as both PII and PHI.
To get this entity category, add Organization to the piiCategories parameter. Organization will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subcategories
The entity in this category can have the following subcategories.
Entity subcategory
Medical
Details
Medical companies and groups.
To get this entity category, add OrganizationMedical to the piiCategories parameter. OrganizationMedical will be returned in the API response if detected.
Supported languages
en
Stock exchange
Stock exchange groups.
To get this entity category, add OrganizationStockExchange to the piiCategories parameter. OrganizationStockExchange will be returned in the API response if detected.
en
Sports
Sports-related organizations.
To get this entity category, add OrganizationSports to the piiCategories parameter. OrganizationSports will be returned in the API response if detected.
en
Category: Address
This category contains the following entity:
Entity
Address
Details
Full mailing address. Returned as both PII and PHI.
To get this entity category, add Address to the piiCategories parameter. Address will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Category: Email
This category contains the following entity:
Entity
Details
Email addresses. Returned as both PII and PHI.
To get this entity category, add Email to the piiCategories parameter. Email will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Category: URL
This category contains the following entity:
Entity
URL
Details
URLs to websites. Returned as both PII and PHI.
To get this entity category, add URL to the piiCategories parameter. URL will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Category: IP Address
This category contains the following entity:
Entity
IPAddress
Details
Network IP addresses. Returned as both PII and PHI.
To get this entity category, add IPAddress to the piiCategories parameter. IPAddress will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Category: DateTime
This category contains the following entities:
Entity
DateTime
Details
Dates and times of day.
To get this entity category, add DateTime to the piiCategories parameter. DateTime will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subcategories
The entity in this category can have the following subcategories.
Entity subcategory
Date
Details
Calendar dates. Returned as both PII and PHI.
To get this entity category, add Date to the piiCategories parameter. Date will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
DateAndTime
Dates and times of day.
To get this entity category, add DateAndTime to the piiCategories parameter. DateAndTime will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subcategory: Age
The PII service supports the Age subcategory within the broader Quantity category (since Age is the personally identifiable piece of information).
Entity subcategory
Age
Details
Ages.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Azure information
These entity categories include identifiable Azure information like authentication information and connection strings. Not returned as PHI.
Entity
Azure DocumentDB Auth Key
Details
Authorization key for an Azure Cosmos DB server.
To get this entity category, add AzureDocumentDBAuthKey to the piiCategories parameter. AzureDocumentDBAuthKey will be returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure IAAS Database Connection String and Azure SQL Connection String.
Connection string for an Azure infrastructure as a service (IaaS) database, and SQL connection string.
To get this entity category, add AzureIAASDatabaseConnectionAndSQLString to the piiCategories parameter. AzureIAASDatabaseConnectionAndSQLString will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure IoT Connection String
Connection string for Azure IoT.
To get this entity category, add AzureIoTConnectionString to the piiCategories parameter. AzureIoTConnectionString will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Publish Setting Password
Password for Azure publish settings.
To get this entity category, add AzurePublishSettingPassword to the piiCategories parameter. AzurePublishSettingPassword will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Redis Cache Connection String
Connection string for a Redis cache.
To get this entity category, add AzureRedisCacheString to the piiCategories parameter. AzureRedisCacheString will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure SAS
Connection string for Azure software as a service (SaaS).
To get this entity category, add AzureSAS to the piiCategories parameter. AzureSAS will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Service Bus Connection String
Connection string for an Azure service bus.
To get this entity category, add AzureServiceBusString to the piiCategories parameter. AzureServiceBusString will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Storage Account Key
Account key for an Azure storage account.
To get this entity category, add AzureStorageAccountKey to the piiCategories parameter. AzureStorageAccountKey will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Storage Account Key (Generic)
Generic account key for an Azure storage account.
To get this entity category, add AzureStorageAccountGeneric to the piiCategories parameter. AzureStorageAccountGeneric will be returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
SQL Server Connection String
Connection string for a computer running SQL Server.
To get this entity category, add SQLServerConnectionString to the piiCategories parameter. SQLServerConnectionString will be returned in the API response if detected.
en