Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Ejecute un trabajo por lotes asíncrono para ubicarlos PII en una colección de documentos. Para ejecutar el trabajo, cargue los documentos en Amazon S3 y envíe una StartPiiEntitiesDetectionJobsolicitud.
Temas
Antes de comenzar
Antes de comenzar, asegúrese de que dispone de:
-
Buckets de entrada y salida: identifique los buckets de Amazon S3 que desea utilizar para los archivos de entrada y salida. Los buckets deben estar en la misma región a la API que llamas.
-
IAMrol de servicio: debe tener un rol de IAM servicio con permiso para acceder a sus depósitos de entrada y salida. Para obtener más información, consulte Se requieren permisos basados en roles para las operaciones asíncronas.
Parámetros de entrada
En la solicitud, incluya los siguientes parámetros obligatorios:
-
InputDataConfig
— Proporcione una InputDataConfigdefinición para su solicitud, que incluya las propiedades de entrada del trabajo. Para el parámetroS3Uri
, especifique la ubicación de Amazon S3 de los documentos de entrada. -
OutputDataConfig
— Proporcione una OutputDataConfigdefinición para su solicitud, que incluya las propiedades de salida del trabajo. Para el parámetroS3Uri
, especifique la ubicación de Amazon S3 en la que Amazon Comprehend escribe los resultados de su análisis. -
DataAccessRoleArn
— Proporcione el nombre del recurso de Amazon (ARN) de un AWS Identity and Access Management rol. Este rol debe conceder a Amazon Comprehend acceso de lectura a sus datos de entrada y acceso de escritura a su ubicación de salida en Amazon S3. Para obtener más información, consulte Se requieren permisos basados en roles para las operaciones asíncronas. -
Mode
: establezca este parámetro enONLY_OFFSETS
. Con esta configuración, la salida proporciona los desplazamientos de caracteres que ubican a cada PII entidad en el texto de entrada. El resultado también incluye puntuaciones de confianza y tipos de PII entidades. -
LanguageCode
— Defina este parámetro enen
oes
. Amazon Comprehend admite la PII detección en texto en inglés o español.
Métodos de trabajo asíncrono
StartPiiEntitiesDetectionJob
devuelve un identificador de trabajo para que pueda supervisar el progreso del trabajo y recuperar su estado cuando se complete.
Para supervisar el progreso de un trabajo de análisis, proporcione el identificador del trabajo a la DescribePiiEntitiesDetectionJoboperación. La respuesta de DescribePiiEntitiesDetectionJob
contiene el campo JobStatus
con el estado actual del trabajo. Un trabajo exitoso pasa por los siguientes estados:
SUBMITTED-> EN_ PROGRESS ->COMPLETED.
Cuando un trabajo de análisis haya finalizado (JobStatus
es decir COMPLETEDFAILED, oSTOPPED), utilícelo DescribePiiEntitiesDetectionJob
para obtener la ubicación de los resultados. Si el estado del trabajo es COMPLETED
, la respuesta incluirá un campo OutputDataConfig
que contiene un campo con la ubicación de Amazon S3 del archivo de salida.
Para obtener información adicional sobre los pasos a seguir para el análisis asíncrono de Amazon Comprehend, consulte Procesamiento por lotes asincrónico.
Formato de archivo de salida
El archivo de salida tiene el mismo nombre que el del archivo de entrada, con un anexo .out al final. Contiene los resultados del análisis.
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que detectó PII entidades en los documentos. El formato de entrada es de un documento por línea.
{
"Entities": [
{
"Type": "NAME",
"BeginOffset": 40,
"EndOffset": 69,
"Score": 0.999995
},
{
"Type": "ADDRESS",
"BeginOffset": 247,
"EndOffset": 253,
"Score": 0.998828
},
{
"Type": "BANK_ACCOUNT_NUMBER",
"BeginOffset": 406,
"EndOffset": 411,
"Score": 0.693283
}
],
"File": "doc.txt",
"Line": 0
},
{
"Entities": [
{
"Type": "SSN",
"BeginOffset": 1114,
"EndOffset": 1124,
"Score": 0.999999
},
{
"Type": "EMAIL",
"BeginOffset": 3742,
"EndOffset": 3775,
"Score": 0.999993
},
{
"Type": "PIN",
"BeginOffset": 4098,
"EndOffset": 4102,
"Score": 0.999995
}
],
"File": "doc.txt",
"Line": 1
}
A continuación, se muestra un ejemplo del resultado de un análisis en el que el formato de la entrada es un documento por archivo.
{
"Entities": [
{
"Type": "NAME",
"BeginOffset": 40,
"EndOffset": 69,
"Score": 0.999995
},
{
"Type": "ADDRESS",
"BeginOffset": 247,
"EndOffset": 253,
"Score": 0.998828
},
{
"Type": "BANK_ROUTING",
"BeginOffset": 279,
"EndOffset": 289,
"Score": 0.999999
}
],
"File": "doc.txt"
}
Análisis asíncrono mediante el AWS Command Line Interface
En el siguiente ejemplo, se utiliza la operación StartPiiEntitiesDetectionJob
con la AWS CLI.
El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
aws comprehend start-pii-entities-detection-job \ --region
region
\ --job-namejob name
\ --cli-input-json file://path to JSON input file
Para el cli-input-json
parámetro, debe proporcionar la ruta a un JSON archivo que contiene los datos de la solicitud, como se muestra en el siguiente ejemplo.
{ "InputDataConfig": { "S3Uri": "s3://
input bucket
/input path
", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://output bucket
/output path
" }, "DataAccessRoleArn": "arn:aws:iam::account ID
:role/data access role
" "LanguageCode": "en", "Mode": "ONLY_OFFSETS" }
Si la solicitud para iniciar el trabajo de detección de eventos se realizó correctamente, recibirá una respuesta similar a la siguiente:
{
"JobId": "5d2fbe6e...e2c"
"JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c"
"JobStatus": "SUBMITTED",
}
Puede utilizar la DescribeEventsDetectionJoboperación para obtener el estado de un trabajo existente. Si la solicitud para iniciar el trabajo de detección de eventos se realizó correctamente, recibirá una respuesta similar a la siguiente:
aws comprehend describe-pii-entities-detection-job \ --region
region
\ --job-idjob ID
Cuando el trabajo se complete correctamente, recibirá una respuesta similar a la siguiente:
{
"PiiEntitiesDetectionJobProperties": {
"JobId": "5d2fbe6e...e2c"
"JobArn": "arn:aws:comprehend:us-west-2:123456789012:pii-entities-detection-job/5d2fbe6e...e2c"
"JobName": "piiCLItest3",
"JobStatus": "COMPLETED",
"SubmitTime": "2022-05-05T14:54:06.169000-07:00",
"EndTime": "2022-05-05T15:00:17.007000-07:00",
"InputDataConfig": {
(identical to the input data that you provided with the request)
}
}