Source code for langchain_community.agent_toolkits.gmail.toolkit

from __future__ import annotations

from typing import TYPE_CHECKING, List

from langchain_core.pydantic_v1 import Field
from langchain_core.tools import BaseToolkit

from langchain_community.tools import BaseTool
from langchain_community.tools.gmail.create_draft import GmailCreateDraft
from langchain_community.tools.gmail.get_message import GmailGetMessage
from langchain_community.tools.gmail.get_thread import GmailGetThread
from langchain_community.tools.gmail.search import GmailSearch
from langchain_community.tools.gmail.send_message import GmailSendMessage
from langchain_community.tools.gmail.utils import build_resource_service

if TYPE_CHECKING:
    # This is for linting and IDE typehints
    from googleapiclient.discovery import Resource
else:
    try:
        # We do this so pydantic can resolve the types when instantiating
        from googleapiclient.discovery import Resource
    except ImportError:
        pass


SCOPES = ["https://mail.google.com/"]


class GmailToolkit(BaseToolkit):
    """与Gmail交互的工具包。

    *安全提示*: 该工具包包含可以读取和修改服务状态的工具；
        例如，通过读取、创建、更新、删除与该服务相关联的数据。

        例如，该工具包可用于代表相关账户发送电子邮件。

        有关更多信息，请参见https://python.langchain.com/docs/security。"""

    api_resource: Resource = Field(default_factory=build_resource_service)

    class Config:
        """Pydantic配置。"""

        arbitrary_types_allowed = True

    def get_tools(self) -> List[BaseTool]:
        """获取工具包中的工具。"""
        return [
            GmailCreateDraft(api_resource=self.api_resource),
            GmailSendMessage(api_resource=self.api_resource),
            GmailSearch(api_resource=self.api_resource),
            GmailGetMessage(api_resource=self.api_resource),
            GmailGetThread(api_resource=self.api_resource),
        ]