#
# 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.
"""This module contains a Google Cloud Natural Language Hook."""
from __future__ import annotations
from collections.abc import Sequence
from typing import TYPE_CHECKING
from google.api_core.gapic_v1.method import DEFAULT, _MethodDefault
from google.cloud.language_v1 import EncodingType, LanguageServiceClient
from google.cloud.language_v1.types import (
AnalyzeEntitiesResponse,
AnalyzeEntitySentimentResponse,
AnalyzeSentimentResponse,
AnalyzeSyntaxResponse,
AnnotateTextRequest,
AnnotateTextResponse,
ClassifyTextResponse,
Document,
)
from airflow.providers.google.common.consts import CLIENT_INFO
from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
if TYPE_CHECKING:
from google.api_core.retry import Retry
[docs]class CloudNaturalLanguageHook(GoogleBaseHook):
"""
Hook for Google Cloud Natural Language Service.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
of the last account in the list, which will be impersonated in the request.
If set as a string, the account must grant the originating account
the Service Account Token Creator IAM role.
If set as a sequence, the identities from the list must grant
Service Account Token Creator IAM role to the directly preceding identity, with first
account from the list granting this role to the originating account.
"""
def __init__(
self,
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(
gcp_conn_id=gcp_conn_id,
impersonation_chain=impersonation_chain,
**kwargs,
)
self._conn: LanguageServiceClient | None = None
[docs] def get_conn(self) -> LanguageServiceClient:
"""
Retrieve connection to Cloud Natural Language service.
:return: Cloud Natural Language service object
"""
if not self._conn:
self._conn = LanguageServiceClient(credentials=self.get_credentials(), client_info=CLIENT_INFO)
return self._conn
@GoogleBaseHook.quota_retry()
[docs] def analyze_entities(
self,
document: dict | Document,
encoding_type: EncodingType | None = None,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> AnalyzeEntitiesResponse:
"""
Find named entities in the text along with various properties.
Examples properties: entity types, salience, mentions for each entity, and others.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param encoding_type: The encoding type used by the API to calculate offsets.
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
return client.analyze_entities(
document=document, encoding_type=encoding_type, retry=retry, timeout=timeout, metadata=metadata
)
@GoogleBaseHook.quota_retry()
[docs] def analyze_entity_sentiment(
self,
document: dict | Document,
encoding_type: EncodingType | None = None,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> AnalyzeEntitySentimentResponse:
"""
Similar to AnalyzeEntities, also analyzes sentiment associated with each entity and its mentions.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param encoding_type: The encoding type used by the API to calculate offsets.
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
return client.analyze_entity_sentiment(
document=document, encoding_type=encoding_type, retry=retry, timeout=timeout, metadata=metadata
)
@GoogleBaseHook.quota_retry()
[docs] def analyze_sentiment(
self,
document: dict | Document,
encoding_type: EncodingType | None = None,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> AnalyzeSentimentResponse:
"""
Analyzes the sentiment of the provided text.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param encoding_type: The encoding type used by the API to calculate offsets.
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
return client.analyze_sentiment(
document=document, encoding_type=encoding_type, retry=retry, timeout=timeout, metadata=metadata
)
@GoogleBaseHook.quota_retry()
[docs] def analyze_syntax(
self,
document: dict | Document,
encoding_type: EncodingType | None = None,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> AnalyzeSyntaxResponse:
"""
Analyzes the syntax of the text.
Provides sentence boundaries and tokenization along with part
of speech tags, dependency trees, and other properties.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param encoding_type: The encoding type used by the API to calculate offsets.
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
return client.analyze_syntax(
document=document, encoding_type=encoding_type, retry=retry, timeout=timeout, metadata=metadata
)
@GoogleBaseHook.quota_retry()
[docs] def annotate_text(
self,
document: dict | Document,
features: dict | AnnotateTextRequest.Features,
encoding_type: EncodingType | None = None,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> AnnotateTextResponse:
"""
Provide all features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param features: The enabled features.
If a dict is provided, it must be of the same form as the protobuf message Features
:param encoding_type: The encoding type used by the API to calculate offsets.
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
if isinstance(features, dict):
features = AnnotateTextRequest.Features(features)
return client.annotate_text(
document=document,
features=features,
encoding_type=encoding_type,
retry=retry,
timeout=timeout,
metadata=metadata,
)
@GoogleBaseHook.quota_retry()
[docs] def classify_text(
self,
document: dict | Document,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> ClassifyTextResponse:
"""
Classifies a document into categories.
:param document: Input document.
If a dict is provided, it must be of the same form as the protobuf message Document
:param retry: A retry object used to retry requests. If None is specified, requests will not be
retried.
:param timeout: The amount of time, in seconds, to wait for the request to complete. Note that if
retry is specified, the timeout applies to each individual attempt.
:param metadata: Additional metadata that is provided to the method.
"""
client = self.get_conn()
if isinstance(document, dict):
document = Document(document)
return client.classify_text(document=document, retry=retry, timeout=timeout, metadata=metadata)