mirror of
https://github.com/hwchase17/langchain.git
synced 2025-07-04 12:18:24 +00:00
Add security notices to toolkits (#11900)
This adds security notices to toolkits init, and to several toolkits. We'll need to continue documenting the rest of the toolkits. --------- Co-authored-by: Bagatur <baskaryan@gmail.com>
This commit is contained in:
parent
5f4a697ce3
commit
12d7eaa0c2
@ -1,4 +1,18 @@
|
|||||||
"""Agent toolkits."""
|
"""Agent toolkits contain integrations with various resources and services.
|
||||||
|
|
||||||
|
LangChain has a large ecosystem of integrations with various external resources
|
||||||
|
like local and remote file systems, APIs and databases.
|
||||||
|
|
||||||
|
These integrations allow developers to create versatile applications that combine the
|
||||||
|
power of LLMs with the ability to access, interact with and manipulate external
|
||||||
|
resources.
|
||||||
|
|
||||||
|
When developing an application, developers should inspect the capabilities and
|
||||||
|
permissions of the tools that underlie the given agent toolkit, and determine
|
||||||
|
whether permissions of the given toolkit are appropriate for the application.
|
||||||
|
|
||||||
|
See [Security](https://python.langchain.com/docs/security) for more information.
|
||||||
|
"""
|
||||||
from langchain.agents.agent_toolkits.ainetwork.toolkit import AINetworkToolkit
|
from langchain.agents.agent_toolkits.ainetwork.toolkit import AINetworkToolkit
|
||||||
from langchain.agents.agent_toolkits.amadeus.toolkit import AmadeusToolkit
|
from langchain.agents.agent_toolkits.amadeus.toolkit import AmadeusToolkit
|
||||||
from langchain.agents.agent_toolkits.azure_cognitive_services import (
|
from langchain.agents.agent_toolkits.azure_cognitive_services import (
|
||||||
|
@ -47,6 +47,8 @@ class FileManagementToolkit(BaseToolkit):
|
|||||||
- Limit the tools available to the agent to only the file operations
|
- Limit the tools available to the agent to only the file operations
|
||||||
necessary for the agent's intended use.
|
necessary for the agent's intended use.
|
||||||
- Sandbox the agent by running it in a container.
|
- Sandbox the agent by running it in a container.
|
||||||
|
|
||||||
|
See https://python.langchain.com/docs/security for more information.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
root_dir: Optional[str] = None
|
root_dir: Optional[str] = None
|
||||||
|
@ -18,7 +18,17 @@ from langchain.utilities.github import GitHubAPIWrapper
|
|||||||
|
|
||||||
|
|
||||||
class GitHubToolkit(BaseToolkit):
|
class GitHubToolkit(BaseToolkit):
|
||||||
"""GitHub Toolkit."""
|
"""GitHub Toolkit.
|
||||||
|
|
||||||
|
*Security Note*: This toolkit contains tools that can read and modify
|
||||||
|
the state of a service; e.g., by creating, deleting, or updating,
|
||||||
|
reading underlying data.
|
||||||
|
|
||||||
|
For example, this toolkit can be used to create issues, pull requests,
|
||||||
|
and comments on GitHub.
|
||||||
|
|
||||||
|
See [Security](https://python.langchain.com/docs/security) for more information.
|
||||||
|
"""
|
||||||
|
|
||||||
tools: List[BaseTool] = []
|
tools: List[BaseTool] = []
|
||||||
|
|
||||||
|
@ -18,7 +18,17 @@ from langchain.utilities.gitlab import GitLabAPIWrapper
|
|||||||
|
|
||||||
|
|
||||||
class GitLabToolkit(BaseToolkit):
|
class GitLabToolkit(BaseToolkit):
|
||||||
"""GitLab Toolkit."""
|
"""GitLab Toolkit.
|
||||||
|
|
||||||
|
*Security Note*: This toolkit contains tools that can read and modify
|
||||||
|
the state of a service; e.g., by creating, deleting, or updating,
|
||||||
|
reading underlying data.
|
||||||
|
|
||||||
|
For example, this toolkit can be used to create issues, pull requests,
|
||||||
|
and comments on GitLab.
|
||||||
|
|
||||||
|
See https://python.langchain.com/docs/security for more information.
|
||||||
|
"""
|
||||||
|
|
||||||
tools: List[BaseTool] = []
|
tools: List[BaseTool] = []
|
||||||
|
|
||||||
|
@ -27,7 +27,17 @@ SCOPES = ["https://mail.google.com/"]
|
|||||||
|
|
||||||
|
|
||||||
class GmailToolkit(BaseToolkit):
|
class GmailToolkit(BaseToolkit):
|
||||||
"""Toolkit for interacting with Gmail."""
|
"""Toolkit for interacting with Gmail.
|
||||||
|
|
||||||
|
*Security Note*: This toolkit contains tools that can read and modify
|
||||||
|
the state of a service; e.g., by reading, creating, updating, deleting
|
||||||
|
data associated with this service.
|
||||||
|
|
||||||
|
For example, this toolkit can be used to send emails on behalf of the
|
||||||
|
associated account.
|
||||||
|
|
||||||
|
See https://python.langchain.com/docs/security for more information.
|
||||||
|
"""
|
||||||
|
|
||||||
api_resource: Resource = Field(default_factory=build_resource_service)
|
api_resource: Resource = Field(default_factory=build_resource_service)
|
||||||
|
|
||||||
|
@ -14,7 +14,14 @@ from langchain.utilities.jira import JiraAPIWrapper
|
|||||||
|
|
||||||
|
|
||||||
class JiraToolkit(BaseToolkit):
|
class JiraToolkit(BaseToolkit):
|
||||||
"""Jira Toolkit."""
|
"""Jira Toolkit.
|
||||||
|
|
||||||
|
*Security Note*: This toolkit contains tools that can read and modify
|
||||||
|
the state of a service; e.g., by creating, deleting, or updating,
|
||||||
|
reading underlying data.
|
||||||
|
|
||||||
|
See https://python.langchain.com/docs/security for more information.
|
||||||
|
"""
|
||||||
|
|
||||||
tools: List[BaseTool] = []
|
tools: List[BaseTool] = []
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user