The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
Community: Update and fix ZenGuardTool docs and add ZenguardTool to init files (#23415)
Nuradilc93d9e66e46a
diff --git a/docs/docs/integrations/tools/zenguard.ipynb b/docs/docs/integrations/tools/zenguard.ipynbindex 5e8b81e44a..53a510d3dc 100644--- a/docs/docs/integrations/tools/zenguard.ipynb+++ b/docs/docs/integrations/tools/zenguard.ipynb@@ -4,11 +4,11 @@"cell_type": "markdown","metadata": {},"source": [- "# ZenGuard AI Langchain Tool\n",+ "# ZenGuard AI\n","\n",- "<a href=\"https://colab.research.google.com/github/langchain-ai/langchail/blob/main/docs/docs/integrations/tools/zenguard.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\" /></a>\n",+ "<a href=\"https://colab.research.google.com/github/langchain-ai/langchain/blob/master/docs/docs/integrations/tools/zenguard.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\" /></a>\n","\n",- "This Langchain Tool lets you quickly set up [ZenGuard AI](https://www.zenguard.ai/) in your Langchain-powered application. The ZenGuard AI provides ultrafast guardrails to protect your GenAI application from:\n",+ "This tool lets you quickly set up [ZenGuard AI](https://www.zenguard.ai/) in your Langchain-powered application. The ZenGuard AI provides ultrafast guardrails to protect your GenAI application from:\n","\n","- Prompts Attacks\n","- Veering of the pre-defined topics\n",@@ -86,7 +86,7 @@},"outputs": [],"source": [- "%set_env ZENGUARD_API_KEY="+ "%set_env ZENGUARD_API_KEY=your_api_key"]},{@@ -131,6 +131,7 @@"* `is_detected(boolean)`: Indicates whether a prompt injection attack was detected in the provided message. In this example, it is False.\n"," * `score(float: 0.0 - 1.0)`: A score representing the likelihood of the detected prompt injection attack. In this example, it is 0.0.\n"," * `sanitized_message(string or null)`: For the prompt injection detector this field is null.\n",+ " * `latency(float or null)`: Time in milliseconds during which the detection was performed\n","\n"," **Error Codes:**\n","\n",diff --git a/libs/community/langchain_community/tools/__init__.py b/libs/community/langchain_community/tools/__init__.pyindex 71445fa6cc..76ea0474de 100644--- a/libs/community/langchain_community/tools/__init__.py+++ b/libs/community/langchain_community/tools/__init__.py@@ -318,6 +318,11 @@ if TYPE_CHECKING:ZapierNLAListActions,ZapierNLARunAction,)+ from langchain_community.tools.zenguard.tool import (+ Detector,+ ZenGuardInput,+ ZenGuardTool,+ )__all__ = ["AINAppOps",@@ -456,6 +461,9 @@ __all__ = ["YouTubeSearchTool","ZapierNLAListActions","ZapierNLARunAction",+ "Detector",+ "ZenGuardInput",+ "ZenGuardTool","authenticate","format_tool_to_openai_function","tool",@@ -503,6 +511,7 @@ _module_lookup = {"CurrentWebPageTool": "langchain_community.tools.playwright","DataheraldTextToSQL": "langchain_community.tools.dataherald.tool","DeleteFileTool": "langchain_community.tools.file_management",+ "Detector": "langchain_community.tools.zenguard.tool","DuckDuckGoSearchResults": "langchain_community.tools.ddg_search.tool","DuckDuckGoSearchRun": "langchain_community.tools.ddg_search.tool","E2BDataAnalysisTool": "langchain_community.tools.e2b_data_analysis.tool",@@ -601,6 +610,8 @@ _module_lookup = {"YouTubeSearchTool": "langchain_community.tools.youtube.search","ZapierNLAListActions": "langchain_community.tools.zapier.tool","ZapierNLARunAction": "langchain_community.tools.zapier.tool",+ "ZenGuardInput": "langchain_community.tools.zenguard.tool",+ "ZenGuardTool": "langchain_community.tools.zenguard.tool","authenticate": "langchain_community.tools.office365.utils","format_tool_to_openai_function": "langchain_community.tools.convert_to_openai","tool": "langchain_core.tools",diff --git a/libs/community/langchain_community/tools/zenguard/__init__.py b/libs/community/langchain_community/tools/zenguard/__init__.pyindex 398d14dbc3..ac9ddbb11b 100644--- a/libs/community/langchain_community/tools/zenguard/__init__.py+++ b/libs/community/langchain_community/tools/zenguard/__init__.py@@ -1,4 +1,4 @@-from langchain_community.tools.zenguard.tools import (+from langchain_community.tools.zenguard.tool import (Detector,ZenGuardInput,ZenGuardTool,diff --git a/libs/community/langchain_community/tools/zenguard/tools.py b/libs/community/langchain_community/tools/zenguard/tool.pysimilarity index 100%rename from libs/community/langchain_community/tools/zenguard/tools.pyrename to libs/community/langchain_community/tools/zenguard/tool.pydiff --git a/libs/community/tests/integration_tests/tools/zenguard/test_zenguard.py b/libs/community/tests/integration_tests/tools/zenguard/test_zenguard.pyindex 0fe8e6f481..7d7ef81a45 100644--- a/libs/community/tests/integration_tests/tools/zenguard/test_zenguard.py+++ b/libs/community/tests/integration_tests/tools/zenguard/test_zenguard.py@@ -3,7 +3,7 @@ from typing import Any, Dict, Listimport pytest-from langchain_community.tools.zenguard.tools import Detector, ZenGuardTool+from langchain_community.tools.zenguard.tool import Detector, ZenGuardTool@pytest.fixture()diff --git a/libs/community/tests/unit_tests/tools/test_imports.py b/libs/community/tests/unit_tests/tools/test_imports.pyindex 346fb422fa..6b6cff21be 100644--- a/libs/community/tests/unit_tests/tools/test_imports.py+++ b/libs/community/tests/unit_tests/tools/test_imports.py@@ -135,6 +135,9 @@ EXPECTED_ALL = ["YouTubeSearchTool","ZapierNLAListActions","ZapierNLARunAction",+ "Detector",+ "ZenGuardInput",+ "ZenGuardTool","authenticate","format_tool_to_openai_function","tool",diff --git a/libs/community/tests/unit_tests/tools/test_public_api.py b/libs/community/tests/unit_tests/tools/test_public_api.pyindex 5fb367f714..7abc0abcfd 100644--- a/libs/community/tests/unit_tests/tools/test_public_api.py+++ b/libs/community/tests/unit_tests/tools/test_public_api.py@@ -138,6 +138,9 @@ _EXPECTED = ["YouTubeSearchTool","ZapierNLAListActions","ZapierNLARunAction",+ "Detector",+ "ZenGuardInput",+ "ZenGuardTool","authenticate","format_tool_to_openai_function","tool",