-
Notifications
You must be signed in to change notification settings - Fork 15.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FEAT: Add azure cognitive health tool (#13448)
- **Description:** This change adds an agent to the Azure Cognitive Services toolkit for identifying healthcare entities - **Dependencies:** azure-ai-textanalytics (Optional) --------- Co-authored-by: James Beck <[email protected]> Co-authored-by: Bagatur <[email protected]>
- Loading branch information
3 people
authored
Nov 20, 2023
1 parent
6bf9b2c
commit a93616e
Showing
9 changed files
with
213 additions
and
10 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
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
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
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
104 changes: 104 additions & 0 deletions
104
libs/langchain/langchain/tools/azure_cognitive_services/text_analytics_health.py
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,104 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
| from typing import Any, Dict, Optional | ||
|
|
||
| from langchain.callbacks.manager import CallbackManagerForToolRun | ||
| from langchain.pydantic_v1 import root_validator | ||
| from langchain.tools.base import BaseTool | ||
| from langchain.utils import get_from_dict_or_env | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class AzureCogsTextAnalyticsHealthTool(BaseTool): | ||
| """Tool that queries the Azure Cognitive Services Text Analytics for Health API. | ||
| In order to set this up, follow instructions at: | ||
| https://learn.microsoft.com/en-us/azure/ai-services/language-service/text-analytics-for-health/quickstart?tabs=windows&pivots=programming-language-python | ||
| """ | ||
|
|
||
| azure_cogs_key: str = "" #: :meta private: | ||
| azure_cogs_endpoint: str = "" #: :meta private: | ||
| text_analytics_client: Any #: :meta private: | ||
|
|
||
| name: str = "azure_cognitive_services_text_analyics_health" | ||
| description: str = ( | ||
| "A wrapper around Azure Cognitive Services Text Analytics for Health. " | ||
| "Useful for when you need to identify entities in healthcare data. " | ||
| "Input should be text." | ||
| ) | ||
|
|
||
| @root_validator(pre=True) | ||
| def validate_environment(cls, values: Dict) -> Dict: | ||
| """Validate that api key and endpoint exists in environment.""" | ||
| azure_cogs_key = get_from_dict_or_env( | ||
| values, "azure_cogs_key", "AZURE_COGS_KEY" | ||
| ) | ||
|
|
||
| azure_cogs_endpoint = get_from_dict_or_env( | ||
| values, "azure_cogs_endpoint", "AZURE_COGS_ENDPOINT" | ||
| ) | ||
|
|
||
| try: | ||
| import azure.ai.textanalytics as sdk | ||
| from azure.core.credentials import AzureKeyCredential | ||
|
|
||
| values["text_analytics_client"] = sdk.TextAnalyticsClient( | ||
| endpoint=azure_cogs_endpoint, | ||
| credential=AzureKeyCredential(azure_cogs_key), | ||
| ) | ||
|
|
||
| except ImportError: | ||
| raise ImportError( | ||
| "azure-ai-textanalytics is not installed. " | ||
| "Run `pip install azure-ai-textanalytics` to install." | ||
| ) | ||
|
|
||
| return values | ||
|
|
||
| def _text_analysis(self, text: str) -> Dict: | ||
| poller = self.text_analytics_client.begin_analyze_healthcare_entities( | ||
| [{"id": "1", "language": "en", "text": text}] | ||
| ) | ||
|
|
||
| result = poller.result() | ||
|
|
||
| res_dict = {} | ||
|
|
||
| docs = [doc for doc in result if not doc.is_error] | ||
|
|
||
| if docs is not None: | ||
| res_dict["entities"] = [ | ||
| f"{x.text} is a healthcare entity of type {x.category}" | ||
| for y in docs | ||
| for x in y.entities | ||
| ] | ||
|
|
||
| return res_dict | ||
|
|
||
| def _format_text_analysis_result(self, text_analysis_result: Dict) -> str: | ||
| formatted_result = [] | ||
| if "entities" in text_analysis_result: | ||
| formatted_result.append( | ||
| f"""The text contains the following healthcare entities: { | ||
| ', '.join(text_analysis_result['entities']) | ||
| }""".replace("\n", " ") | ||
| ) | ||
|
|
||
| return "\n".join(formatted_result) | ||
|
|
||
| def _run( | ||
| self, | ||
| query: str, | ||
| run_manager: Optional[CallbackManagerForToolRun] = None, | ||
| ) -> str: | ||
| """Use the tool.""" | ||
| try: | ||
| text_analysis_result = self._text_analysis(query) | ||
|
|
||
| return self._format_text_analysis_result(text_analysis_result) | ||
| except Exception as e: | ||
| raise RuntimeError( | ||
| f"Error while running AzureCogsTextAnalyticsHealthTool: {e}" | ||
| ) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.