-
Notifications
You must be signed in to change notification settings - Fork 13.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce Amazon Comprehend Service (#39592)
- Loading branch information
1 parent
d6d84a9
commit 9dd7752
Showing
16 changed files
with
1,145 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
from __future__ import annotations | ||
|
||
from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook | ||
|
||
|
||
class ComprehendHook(AwsBaseHook): | ||
""" | ||
Interact with AWS Comprehend. | ||
Provide thin wrapper around :external+boto3:py:class:`boto3.client("comprehend") <Comprehend.Client>`. | ||
Additional arguments (such as ``aws_conn_id``) may be specified and | ||
are passed down to the underlying AwsBaseHook. | ||
.. seealso:: | ||
- :class:`airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook` | ||
""" | ||
|
||
def __init__(self, *args, **kwargs) -> None: | ||
kwargs["client_type"] = "comprehend" | ||
super().__init__(*args, **kwargs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,192 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
from __future__ import annotations | ||
|
||
from functools import cached_property | ||
from typing import TYPE_CHECKING, Any, Sequence | ||
|
||
from airflow.configuration import conf | ||
from airflow.exceptions import AirflowException | ||
from airflow.providers.amazon.aws.hooks.comprehend import ComprehendHook | ||
from airflow.providers.amazon.aws.operators.base_aws import AwsBaseOperator | ||
from airflow.providers.amazon.aws.triggers.comprehend import ComprehendPiiEntitiesDetectionJobCompletedTrigger | ||
from airflow.providers.amazon.aws.utils import validate_execute_complete_event | ||
from airflow.providers.amazon.aws.utils.mixins import aws_template_fields | ||
from airflow.utils.timezone import utcnow | ||
|
||
if TYPE_CHECKING: | ||
import boto3 | ||
|
||
from airflow.utils.context import Context | ||
|
||
|
||
class ComprehendBaseOperator(AwsBaseOperator[ComprehendHook]): | ||
""" | ||
This is the base operator for Comprehend Service operators (not supposed to be used directly in DAGs). | ||
:param input_data_config: The input properties for a PII entities detection job. (templated) | ||
:param output_data_config: Provides `configuration` parameters for the output of PII entity detection | ||
jobs. (templated) | ||
:param data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend | ||
read access to your input data. (templated) | ||
:param language_code: The language of the input documents. (templated) | ||
""" | ||
|
||
aws_hook_class = ComprehendHook | ||
|
||
template_fields: Sequence[str] = aws_template_fields( | ||
"input_data_config", "output_data_config", "data_access_role_arn", "language_code" | ||
) | ||
|
||
template_fields_renderers: dict = {"input_data_config": "json", "output_data_config": "json"} | ||
|
||
def __init__( | ||
self, | ||
input_data_config: dict, | ||
output_data_config: dict, | ||
data_access_role_arn: str, | ||
language_code: str, | ||
**kwargs, | ||
): | ||
super().__init__(**kwargs) | ||
self.input_data_config = input_data_config | ||
self.output_data_config = output_data_config | ||
self.data_access_role_arn = data_access_role_arn | ||
self.language_code = language_code | ||
|
||
@cached_property | ||
def client(self) -> boto3.client: | ||
"""Create and return the Comprehend client.""" | ||
return self.hook.conn | ||
|
||
def execute(self, context: Context): | ||
"""Must overwrite in child classes.""" | ||
raise NotImplementedError("Please implement execute() in subclass") | ||
|
||
|
||
class ComprehendStartPiiEntitiesDetectionJobOperator(ComprehendBaseOperator): | ||
""" | ||
Create a comprehend pii entities detection job for a collection of documents. | ||
.. seealso:: | ||
For more information on how to use this operator, take a look at the guide: | ||
:ref:`howto/operator:ComprehendStartPiiEntitiesDetectionJobOperator` | ||
:param input_data_config: The input properties for a PII entities detection job. (templated) | ||
:param output_data_config: Provides `configuration` parameters for the output of PII entity detection | ||
jobs. (templated) | ||
:param mode: Specifies whether the output provides the locations (offsets) of PII entities or a file in | ||
which PII entities are redacted. If you set the mode parameter to ONLY_REDACTION. In that case you | ||
must provide a RedactionConfig in start_pii_entities_kwargs. | ||
:param data_access_role_arn: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend | ||
read access to your input data. (templated) | ||
:param language_code: The language of the input documents. (templated) | ||
:param start_pii_entities_kwargs: Any optional parameters to pass to the job. If JobName is not provided | ||
in start_pii_entities_kwargs, operator will create. | ||
:param wait_for_completion: Whether to wait for job to stop. (default: True) | ||
:param waiter_delay: Time in seconds to wait between status checks. (default: 60) | ||
:param waiter_max_attempts: Maximum number of attempts to check for job completion. (default: 20) | ||
:param deferrable: If True, the operator will wait asynchronously for the job to stop. | ||
This implies waiting for completion. This mode requires aiobotocore module to be installed. | ||
(default: False) | ||
:param aws_conn_id: The Airflow connection used for AWS credentials. | ||
If this is ``None`` or empty then the default boto3 behaviour is used. If | ||
running Airflow in a distributed manner and aws_conn_id is None or | ||
empty, then default boto3 configuration would be used (and must be | ||
maintained on each worker node). | ||
:param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. | ||
:param verify: Whether to verify SSL certificates. See: | ||
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html | ||
:param botocore_config: Configuration dictionary (key-values) for botocore client. See: | ||
https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html | ||
""" | ||
|
||
def __init__( | ||
self, | ||
input_data_config: dict, | ||
output_data_config: dict, | ||
mode: str, | ||
data_access_role_arn: str, | ||
language_code: str, | ||
start_pii_entities_kwargs: dict[str, Any] | None = None, | ||
wait_for_completion: bool = True, | ||
waiter_delay: int = 60, | ||
waiter_max_attempts: int = 20, | ||
deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False), | ||
**kwargs, | ||
): | ||
super().__init__( | ||
input_data_config=input_data_config, | ||
output_data_config=output_data_config, | ||
data_access_role_arn=data_access_role_arn, | ||
language_code=language_code, | ||
**kwargs, | ||
) | ||
self.mode = mode | ||
self.start_pii_entities_kwargs = start_pii_entities_kwargs or {} | ||
self.wait_for_completion = wait_for_completion | ||
self.waiter_delay = waiter_delay | ||
self.waiter_max_attempts = waiter_max_attempts | ||
self.deferrable = deferrable | ||
|
||
def execute(self, context: Context) -> str: | ||
if self.start_pii_entities_kwargs.get("JobName", None) is None: | ||
self.start_pii_entities_kwargs["JobName"] = ( | ||
f"start_pii_entities_detection_job-{int(utcnow().timestamp())}" | ||
) | ||
|
||
self.log.info( | ||
"Submitting start pii entities detection job '%s'.", self.start_pii_entities_kwargs["JobName"] | ||
) | ||
job_id = self.client.start_pii_entities_detection_job( | ||
InputDataConfig=self.input_data_config, | ||
OutputDataConfig=self.output_data_config, | ||
Mode=self.mode, | ||
DataAccessRoleArn=self.data_access_role_arn, | ||
LanguageCode=self.language_code, | ||
**self.start_pii_entities_kwargs, | ||
)["JobId"] | ||
|
||
message_description = f"start pii entities detection job {job_id} to complete." | ||
if self.deferrable: | ||
self.log.info("Deferring %s", message_description) | ||
self.defer( | ||
trigger=ComprehendPiiEntitiesDetectionJobCompletedTrigger( | ||
job_id=job_id, | ||
waiter_delay=self.waiter_delay, | ||
waiter_max_attempts=self.waiter_max_attempts, | ||
aws_conn_id=self.aws_conn_id, | ||
), | ||
method_name="execute_complete", | ||
) | ||
elif self.wait_for_completion: | ||
self.log.info("Waiting for %s", message_description) | ||
self.hook.get_waiter("pii_entities_detection_job_complete").wait( | ||
JobId=job_id, | ||
WaiterConfig={"Delay": self.waiter_delay, "MaxAttempts": self.waiter_max_attempts}, | ||
) | ||
|
||
return job_id | ||
|
||
def execute_complete(self, context: Context, event: dict[str, Any] | None = None) -> str: | ||
event = validate_execute_complete_event(event) | ||
if event["status"] != "success": | ||
raise AirflowException("Error while running job: %s", event) | ||
|
||
self.log.info("Comprehend pii entities detection job `%s` complete.", event["job_id"]) | ||
return event["job_id"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
from __future__ import annotations | ||
|
||
import abc | ||
from typing import TYPE_CHECKING, Any, Sequence | ||
|
||
from airflow.configuration import conf | ||
from airflow.exceptions import AirflowException, AirflowSkipException | ||
from airflow.providers.amazon.aws.hooks.comprehend import ComprehendHook | ||
from airflow.providers.amazon.aws.sensors.base_aws import AwsBaseSensor | ||
from airflow.providers.amazon.aws.triggers.comprehend import ComprehendPiiEntitiesDetectionJobCompletedTrigger | ||
from airflow.providers.amazon.aws.utils.mixins import aws_template_fields | ||
|
||
if TYPE_CHECKING: | ||
from airflow.utils.context import Context | ||
|
||
|
||
class ComprehendBaseSensor(AwsBaseSensor[ComprehendHook]): | ||
""" | ||
General sensor behavior for Amazon Comprehend. | ||
Subclasses must implement following methods: | ||
- ``get_state()`` | ||
Subclasses must set the following fields: | ||
- ``INTERMEDIATE_STATES`` | ||
- ``FAILURE_STATES`` | ||
- ``SUCCESS_STATES`` | ||
- ``FAILURE_MESSAGE`` | ||
:param deferrable: If True, the sensor will operate in deferrable mode. This mode requires aiobotocore | ||
module to be installed. | ||
(default: False, but can be overridden in config file by setting default_deferrable to True) | ||
""" | ||
|
||
aws_hook_class = ComprehendHook | ||
|
||
INTERMEDIATE_STATES: tuple[str, ...] = () | ||
FAILURE_STATES: tuple[str, ...] = () | ||
SUCCESS_STATES: tuple[str, ...] = () | ||
FAILURE_MESSAGE = "" | ||
|
||
ui_color = "#66c3ff" | ||
|
||
def __init__( | ||
self, | ||
deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False), | ||
**kwargs: Any, | ||
): | ||
super().__init__(**kwargs) | ||
self.deferrable = deferrable | ||
|
||
def poke(self, context: Context, **kwargs) -> bool: | ||
state = self.get_state() | ||
if state in self.FAILURE_STATES: | ||
# TODO: remove this if block when min_airflow_version is set to higher than 2.7.1 | ||
if self.soft_fail: | ||
raise AirflowSkipException(self.FAILURE_MESSAGE) | ||
raise AirflowException(self.FAILURE_MESSAGE) | ||
|
||
return state not in self.INTERMEDIATE_STATES | ||
|
||
@abc.abstractmethod | ||
def get_state(self) -> str: | ||
"""Implement in subclasses.""" | ||
|
||
|
||
class ComprehendStartPiiEntitiesDetectionJobCompletedSensor(ComprehendBaseSensor): | ||
""" | ||
Poll the state of the pii entities detection job until it reaches a completed state; fails if the job fails. | ||
.. seealso:: | ||
For more information on how to use this sensor, take a look at the guide: | ||
:ref:`howto/sensor:ComprehendStartPiiEntitiesDetectionJobCompletedSensor` | ||
:param job_id: The id of the Comprehend pii entities detection job. | ||
:param deferrable: If True, the sensor will operate in deferrable mode. This mode requires aiobotocore | ||
module to be installed. | ||
(default: False, but can be overridden in config file by setting default_deferrable to True) | ||
:param poke_interval: Polling period in seconds to check for the status of the job. (default: 120) | ||
:param max_retries: Number of times before returning the current state. (default: 75) | ||
:param aws_conn_id: The Airflow connection used for AWS credentials. | ||
If this is ``None`` or empty then the default boto3 behaviour is used. If | ||
running Airflow in a distributed manner and aws_conn_id is None or | ||
empty, then default boto3 configuration would be used (and must be | ||
maintained on each worker node). | ||
:param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. | ||
:param verify: Whether to verify SSL certificates. See: | ||
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html | ||
:param botocore_config: Configuration dictionary (key-values) for botocore client. See: | ||
https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html | ||
""" | ||
|
||
INTERMEDIATE_STATES: tuple[str, ...] = ("IN_PROGRESS",) | ||
FAILURE_STATES: tuple[str, ...] = ("FAILED", "STOP_REQUESTED", "STOPPED") | ||
SUCCESS_STATES: tuple[str, ...] = ("COMPLETED",) | ||
FAILURE_MESSAGE = "Comprehend start pii entities detection job sensor failed." | ||
|
||
template_fields: Sequence[str] = aws_template_fields("job_id") | ||
|
||
def __init__( | ||
self, | ||
*, | ||
job_id: str, | ||
max_retries: int = 75, | ||
poke_interval: int = 120, | ||
**kwargs: Any, | ||
) -> None: | ||
super().__init__(**kwargs) | ||
self.job_id = job_id | ||
self.max_retries = max_retries | ||
self.poke_interval = poke_interval | ||
|
||
def execute(self, context: Context) -> Any: | ||
if self.deferrable: | ||
self.defer( | ||
trigger=ComprehendPiiEntitiesDetectionJobCompletedTrigger( | ||
job_id=self.job_id, | ||
waiter_delay=int(self.poke_interval), | ||
waiter_max_attempts=self.max_retries, | ||
aws_conn_id=self.aws_conn_id, | ||
), | ||
method_name="poke", | ||
) | ||
else: | ||
super().execute(context=context) | ||
|
||
def get_state(self) -> str: | ||
return self.hook.conn.describe_pii_entities_detection_job(JobId=self.job_id)[ | ||
"PiiEntitiesDetectionJobProperties" | ||
]["JobStatus"] |
Oops, something went wrong.