Gmail 工具組 (Gmail Toolkit)

這將幫助您開始使用 GMail 工具包。此工具包與 GMail API 互動以讀取訊息、起草和傳送訊息等等。 如需所有 GmailToolkit 功能和配置的詳細文檔，請前往API 參考。

設定

要使用此工具包，您需要按照 Gmail API 文件中的說明設定您的憑證。下載 credentials.json 檔案後，即可開始使用 Gmail API。

安裝

此工具包位於 langchain-google-community 套件中。 我們需要 gmail 額外功能

%pip install -qU langchain-google-community\[gmail\]

如果您想從各個工具的執行中獲得自動追蹤，您也可以取消註釋以下內容來設定您的 LangSmith API 金鑰

# os.environ["LANGCHAIN_TRACING_V2"] = "true"
# os.environ["LANGCHAIN_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

實例化

預設情況下，工具包會讀取本地 credentials.json 檔案。您也可以手動提供 Credentials 物件。

from langchain_google_community import GmailToolkit

toolkit = GmailToolkit()

API 參考：GmailToolkit

自訂驗證

在幕後，使用以下方法建立 googleapi 資源。您可以手動建立 googleapi 資源以進行更多驗證控制。

from langchain_google_community.gmail.utils import (
    build_resource_service,
    get_gmail_credentials,
)

# Can review scopes here https://developers.google.com/gmail/api/auth/scopes
# For instance, readonly scope is 'https://www.googleapis.com/auth/gmail.readonly'
credentials = get_gmail_credentials(
    token_file="token.json",
    scopes=["https://mail.google.com/"],
    client_secrets_file="credentials.json",
)
api_resource = build_resource_service(credentials=credentials)
toolkit = GmailToolkit(api_resource=api_resource)

API 參考：build_resource_service | get_gmail_credentials

工具

檢視可用的工具

tools = toolkit.get_tools()
tools

[GmailCreateDraft(api_resource=<googleapiclient.discovery.Resource object at 0x1094509d0>),
 GmailSendMessage(api_resource=<googleapiclient.discovery.Resource object at 0x1094509d0>),
 GmailSearch(api_resource=<googleapiclient.discovery.Resource object at 0x1094509d0>),
 GmailGetMessage(api_resource=<googleapiclient.discovery.Resource object at 0x1094509d0>),
 GmailGetThread(api_resource=<googleapiclient.discovery.Resource object at 0x1094509d0>)]

• GmailCreateDraft (Gmail 建立草稿)
• GmailSendMessage (Gmail 傳送訊息)
• GmailSearch (Gmail 搜尋)
• GmailGetMessage (Gmail 取得訊息)
• GmailGetThread (Gmail 取得執行緒)

在代理程式中使用

下面我們展示如何將工具包整合到代理程式中。

我們需要 LLM 或聊天模型

選擇 聊天模型

OpenAI

Anthropic

Azure

Google

AWS

Cohere

NVIDIA

Fireworks AI

Groq

Mistral AI

Together AI

Databricks

pip install -qU langchain-openai

import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
  os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(model="gpt-4o-mini")

from langgraph.prebuilt import create_react_agent

agent_executor = create_react_agent(llm, tools)

API 參考：create_react_agent

example_query = "Draft an email to fake@fake.com thanking them for coffee."

events = agent_executor.stream(
    {"messages": [("user", example_query)]},
    stream_mode="values",
)
for event in events:
    event["messages"][-1].pretty_print()

================================ Human Message =================================

Draft an email to fake@fake.com thanking them for coffee.
================================== Ai Message ==================================
Tool Calls:
  create_gmail_draft (call_slGkYKZKA6h3Mf1CraUBzs6M)
 Call ID: call_slGkYKZKA6h3Mf1CraUBzs6M
  Args:
    message: Dear Fake,

I wanted to take a moment to thank you for the coffee yesterday. It was a pleasure catching up with you. Let's do it again soon!

Best regards,
[Your Name]
    to: ['fake@fake.com']
    subject: Thank You for the Coffee
================================= Tool Message =================================
Name: create_gmail_draft

Draft created. Draft Id: r-7233782721440261513
================================== Ai Message ==================================

I have drafted an email to fake@fake.com thanking them for the coffee. You can review and send it from your email draft with the subject "Thank You for the Coffee".

API 參考

如需所有 GmailToolkit 功能和配置的詳細文檔，請前往API 參考。

相關

• 工具 概念指南
• 工具 操作指南