Amazon Comprehend · Schema
PiiEntity
Provides information about a PII entity.
Machine LearningNatural Language ProcessingNLPText Analysis
Properties
| Name | Type | Description |
|---|---|---|
| Score | object | |
| Type | object | |
| BeginOffset | object | |
| EndOffset | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-pii-entity-schema.json",
"title": "PiiEntity",
"description": "Provides information about a PII entity.",
"type": "object",
"properties": {
"Score": {
"allOf": [
{
"$ref": "#/components/schemas/Float"
},
{
"description": "The level of confidence that Amazon Comprehend has in the accuracy of the detection."
}
]
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/PiiEntityType"
},
{
"description": "The entity's type."
}
]
},
"BeginOffset": {
"allOf": [
{
"$ref": "#/components/schemas/Integer"
},
{
"description": "The zero-based offset from the beginning of the source text to the first character in the entity."
}
]
},
"EndOffset": {
"allOf": [
{
"$ref": "#/components/schemas/Integer"
},
{
"description": "The zero-based offset from the beginning of the source text to the last character in the entity."
}
]
}
}
}