Introducción
El conector de Amazon Comprehend de Bizagi está disponible en el Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta de Amazon Comprehend y usar sus servicios.
Para más información de las capacidades de este conector, visite nuestro Connectors Xchange.
|
Este Conector se desarrolló de acuerdo con los contenidos del API o información sobre los mismos suministrada por Amazon Comprehend. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por Amazon Comprehend. Ni Bizagi ni sus filiales serán responsables de ofrecer cualquier tipo de garantía sobre los contenidos o errores derivados del llamado de los servicios del API. Bizagi y sus filiales no se harán responsables de las pérdidas, los costos o los daños en los que se incurra como consecuencia del acceso o el uso de los servicios del API de Amazon Comprehend. |
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.El conector previamente instalado, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través del manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
3.Una cuenta en Amazon Comprehend.
Crear cuenta en Amazon Comprehend
Para utilizar el conector de Amazon Comprehend, es necesario crear una cuenta que le permitirá obtener una llave de acceso y una llave secreta. Para lograr esto, complete los siguientes pasos:
1.Diríjase a https://aws.amazon.com/free/ y haga clic en Crear una cuenta gratuita.
2.Después de registrarse, en la ventana principal seleccione la opción de Usuarios ubicada en el panel izquierdo y después haga clic en Agregar Usuario.
3.En la sección de tipo de acceso, asegúrese de seleccionar la opción de Acceso programático.
4.En la siguiente pagina haga clic en Crear Grupo.
5.Asigne un nombre al grupo y active la opción de AdministratorAccess. Finalmente, haga clic en Crear Grupo y posteriormente en Siguiente.
6.Finalmente, haga clic en Crear Usuario.
En la ventana de detalles tras la creación del usuario, copie la llave de acceso y la llave secreta.
Para utilizar el servicio de traducciones de Amazon, diríjase a la consola de AWS y busque Amazon Translate y S3 en la barra de búsqueda. El servicio de S3 se utilizará para ver los archivos que se creen con el conector y los resultados de algunas de las acciones del mismo. El resto lo puede evidenciar en Amazon Translate.
Configurar el conector
Para configurar el conector siga los pasos descritos en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Tenga en cuenta los siguientes parámetros de autenticación:
•Authentication method: Custom
•ACCESS_KEY: llave de acceso que obtuvo en la sección anterior.
•SECRET_ACCESS: llave secreta que obtuvo en la sección anterior.
•REGION: región en la que se encuentra el servicio de Amazon Translate S3. Esta se puede verificar en la URL de la consola de AWS después de iniciar sesión.
Usar el conector
Este conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de inteligencia artificial de Amazon.
Para configurar el conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Al usar el conector, tenga en cuenta que puede necesitar configurar entradas o salidas. Las siguientes imágenes muestran ejemplos de cómo mapear las entradas o salidas de un método.
Acciones disponibles
Detect PII entities
Busca en un texto las entidades que contienen información de identificación personal (PII) y devuelve información sobre ellas.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): Una cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto - Requerido): El idioma de los documentos de entrada. Los posibles valores incluyen: "en". Este parámetro debe ser de tipo Texto en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Entities (Colección): colección de entidades PII identificadas en el texto de entrada. Para cada entrada, la respuesta proporciona el tipo de entidad, dónde comienza y termina el texto de la entidad y el nivel de confianza que Amazon Comprehend tiene en su detección.
oScore (Flotante): nivel de confianza que tiene Amazon Comprehend en la precisión de la detección de la entidad.
oType (Texto): tipo de entidad. Los posibles valores son:
▪"BANK_ACCOUNT_NUMBER"
▪"BANK_ROUTING"
▪"CREDIT_DEBIT_NUMBER"
▪"CREDIT_DEBIT_CVV"
▪"CREDIT_DEBIT_EXPIRY"
▪"PIN"
▪"EMAIL"
▪"ADDRESS"
▪"NAME"
▪"PHONE"
▪"SSN"
▪"DATE_TIME"
▪"PASSPORT_NUMBER"
▪"DRIVER_ID"
▪"URL"
▪"AGE"
▪"USERNAME"
▪"PASSWORD"
▪"AWS_ACCESS_KEY"
▪"AWS_SECRET_KEY"
▪"IP_ADDRESS"
▪"MAC_ADDRESS"
▪"ALL""
oBeginOffset (Entero): posición del caracter en el texto de entrada donde comienza la entidad PII (el primer caracter comienza en la posición 0). El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
oEndOffset - (Entero): posición del caracter en el texto de entrada donde termina la entidad PII. El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/how-pii.html.
Detect entities
Busca en un texto las entidades que contienen con nombre y devuelve la información sobre ellas.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Si su solicitud incluye el punto final para un modelo de reconocimiento de entidad personalizado, Amazon Comprehend usa el idioma de su modelo personalizado e ignora cualquier código de idioma que especifique aquí. Los posibles valores incluyen:"en""es""fr""Delaware""eso""pt""Arkansas""Hola""ja""ko""Z h""zh-TW"
• EndpointArn (Texto): nombre de recurso de Amazon de un endpoint asociado con un modelo de reconocimiento de entidad personalizado. Proporcione un endpoint si desea detectar entidades mediante su propio modelo personalizado en lugar del modelo predeterminado que utiliza Amazon Comprehend. Si especifica un endpoint, Amazon Comprehend usa el idioma de su modelo personalizado e ignora cualquier código de idioma que proporcione en su solicitud.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Entities (Colección): colección de entidades identificadas en el texto de entrada. Por cada entidad, la respuesta proporciona el texto de la entidad, el tipo de entidad, dónde comienza y termina la entidad y el nivel de confianza de Amazon Comprehend en la detección de la entidad. Si la petición utiliza un modelo de reconocimiento de entidades personalizado, Amazon Comprehend detecta las entidades que es capaz de comprender. De lo contrario, detecta los tipos de entidad por defecto.
oScore - (Flotante): nivel de confianza de Amazon Comprehend en la certeza de la detección de la entidad.
oType - (Texto): tipo de entidad. Los posibles valores son:
▪"PERSON"
▪"LOCATION"
▪"ORGANIZATION"
▪"COMMERCIAL_ITEM"
▪"EVENT"
▪"DATE"
▪"QUANTITY"
▪"TITLE"
▪"OTHER"
oText - (Texto): texto de la entidad.
oBeginOffset (Entero): posición del caracter en el texto de entrada donde comienza la entidad PII (el primer caracter comienza en la posición 0). El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
oEndOffset - (Entero): posición del caracter en el texto de entrada donde termina la entidad PII. El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
•error (Objeto):
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DetectEntities.html.
Batch detect entities
Busca en el contenido de una colección de documentos las entidades que contienen con nombre y devuelve la información sobre ellas.
Para configurar las entradas de esta acción tenga en cuenta:
• TextList (Colección - Requerido): lista que contiene el texto de los documentos de entrada. La lista puede contener un máximo de 25 documentos. Cada documento debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores incluyen:"en""es""fr""de""it""pt""ar""hi""ja""ko""zh""zh-TW".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•ResultList (Colección): lista de objetos que contiene los resultados de la operación. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): El índice de base cero del documento en la lista de entrada.
oEntities (Colección): uno o más objetos de entidad; uno por cada entidad encontrada en el documento.
▪Score (Flotante): nivel de confianza de Amazon Comprehend en la certeza de la detección de la entidad.
▪Type (Texto): tipo de entidad. Los posibles valores son:
•"PERSON"
•"LOCATION"
•"ORGANIZATION"
•"COMMERCIAL_ITEM"
•"EVENT"
•"DATE"
•"QUANTITY"
•"TITLE"
•"OTHER"
▪Text (Texto): texto de la entidad.
▪BeginOffset (Entero): posición del caracter en el texto de entrada donde comienza la entidad (el primer caracter comienza en la posición 0). El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
▪EndOffset (Entero): posición del caracter en el texto de entrada donde termina la entidad. El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
•ErrorList (Colección): lista que contiene un objeto de error por cada documento que tenga un error. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): índice de base cero del documento en la lista de entrada.
oErrorCode (Texto): código numérico del error.
oErrorMessage (Texto): descripción del error.
•error (Objeto):
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_BatchDetectEntities.html.
Start PII entities detection job
Inicia un trabajo asíncrono de detección de entidades de PII para una colección de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
• InputDataConfig (Objeto - Requerido): propiedades de entrada para el trabajo de detección de entidades PII.
o S3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
• OutputDataConfig (Objeto - Requerido): proporciona los parámetros de configuración para la salida de los trabajos de detección de entidades PII.
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. La S3Uri contiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
o KmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• Mode (Texto - Requerido): especifica si la salida proporciona las ubicaciones de las entidades PII, o un archivo en el que se redactan estas. Los posibles valores para este parámetro son "ONLY_REDACTION" u "ONLY_OFFSETS".
• RedactionConfig (Objeto): Proporciona parámetros de configuración para la redacción de entidades PII. Este parámetro es obligatorio si el parámetro Mode se configura como ONLY_REDACTION. En ese caso, debe proporcionar una definición para este parámetro que incluya el parámetro PiiEntityTypes.
o PiiEntityTypes (Colección): colección de tipos de entidades PII que Amazon Comprehend detecta en el texto de entrada de su solicitud.
o MaskMode (Texto): especifica si la entidad PII se redacta con el caracter de máscara o con el tipo entidad. Los posibles valores para este parámetro son "MASK" y "REPLACE_WITH_PII_ENTITY_TYPE".
o MaskCharacter (Texto): caracter que reemplaza cada caracter de la entidad PII redactada.
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• JobName (Texto): identificador del trabajo.
• LanguageCode (Texto - Requerido): lenguaje de los documentos de entrada. Los posibles valores para este campo son: "en" .
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartPiiEntitiesDetectionJob.html.
Describe PII entities detection job
Obtiene las propiedades asociadas con un trabajo de detección de entidades de PII; como por ejemplo, obtener el estado del trabajo.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•PiiEntitiesDetectionJobProperties (Objeto): información sobre el trabajo de detección de entidades PII.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de entidades PII para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de entidades PII.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de entidades PII.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de entidades PII
oJobName (Texto): nombre asignado al trabajo de detección de entidades PII
oJobStatus (Texto): estado actual del trabajo de detección de entidades PII. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son: "en", "es", "fr", "it", "pt", "ja", "ko", "zh" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oMode (Texto): especifica si la salida proporciona ubicaciones de las entidades PII, o un archivo en el que se redactan las entidades PII. Los posibles valores son:
▪"ONLY_REDACTION"
▪"ONLY_OFFSETS"
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de entidades PII.
▪S3Uri (Texto): cuando utiliza el objeto de PiiOutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oRedactionConfig (Objeto): proporciona los parámetros de configuración para la redacción de entidades PII. Este parámetro es obligatorio si definió el parámetro de Mode como ONLY_REDACTION. En este caso, debe proporcionar una definición de este parámetro que incluya el parámetro PiiEntityTypes.
▪PiiEntityTypes (Colección): colección de los tipos de entidades que Amazon Comprehend detecta en el texto de entrada de su solicitud.
▪MaskMode (Texto): especifica si la entidad PII se redacta con un caracter de máscara, o con el tipo de entidad. Los posibles valores son:
•"MASK"
•"REPLACE_WITH_PII_ENTITY_TYPE"
▪MaskCharacter (Texto): caracter que reemplaza cada caracter de la entidad PII escrita.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribePiiEntitiesDetectionJob.html.
List PII entities detection jobs
Obtiene una lista de trabajos de detección de entidades PII que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra por el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve sólo trabajos con el estado especificado. Los posibles valores son: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve sólo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•PiiEntitiesDetectionJobPropertiesList (Colección): lista que contiene las propiedades del trabajo.
oDataAccessRoleArn (Texto - Required): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de entidades PII para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de entidades PII.
oInputDataConfig (Objeto - Required): especifica el formato y la ubicación de los datos de entrada para el trabajo.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de entidades PII
oJobName (Texto): nombre asignado al trabajo de detección de entidades PII
oJobStatus (Texto): estado actual del trabajo de detección de entidades PII. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto - Required): código de idioma para los documentos de entrada. Todos los documentos deben estar en el mismo idioma. Puede definir cualquiera de los idiomas soportados por Amazon Comprehend. Si utiliza la detección de entidades personalizada, este parámetro es ignorado y se utiliza el idioma para el entrenamiento de modelos. Los posibles valores son:."en" "es" "fr" "de" "it" "pt" "ar" "hi" "ja" "ko" "zh" "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oMode (Texto): especifica si la salida proporciona ubicaciones de las entidades PII, o un archivo en el que se redactan las entidades PII. Los posibles valores son:
▪"ONLY_REDACTION"
▪"ONLY_OFFSETS"
oOutputDataConfig (Objeto - Required): especifica a dónde enviar los archivos de salida.
▪S3Uri (Texto): cuando utiliza el objeto de PiiOutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint del API que está llamando. La ubicación es utilizada como prefijo para la ubicación del archivo de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo. Este parámetro puede tener uno de los siguientes formatos:
•KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
•Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
•KMS Key Alias: "alias/ExampleAlias"
•ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
oRedactionConfig (Objeto): proporciona los parámetros de configuración para la redacción de entidades PII. Este parámetro es obligatorio si definió el parámetro de Mode como ONLY_REDACTION. En este caso, debe proporcionar una definición de este parámetro que incluya el parámetro PiiEntityTypes.
▪PiiEntityTypes (Colección): colección de los tipos de entidades que Amazon Comprehend detecta en el texto de entrada de su solicitud.
▪MaskMode (Texto): especifica si la entidad PII se redacta con un caracter de máscara, o con el tipo de entidad. Los posibles valores son:
•"MASK"
•"REPLACE_WITH_PII_ENTITY_TYPE"
•MaskCharacter (Texto): caracter que reemplaza cada caracter de la entidad PII escrita.
•NextToken (Texto): identifica la siguiente página de resultados para devolver.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListPiiEntitiesDetectionJobs.html.
Stop PII entities detection job
Detiene un trabajo de detección de entidades de PII en curso. Si el estado de un trabajo es IN_PROGRESS el trabajo será marcado para terminación y se actualizará su estado a STOP_REQUESTED. Si el trabajo se completa antes de que se pueda detener, su estado quedará como COMPLETED. Cuando se detiene un trabajo, todos los documentos ya procesados se escriben en la ubicación de salida.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StopPiiEntitiesDetectionJob.html.
Start entities detection job
Inicia un trabajo asíncrono de detección de entidades de para una colección de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
• InputDataConfig (Objeto - Requerido): especifica el formato y la ubicación de la información de entrada para el trabajo.
o S3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
• OutputDataConfig (Objeto - Requerido): especifica a dónde enviar los archivos de salida
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. La S3Uri contiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
o KmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• JobName (Texto): identificador del trabajo.
• EntityRecognizerArn (Texto): el Nombre del Recurso de Amazon (ARN) que identifica el reconocedor de entidades específicas que va a utilizar el StartEntitiesDetectionJob. Este ARN es opcional y sólo se utiliza para un trabajo de reconocimiento de entidades personalizado.
• LanguageCode (Texto - Requerido): Idioma de los documentos de entrada. Todos los documentos deben estar en el mismo idioma. Puede especificar uno de los idiomas que se admiten en Amazon Comprehend. Si se utiliza el reconocimiento de entidades personalizadas, este parámetro se ignora y se utiliza en su lugar el lenguaje utilizado para entrenar el modelo.. Los posibles valores para este parámetro son: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh" y "zh-TW".
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
• VolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
o:"1234abcd-12ab-34cd-56ef-1234567890ab"
oNombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartPiiEntitiesDetectionJob.html.
Describe entities detection job
Obtiene las propiedades asociadas con un trabajo de detección de entidades; como por ejemplo, obtener el estado del trabajo.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId - (Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•EntitiesDetectionJobPropertiesList (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de entidades para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de entidades.
oEntityRecognizerArn (Texto): el Nombre del Recurso de Amazon (ARN) que identifica al reconocedor de entidades.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de entidades.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de entidades
oJobName (Texto): nombre asignado al trabajo de detección de entidades
oJobStatus (Texto): estado actual del trabajo de detección de entidades. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "it", "pt", "ja", "ko", "zh" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de entidades.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribeEntitiesDetectionJob.html.
List entities detection jobs
Obtiene una lista de trabajos de detección de entidades que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve solo trabajos con el estado especificado. Los posibles valores incluyen: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): el número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•EntitiesDetectionJobPropertiesList (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de entidades para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de entidades.
oEntityRecognizerArn (Texto): el Nombre del Recurso de Amazon (ARN) que identifica al reconocedor de entidades.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de entidades.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de entidades
oJobName (Texto): nombre asignado al trabajo de detección de entidades
oJobStatus (Texto): estado actual del trabajo de detección de entidades. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de entidades.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListEntitiesDetectionJobs.htmlJ.
Stop entities detection job
Detiene un trabajo de detección de entidades en curso. Si el estado de un trabajo es IN_PROGRESS el trabajo será marcado para terminación y se actualizará su estado a STOP_REQUESTED. Si el trabajo se completa antes de que se pueda detener, su estado quedará como COMPLETED. Cuando se detiene un trabajo, todos los documentos ya procesados se escriben en la ubicación de salida.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StopEntitiesDetectionJob.html.
Detect sentiment
Inspecciona un texto y retorna una inferencia del sentimiento predominante. Los posibles valores de sentimiento son POSITIVE, NEUTRAL, NEGATIVE o MIXED.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores incluyen: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Sentiment (Texto): sentimiento inferido por Amazon Comprehend. El sentimiento retornado es aquel con mayor nivel de confianza. Los posibles valores son: "POSITIVE", "NEGATIVE", "NEUTRAL" o "MIXED"
•SentimentScore (Objeto): objeto que enumera la lista de los sentimientos y sus niveles de confianza
oPositive (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento positivo.
oNegative (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento negativo.
oNeutral (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento neutral.
oMixed (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento mixto.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DetectSentiment.html.
Batch detect sentiment
Inspecciona un lote de documentos y retorna una inferencia del sentimiento predominante. Los posibles valores de sentimiento son POSITIVE, NEUTRAL, NEGATIVE o MIXED.
Para configurar las entradas de esta acción tenga en cuenta:
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores son: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW".
• TextList (Colección - Requerido): lista que contiene el texto de los documentos de entrada. La lista puede contener un máximo de 25 documentos. Cada documento debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•ResultList (Colección): lista de objetos que contiene los resultados de la operación. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): El índice de base cero del documento en la lista de entrada.
oSentiment (Texto): sentimiento inferido por Amazon Comprehend. El sentimiento retornado es aquel con mayor nivel de confianza. Los posibles valores son: "POSITIVE", "NEGATIVE", "NEUTRAL" o "MIXED"
oSentimentScore (Objeto): objeto que enumera la lista de los sentimientos y sus niveles de confianza
▪Positive (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento positivo.
▪Negative (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento negativo.
▪Neutral (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento neutral.
▪Mixed (Texto): nivel de confianza que Amazon Comprehend tiene en la precisión de la detección de un sentimiento mixto.
•ErrorList (Colección): lista que contiene un objeto de error por cada documento que tenga un error. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): índice de base cero del documento en la lista de entrada.
oErrorCode (Texto): código numérico del error.
oErrorMessage (Texto): descripción del error.
•error (Objeto):
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_BatchDetectSentiment.html.
Detect syntax
Inspecciona el texto para ver la sintaxis y la parte del discurso de las palabras en el documento.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores son: "en", "es", "fr", "de", "it", "pt".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•SyntaxTokens (Colección): colección de tokens de sintaxis que describen el texto. Por cada token, la respuesta proporciona el texto, el tipo de token, dónde comienza y dónde termina el texto, y el nivel de confianza que tiene Amazon Comprehend en que el token es correcto.
oTokenId (Entero): identificador único para el token.
oText (Texto): palabra reconocida del texto origen.
oBeginOffset (Entero): Desplazamiento de caracteres desde el inicio del texto origen hasta el primer caracter en la palabra.
oEndOffset (Entero): Desplazamiento de caracteres desde el inicio del texto origen hasta el último caracter en la palabra.
oPartOfSpeech (Objeto): proporciona la etiqueta de la parte del discurso y el nivel de confianza que tiene Amazon Comprehend en que parte del discurso se identificó correctamente. Para obtener más información, consulte Análisis de Sintaxis.
▪Tag (Texto): identifica la parte del discurso que representa el token.
▪Score (flotante): nivel de confianza que Amazon Comprehend tiene en que la parte del discurso fue identificada correctamente.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DetectSyntax.html.
Batch detect syntax
Inspecciona el texto de un lote de documentos para ver la sintaxis y parte del discurso de las palabras de estos.
Para configurar las entradas de esta acción tenga en cuenta:
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores son: "en", "es", "fr", "de", "it", "pt".
• TextList (Colección - Requerido): lista que contiene el texto de los documentos de entrada. La lista puede contener un máximo de 25 documentos. Cada documento debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•ResultList (Colección): lista de objetos que contiene los resultados de la operación. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): El índice de base cero del documento en la lista de entrada.
oSyntaxTokens (Colección): colección de tokens de sintaxis que describen el texto. Por cada token, la respuesta proporciona el texto, el tipo de token, dónde comienza y dónde termina el texto, y el nivel de confianza que tiene Amazon Comprehend en que el token es correcto.
▪TokenId (Entero): identificador único para el token.
▪Text (Texto): palabra reconocida del texto origen.
▪BeginOffset (Entero): Desplazamiento de caracteres desde el inicio del texto origen hasta el primer caracter en la palabra.
▪EndOffset (Entero): Desplazamiento de caracteres desde el inicio del texto origen hasta el último caracter en la palabra.
▪PartOfSpeech (Objeto): proporciona la etiqueta de la parte del discurso y el nivel de confianza que tiene Amazon Comprehend en que parte del discurso se identificó correctamente. Para obtener más información, consulte Análisis de Sintaxis.
•Tag (Texto): identifica la parte del discurso que representa el token.
•Score (flotante): nivel de confianza que Amazon Comprehend tiene en que la parte del discurso fue identificada correctamente.
•ErrorList (Colección): lista que contiene un objeto de error por cada documento que tenga un error. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): índice de base cero del documento en la lista de entrada.
oErrorCode (Texto): código numérico del error.
oErrorMessage (Texto): descripción del error.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_BatchDetectSyntax.html.
Start sentiment detection job
Inicia un trabajo asíncrono de detección de sentimientos para una colección de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
• InputDataConfig (Objeto - Requerido): especifica el formato y la ubicación de la información de entrada para el trabajo.
oS3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
•OutputDataConfig (Objeto - Requerido): especifica a dónde enviar los archivos de salida
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. LaS3Uricontiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
o KmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
• JobName (Texto): identificador del trabajo.
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• LanguageCode (Texto - Requerido): Idioma de los documentos de entrada. Todos los documentos deben estar en el mismo idioma. Puede especificar uno de los idiomas que se admiten en Amazon Comprehend. Si se utiliza el reconocimiento de entidades personalizadas, este parámetro se ignora y se utiliza en su lugar el lenguaje utilizado para entrenar el modelo.. Los posibles valores para este parámetro son: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh" y "zh-TW".
• VolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
o:"1234abcd-12ab-34cd-56ef-1234567890ab"
oNombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
• VpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de sentimientos. Para mayor información, consulte Amazon VPC.
o SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
o Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartSentimentDetectionJob.html.
Describe sentiment detection job
Obtiene las propiedades asociadas con un trabajo de detección de sentimientos. Por ejemplo, el estado de un trabajo de detección.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•SentimentDetectionJobProperties (Objeto): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de sentimientos para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de sentimientos.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de sentimientos.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de sentimientos
oJobName (Texto): nombre asignado al trabajo de detección de sentimientos
oJobStatus (Texto): estado actual del trabajo de detección de sentimientos. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "it", "pt", "ja", "ko", "zh" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de sentimientos.
▪S3Uri (Texto): cuando utiliza el objeto de PiiOutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribeSentimentDetectionJob.html.
List sentiment detection jobs
Obtiene una lista de trabajos de detección de sentimientos que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve solo trabajos con el estado especificado. Los posibles valores incluyen: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): el número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•SentimentDetectionJobPropertiesList (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de sentimientos para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de sentimientos.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de sentimientos.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de sentimientos
oJobName (Texto): nombre asignado al trabajo de detección de sentimientos
oJobStatus (Texto): estado actual del trabajo de detección de sentimientos. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de sentimientos.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListSentimentDetectionJobs.html.
Stop sentiment detection job
Detiene un trabajo de detección de sentimientos en curso. Si el estado de un trabajo es IN_PROGRESS el trabajo será marcado para terminación y se actualizará su estado a STOP_REQUESTED. Si el trabajo se completa antes de que se pueda detener, su estado quedará como COMPLETED. Cuando se detiene un trabajo, todos los documentos ya procesados se escriben en la ubicación de salida.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StopSentimentDetectionJob.html.
Start topics detection job
Inicia un trabajo asíncrono de detección de temas.
Para configurar las entradas de esta acción tenga en cuenta:
•InputDataConfig (Objeto - Requerido): especifica el formato y la ubicación de la información de entrada para el trabajo.
o S3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
• OutputDataConfig (Objeto - Requerido): especifica a dónde enviar los archivos de salida
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. LaS3Uricontiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
oKmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• JobName (Texto): identificador del trabajo.
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
• NumberOfTopics (Entero): número de temas a detectar.
•VolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
o:"1234abcd-12ab-34cd-56ef-1234567890ab"
oNombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
•VpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
o SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
o Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartTopicsDetectionJob.html.
Describe topics detection job
Obtiene las propiedades asociadas con un trabajo de detección de tema. Por ejemplo, el estado de un trabajo de detección.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•TopicsDetectionJobProperties (Objeto): objeto con las propiedades del trabajo.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de temas para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de temas.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de temas.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de temas
oJobName (Texto): nombre asignado al trabajo de detección de temas
oJobStatus (Texto): estado actual del trabajo de detección de temas. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oMessage (Texto): descripción del estado del trabajo.
oNumberOfTopics (Entero): número de temas que se deben detectar
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de temas.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribeTopicsDetectionJob.html.
List topics detection jobs
Obtiene una lista de las tareas de detección del tema que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve solo trabajos con el estado especificado. Los posibles valores incluyen: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): el número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•TopicsDetectionJobPropertiesList (Colección): colección con las propiedades del trabajo.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de temas para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de temas.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de temas.
▪S3Uri (Texto - Required): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de temas
oJobName (Texto): nombre asignado al trabajo de detección de temas
oJobStatus (Texto): estado actual del trabajo de detección de temas. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oMessage (Texto): descripción del estado del trabajo.
oNumberOfTopics (Entero): número de temas que se deben detectar
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de temas.
▪S3Uri - obligatorio (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•NextToken (Texto): identifica la siguiente página de resultados para devolver.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListTopicsDetectionJobs.html.
Detect key phrases
Detecta las frases clave encontradas en el texto.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): Una cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores incluyen: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•KeyPhrases (Colección): colección de frases clave que Amazon Comprehend identifica en el texto de entrada. La respuesta proporciona la frase clave, dónde comienza y termina la frase, y el nivel de confianza que Amazon Comprehend tiene en la precisión de la detección.
oBeginOffset (Entero): posición del caracter en el texto de entrada donde comienza la frase clave (el primer caracter comienza en la posición 0). El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
oEndOffset (Entero): posición del caracter en el texto de entrada donde termina la frase clave. El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
oScore (Flotante): nivel de confianza que tiene Amazon Comprehend en la precisión de la detección.
oText (Texto): texto de la frase clave.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DetectKeyPhrases.html.
Batch detect key phrases
Detecta las frases clave que se encuentran en un lote de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
• LanguageCode (Texto - Requerido): idioma de los documentos de entrada. Puede especificar cualquiera de los idiomas principales admitidos por Amazon Comprehend. Todos los documentos deben estar en el mismo idioma. Los posibles valores incluyen: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW".
• TextList (Colección - Requerido): lista que contiene el texto de los documentos de entrada. La lista puede contener un máximo de 25 documentos. Cada documento debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•ResultList (Colección): lista de objetos que contiene los resultados de la operación. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): El índice de base cero del documento en la lista de entrada.
oKeyPhrases (Colección): colección de frases clave que Amazon Comprehend identifica en el texto de entrada. La respuesta proporciona la frase clave, dónde comienza y termina la frase, y el nivel de confianza que Amazon Comprehend tiene en la precisión de la detección.
▪BeginOffset (Entero): posición del caracter en el texto de entrada donde comienza la frase clave (el primer caracter comienza en la posición 0). El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
▪EndOffset (Entero): posición del caracter en el texto de entrada donde termina la frase clave. El desplazamiento retorna la posición de cada punto de código UTF-8 en el texto. Un punto de código es un caracter abstracto con una representación gráfica particular. Por ejemplo, un caracter UTF-8 de varios bytes mapea un único punto de código.
▪Score (Flotante): nivel de confianza que tiene Amazon Comprehend en la precisión de la detección.
▪Text (Texto): texto de la frase clave.
•ErrorList (Colección): lista que contiene un objeto de error por cada documento que tenga un error. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): índice de base cero del documento en la lista de entrada.
oErrorCode (Texto): código numérico del error.
oErrorMessage (Texto): descripción del error.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_BatchDetectKeyPhrases.html.
Start key phrases detection job
Inicia un trabajo asíncrono de detección de frase clave para una colección de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
•InputDataConfig (Objeto - Requerido): especifica el formato y la ubicación de la información de entrada para el trabajo.
o S3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
• OutputDataConfig (Objeto - Requerido): especifica a dónde enviar los archivos de salida
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. LaS3Uricontiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
oKmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• JobName (Texto): identificador del trabajo.
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
•VolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
o:"1234abcd-12ab-34cd-56ef-1234567890ab"
oNombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
•VpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de sentimientos. Para mayor información, consulte Amazon VPC.
o SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
o Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartKeyPhrasesDetectionJob.html.
Describe key phrases detection job
Obtiene las propiedades asociadas con un trabajo de detección de frases clave. Por ejemplo, el estado de un trabajo de detección.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•KeyPhrasesDetectionJobPropertiesList (Objeto): objeto con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de frases clave para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de frases clave.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de frases clave.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de frases clave
oJobName (Texto): nombre asignado al trabajo de detección de frases clave
oJobStatus (Texto): estado actual del trabajo de detección de frases clave. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de frases clave.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribeKeyPhrasesDetectionJob.html.
List key phrases detection jobs
Obtiene una lista de trabajos de detección de frase clave que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve solo trabajos con el estado especificado. Los posibles valores incluyen: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): el número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•KeyPhrasesDetectionJobPropertiesList (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección de frases clave para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección de frases clave.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección de frases clave.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección de frases clave
oJobName (Texto): nombre asignado al trabajo de detección de frases clave
oJobStatus (Texto): estado actual del trabajo de detección de frases clave. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección de frases clave.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListKeyPhrasesDetectionJobs.html.
Stop key phrases detection job
Detiene un trabajo de detección de frases clave en curso. Si el estado de un trabajo es IN_PROGRESS el trabajo será marcado para terminación y se actualizará su estado a STOP_REQUESTED. Si el trabajo se completa antes de que se pueda detener, su estado quedará como COMPLETED. Cuando se detiene un trabajo, todos los documentos ya procesados se escriben en la ubicación de salida.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StopKeyPhrasesDetectionJob.html.
Detect dominant language
Determina el idioma dominante del texto de entrada. Para obtener una lista de los idiomas que Amazon Comprehend puede detectar, consulte aquí.
Para configurar las entradas de esta acción tenga en cuenta:
• Text (Texto - Requerido): cadena de texto UTF-8. Cada cadena debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Languages (Colección): idioma que Amazon Comprehend detecta en el texto de entrada. Por cada lenguaje, la respuesta retorna el código RFC 5646 del idioma y el nivel de confianza que tiene Amazon Comprehend en la inferencia de este. Para más información sobre los códigos RFC 5646 consulte las etiquetas para identificar idiomas.
oLanguageCode (Texto): código RFC 5646 del idioma dominante.
oScore (Flotante): nivel de confianza que tiene Amazon Comprehend en la precisión de la detección del idioma
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DetectDominantLanguage.html.
Batch detect dominant language
Determina el idioma dominante del texto de entrada para un lote de documentos. Para obtener una lista de los idiomas que Amazon Comprehend puede detectar, consulte aquí.
Para configurar las entradas de esta acción tenga en cuenta:
• TextList (Colección - Requerido): lista que contiene el texto de los documentos de entrada. La lista puede contener un máximo de 25 documentos. Cada documento debe contener menos de 5000 bytes de caracteres codificados en UTF-8.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•ResultList (Colección): lista de objetos que contiene los resultados de la operación. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): El índice de base cero del documento en la lista de entrada.
oLanguages (Colección): idioma que Amazon Comprehend detecta en el texto de entrada. Por cada lenguaje, la respuesta retorna el código RFC 5646 del idioma y el nivel de confianza que tiene Amazon Comprehend en la inferencia de este. Para más información sobre los códigos RFC 5646 consulte las etiquetas para identificar idiomas.
▪LanguageCode (Texto): código RFC 5646 del idioma dominante.
▪Score (Flotante): nivel de confianza que tiene Amazon Comprehend en la precisión de la detección del idioma
•ErrorList (Colección): lista que contiene un objeto de error por cada documento que tenga un error. Los resultados están ordenados ascendentemente por el índice y coinciden con el orden de los documentos en la lista de entrada. Si los documentos tienen un error, la colección queda vacía.
oIndex (Entero): índice de base cero del documento en la lista de entrada.
oErrorCode (Texto): código numérico del error.
oErrorMessage (Texto): descripción del error.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_BatchDetectDominantLanguage.html.
Start dominant language detection job
Inicia un trabajo asíncrono de detección de idioma dominante para una colección de documentos.
Para configurar las entradas de esta acción tenga en cuenta:
•InputDataConfig (Objeto - Requerido): especifica el formato y la ubicación de la información de entrada para el trabajo.
o S3Uri (Texto - Requerido): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint de la API al que está llamando. El URI puede apuntar a un único archivo de entrada o puede proporcionar el prefijo para una colección de archivos de datos. Por ejemplo, si utiliza el URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
o InputFormat (Texto): especifica cómo se debe procesar el texto de un archivo de entrada. Los posibles valores para este campo son:
▪ONE_DOC_PER_FILE- Cada archivo se considera un documento separado. Utilice esta opción cuando procese documentos grandes, como artículos de periódico o artículos científicos.
▪ONE_DOC_PER_LINE- Cada línea de un archivo se considera un documento separado. Utilice esta opción cuando procese muchos documentos cortos, como mensajes de texto.
• OutputDataConfig (Objeto - Requerido): especifica a dónde enviar los archivos de salida
o S3Uri (Texto - Requerido): Cuando se utiliza el OutputDataConfigcon operaciones asincrónicas, especifique la ubicación de Amazon S3 en la que desea escribir los datos de salida. El URI debe estar en la misma región que el endpoint de la API al que está llamando. La ubicación se utiliza como prefijo para la ubicación real del archivo de salida. Cuando finaliza el trabajo de detección de temas, el servicio crea un archivo de salida en un directorio específico del trabajo. LaS3Uricontiene la ubicación del archivo de salida, llamado output.tar.gz. Es un archivo comprimido que contiene la salida de la operación.
oKmsKeyId (Texto): ID de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los resultados de un trabajo de análisis. El KmsKeyId puede tener uno de los siguientes formatos:
▪ID de clave de KMS:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
▪Alias de clave de KMS:"alias/ExampleAlias"
▪ARN de un alias de clave de KMS:"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
• DataAccessRoleArn (Texto - Requerido): el Nombre del Recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que garantiza que Amazon Comprehend tenga permisos de lectura a sus tatos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
• JobName (Texto): identificador del trabajo.
• ClientRequestToken (Texto): identificador único para la solicitud. Si no configura el token de solicitud de cliente, Amazon Comprehend genera uno. Si no se proporciona un token, el SDK utiliza una versión 4 UUID.
•VolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
o:"1234abcd-12ab-34cd-56ef-1234567890ab"
oNombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
•VpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de sentimientos. Para mayor información, consulte Amazon VPC.
o SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
o Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055".
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StartDominantLanguageDetectionJob.html.
Describe dominant language detection job
Obtiene las propiedades asociadas con un trabajo de detección de idioma dominante. Por ejemplo, el estado de un trabajo de detección.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•DominantLanguageDetectionJobProperties (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección del idioma dominante para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección del idioma dominante.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección del idioma dominante.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección del idioma dominante
oJobName (Texto): nombre asignado al trabajo de detección del idioma dominante
oJobStatus (Texto): estado actual del trabajo de detección del idioma dominante. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección del idioma dominante.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_DescribeDominantLanguageDetectionJob.html.
List dominant language detection jobs
Obtiene una lista de trabajos de detección de idioma dominante que ha enviado.
Para configurar las entradas de esta acción tenga en cuenta:
• Filter (Objeto): filtra los trabajos que se devuelven. Puede filtrar trabajos por su nombre, estado o la fecha y hora en que se enviaron. Solo puede configurar un filtro a la vez.
• JobName (Texto): filtra el nombre del trabajo.
• JobStatus (Texto): filtra la lista de trabajos según el estado del trabajo. Devuelve solo trabajos con el estado especificado. Los posibles valores incluyen: "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED" y "STOPPED".
• SubmitTimeBefore (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo trabajos enviados antes de la hora especificada. Los trabajos se devuelven en orden ascendente, del más antiguo al más nuevo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• SubmitTimeAfter (Fecha): filtra la lista de trabajos según la hora a la que se envió el trabajo para su procesamiento. Devuelve solo los trabajos enviados después del tiempo especificado. Los trabajos se devuelven en orden descendente, del más nuevo al más antiguo. Formato de la fecha 'yyyy-MM-ddTHH:MM:ssZ' ejemplo de fecha '2021-07-22T14:51:20Z'
• NextToken (Texto): identifica la siguiente página de resultados para devolver.
• MaxResults (Entero): el número máximo de resultados que se devolverán en cada página.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•DominantLanguageDetectionJobPropertiesList (Colección): colección con las propiedades de todos los trabajos que se retornan.
oDataAccessRoleArn (Texto): el Nombre del Recurso de Amazon (ARN) que proporciona permisos de lectura a Amazon Comprehend de los datos de entrada. Para mayor información, diríjase a https://docs.aws.amazon.com/es_es/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
oSubmitTime (Fecha): hora en la que se envió el trabajo de detección del idioma dominante para su procesamiento.
oEndTime (Fecha): hora en la que se completó el trabajo de detección del idioma dominante.
oInputDataConfig (Objeto): propiedades de entrada para el trabajo de detección del idioma dominante.
▪S3Uri (Texto): URI de Amazon S3 para los datos de entrada. El URI debe estar en la misma región que el endpoint que está llamando. El URI puede apuntar a un único archivo, o puede proporcionar un prefijo para una colección de archivos. Por ejemplo, si utiliza el prefijo URIS3://bucketName/prefix, si el prefijo es un único archivo, Amazon Comprehend utiliza ese archivo como entrada. Si más de un archivo comienza con el prefijo, Amazon Comprehend los utilizará todos como entrada.
▪InputFormat (Texto): especifica cómo se debe procesar el texto de entrada. Los posibles valores son:
•ONE_DOC_PER_FILE - cada archivo es considerado un documento distinto. Utilice esta opción para procesar documentos extensos como artículos de periódico o artículos científicos.
•ONE_DOC_PER_LINE - cada línea del archivo se considera un documento distinto. Utilice esta opción para procesar lotes de documentos cortos, como mensajes de texto.
oJobId (Texto): identificador del trabajo de detección del idioma dominante
oJobName (Texto): nombre asignado al trabajo de detección del idioma dominante
oJobStatus (Texto): estado actual del trabajo de detección del idioma dominante. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
▪"SUBMITTED"
▪"IN_PROGRESS"
▪"COMPLETED"
▪"FAILED"
▪"STOP_REQUESTED"
▪"STOPPED"
oLanguageCode (Texto): código de idioma para los documentos de entrada. Los posibles valores son:."en", "es", "fr", "eso", "pt", "ja", "ko", "Z h" o "zh-TW"
oMessage (Texto): descripción del estado del trabajo.
oOutputDataConfig (Objeto): configuración de datos de salida que proporcionó al crear el trabajo de detección del idioma dominante.
▪S3Uri (Texto): cuando utiliza el objeto de OutputDataConfig con operaciones asíncronas, especifica la ubicación de Amazon S3 en la que desea escribir los datos de salida.
▪KmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para encriptar los resultados del trabajo.
oVolumeKmsKeyId (Texto): identificador de la clave de AWS Key Management Service (KMS) que Amazon Comprehend utiliza para cifrar los datos del volumen de almacenamiento asociado con las instancias de computación de aprendizaje automático que procesa el trabajo de análisis. Este parámetro puede tener cualquiera de los siguientes formatos:
▪:"1234abcd-12ab-34cd-56ef-1234567890ab"
▪Nombre de recurso de Amazon (ARN) de una clave de KMS:"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
oVpcConfig (Objeto): parámetros de configuración opcionales para una Nube Virtual Privada (VPC) que contiene los recursos que está utilizando para el trabajo de detección de temas. Para mayor información, consulte Amazon VPC.
▪ SecurityGroupIds (Colección - Requerido): número de ID de un grupo de seguridad en una instancia de su VPC privada. Los grupos de seguridad de la función de VPC sirven como un firewall virtual para controlar el tráfico entrante y saliente y proporcionan seguridad para los recursos a los que accederá en la VPC. Este número de identificación está precedido por «sg-», por ejemplo: «sg-03b388029b0a285ea». Para obtener más información, consulte Grupos de seguridad de su VPC.
▪ Subnets (Colección - Requerido): identificador de cada subred que se utiliza en la VPC privada. Esta subred es un subconjunto del rango de direcciones IPv4 utilizado por la VPC y es específico de una zona de disponibilidad determinada en la región de la VPC. Este número de identificación está precedido por «subnet-», por ejemplo: «subnet-04ccf456919e69055"
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_ListDominantLanguageDetectionJobs.html.
Stop dominant language detection jobs
Detiene un trabajo de detección de idioma dominante en curso..Si el estado de un trabajo es IN_PROGRESS el trabajo será marcado para terminación y se actualizará su estado a STOP_REQUESTED. Si el trabajo se completa antes de que se pueda detener, su estado quedará como COMPLETED. Cuando se detiene un trabajo, todos los documentos ya procesados se escriben en la ubicación de salida.
Para configurar las entradas de esta acción tenga en cuenta:
• JobId (Texto - Requerido): identificador que Amazon Comprehend generó para el trabajo. La operación devuelve este identificador en su respuesta.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•JobId (Texto): identificador generado por el trabajo
•JobStatus (Texto): estado del trabajo. Si el estado del trabajo es FAILED, el campo de mensaje muestra la causa para el fallo. Los posibles valores son:
o"SUBMITTED": el trabajo ha sido recibido y está en cola para ser procesado.
o"IN_PROGRESS": Amazon Comprehend está procesando el trabajo
o"COMPLETED": el trabajo se completó exitosamente y los datos de salida ya están disponibles.
o"FAILED": el trabajo falló y no pudo terminarse.
o"STOP_REQUESTED": Amazon Comprehend recibió una solicitud de detención del trabajo y la solicitud está siendo procesada.
o"STOPPED": El trabajo ha sido detenido antes de su finalización.
•error (Objeto)
oerror (Texto): nombre del error
omessage (Texto): descripción del error
ostatus (Entero): código del error
Para mas información de este método diríjase a la documentación oficial de Amazon Comprehend en https://docs.aws.amazon.com/es_es/comprehend/latest/dg/API_StopDominantLanguageDetectionJob.html.
Last Updated 10/28/2022 11:20:10 AM