• 2025年8月：

  • 0.59.0 完成 Pydantic V2 迁移 - 验证速度提升5至50倍，采用现代Python编程模式，100%向后兼容。

• 2025年7月：

  • 0.58.0 集成 Crawl4AI - 使用 Playwright 对 JavaScript 为主的网站进行基于浏览器的网页爬取，无需 API 密钥（感谢 @abab-dev！）。
  • 0.57.0 HTML 日志记录器，用于交互式任务可视化 - 自包含的 HTML 日志，支持折叠条目、自动刷新及持久化界面状态。

• 2025年6月：

  • 0.56.0 TaskTool，用于将任务委派给子代理 - 允许代理创建具有特定工具和配置的子代理。
  • 0.55.0 基于事件的任务终止机制 done_sequences - 通过事件模式实现声明式的任务完成。
  • 0.54.0 支持 Portkey AI 网关 - 通过统一的 API 访问跨提供商的200多种模型，并提供缓存、重试和可观ability功能。

• 2025年3–4月：

  • 0.53.0 支持 MCP 工具。
  • 0.52.0 多模态支持，即允许 PDF、图像等输入进入 LLM。
  • 0.51.0 LLMPdfParser，将 GeminiPdfParser 普遍化，直接使用 LLM 解析文档。
  • 0.50.0 基于结构感知的 Markdown 分块，分块内容由章节标题丰富。
  • 0.49.0 支持轻松切换到 LiteLLM 代理服务器。
  • 0.48.0 Exa 爬虫、Markitdown 解析器。
  • 0.47.0 支持 Firecrawl URL 抓取器/爬虫 - 感谢 @abab-dev。
  • 0.46.0 支持 LangDB LLM 网关 - 感谢 @MrunmayS。
  • 0.45.0 使用 Marker 进行 Markdown 解析 - 感谢 @abab-dev。
  • 0.44.0 延迟导入以减少启动时间。感谢 @abab-dev。

• 2025年2月：

  • 0.43.0：GeminiPdfParser 用于使用 Gemini LLM 解析 PDF - 感谢 @abab-dev。
  • 0.42.0：markitdown 解析器，用于处理 pptx、xlsx、xls 文件 感谢 @abab-dev。
  • 0.41.0：pinecone 向量数据库（感谢 @coretado）， Tavily 网络搜索（感谢 @Sozhan308），Exa 网络搜索（感谢 @MuddyHope）。
  • 0.40.0：pgvector 向量数据库。感谢 @abab-dev。
  • 0.39.0：ChatAgentConfig.handle_llm_no_tool 用于处理 LLM 忘记使用工具的情况。
  • 0.38.0：Gemini 嵌入 - 感谢 @abab-dev。
  • 0.37.0：新的 PDF 解析器：docling、pymupdf4llm。

• 2025年1月：

  • 0.36.0：Weaviate 向量数据库支持（感谢 @abab-dev）。
  • 0.35.0：除了最终答案外，还能捕获/流式传输推理型 LLM（如 DeepSeek-R1、OpenAI o1）的推理内容。
  • 0.34.0：DocChatAgent 的分块增强，以提高检索效果。（与 @dfm88 合作）。
  • 0.33.0 从 Poetry 切换到 uv！（感谢 @abab-dev）。
  • 0.32.0 支持 DeepSeek v3。

• 2024年12月：

  • 0.31.0 Azure OpenAI 嵌入。
  • 0.30.0 Llama-cpp 嵌入（感谢 @Kwigg）。
  • 0.29.0 自定义 Azure OpenAI 客户端（感谢 @johannestang）。
  • 0.28.0 ToolMessage：新增 _handler 字段，用于覆盖 request 字段中的默认处理器方法名（感谢 @alexagr）。
  • 0.27.0 支持 OpenRouter。
  • 0.26.0 更新至最新 Chainlit 版本。
  • 0.25.0 为代理和用户响应实现真正的异步方法（感谢 @alexagr）。

• 2024年11月：

  • 0.24.0： 支持在兼容 LLM 上使用严格 JSON 模式输出格式的 Agent，以及 OpenAI 工具 API 的严格模式。 （感谢 @nilspalumbo）。
  • 0.23.0： 支持托管在 glhf.chat 上的 LLM（如 Qwen2.5-Coder-32b-Instruct）。
  • 0.22.0： 提供可选参数以截断大型工具结果。
  • 0.21.0 直接通过 OpenAI 客户端支持 Gemini 模型，而非使用 LiteLLM。
  • 0.20.0 支持 ArangoDB 知识图谱。

• 2024年10月：

  • [0.18.0] LLMConfig.async_stream_quiet 标志，用于在异步 + 流式模式下关闭 LLM 输出。
  • [0.17.0] 基于 XML 的工具，详见 文档。

• 2024年9月：

  • 0.16.0 支持 OpenAI 的 o1-mini 和 o1-preview 模型。
  • 0.15.0 支持 Cerebras API -- 在 Cerebras Cloud 上运行 llama-3.1 模型（推理速度非常快）。
  • 0.14.0 DocChatAgent 使用互反排名融合（RRF）对不同方法检索到的分块进行排序。
  • 0.12.0 run_batch_task 新选项 -- stop_on_first_result - 允许一旦有任一任务返回结果就终止批次任务。

• 2024年8月：

  • 0.11.0 多态的 Task.run()、Task.run_async()。
  • 0.10.0 允许工具处理器返回任意结果类型，包括其他工具。
  • 0.9.0 协调工具，用于信号各种任务状态，并在代理之间传递消息。
  • 0.7.0 支持 OpenAI 工具 API，包括多工具。

• 2024年7月：

  • 0.3.0：添加了来自 Qdrant 的 FastEmbed 嵌入。

• 2024年6月：

  • 0.2.0：改进了 lineage 跟踪、细化了子任务配置，并新增了一种工具 RewindTool， 使代理能够“回退并重做”之前的某条消息（由于 lineage 跟踪，所有依赖该消息的消息都会被清除）。详细说明请参见 此处。

• 2024年5月：

  • 更精简的 langroid：所有文档解析器（如 pdf、doc、docx）以及大多数向量数据库（除 qdrant 外） 现在都成为可选/额外依赖项，这有助于减小构建体积、脚本启动时间和安装时间。为了方便起见，提供了多种“附加组件”分组，例如 doc-chat、db（用于数据库相关依赖）。请参阅下方更新后的安装说明及文档。
  • 工具的少样本示例：在定义 ToolMessage 时，过去可以包含一个名为 examples 的类方法，系统会随机从该列表中选取一个示例来生成 LLM 的单次示例。现在这一功能已改进，您可以直接提供一个示例列表，其中每个示例要么是工具实例，要么是一个元组（描述，工具实例），描述部分是引导 LLM 使用该工具的“思考过程”（详见 文档）。在某些场景下，这能提高 LLM 生成工具的准确性。此外，现在不再随机选取示例，而是使用所有示例来生成少样本示例。
  • 无限循环检测（位于 0.2.0 中）：针对循环长度不超过10的任务循环进行检测（可在 TaskConfig 中配置）。仅检测“完全相同”的循环，而不检测实体反复说类似但不完全相同内容的“近似循环”。
  • “@”地址引用：任何实体都可以通过名称直接引用其他实体，这些名称可以是代理的响应者（“llm”、“user”、“agent”）或子任务名称。这是一种比 RecipientTool 机制更简单的替代方案，但缺点是由于它不是工具，因此无法强制或提醒 LLM 显式指定收件人（在需要明确收件人的情况下）。
  • 大幅改进的引用功能（参见 issue 477） 在使用 DocChatAgent 时，引用的生成和显示得到了显著改善。
  • gpt-4o 现已成为默认 LLM；更新测试和示例以适配该模型；使用与该模型对应的分词器。
  • 通过 litellm 支持 gemini 1.5 pro。
  • QdrantDB：更新以支持学习到的稀疏嵌入。

• 2024年4月：

  • 0.1.236：支持托管在 Groq 上的开源 LLM，例如指定 chat_model="groq/llama3-8b-8192"。 参见 教程。
  • 0.1.235：Task.run()、Task.run_async()、run_batch_tasks 均增加了 max_cost 和 max_tokens 参数，当令牌或成本超过限制时将退出。结果中的 ChatDocument.metadata 现在包含一个 status 字段，该字段是一个代码，表示任务完成的原因。此外，task.run() 等方法也可以显式传入 session_id 字段，该字段用作在 Redis 缓存中查找各种设置的键。 目前仅用于查询“终止状态”——这使得可以通过 task.kill() 或类方法 Task.kill_session(session_id) 杀死正在运行的任务。 示例用法请参见 tests/main/test_task.py 中的 test_task_kill。

• 2024年3月：

  • 0.1.216：改进了 DocChatAgent 的并发运行能力，详见 test_doc_chat_agent.py 特别是 test_doc_chat_batch()； 新增任务运行工具：run_batch_task_gen，允许指定任务生成器，根据输入生成相应任务。
  • 0.1.212：ImagePdfParser：支持从基于图像的 PDF 中提取文本。 （这意味着 DocChatAgent 现在可以处理图像 PDF）。
  • 0.1.194 - 0.1.211：各种修复、改进和功能：
    • 由于对 相关性提取器 的修复，RAG 性能（主要是召回率）得到大幅提升。
    • DocChatAgent 的 上下文窗口修复。
    • 通过 Litellm 支持 Anthropic/Claude3。
    • URLLoader：当 URL 不以 .pdf、.docx 等可识别的后缀结尾时，从头部检测文件时间。
    • 各种 lancedb 集成修复。
    • 根据是否可用 sentence_transformer 模块自动选择嵌入配置。
    • 精简依赖项，将一些较重的依赖项设为可选，例如 unstructured、haystack、chromadb、mkdocs、huggingface-hub、sentence-transformers。
    • 更容易从 import langroid as lr 进行顶层导入。
    • 改善 JSON 检测，尤其是来自弱 LLM。

• 2024年2月：

  • 0.1.193：支持使用 Ollama 新推出的 OpenAI 兼容服务器运行本地 LLM： 只需指定 chat_model="ollama/mistral"。详情请参见 发布说明。
  • 0.1.183：通过 回调 添加了 Chainlit 支持。 请参见 示例。

• 2024年1月：

  • 0.1.175
    • Neo4jChatAgent 用于与 Neo4j 知识图谱对话。 （感谢 Mohannad！）。该代理使用工具查询 Neo4j 模式，并将用户查询转换为 Cypher 查询， 工具处理器执行这些查询，再将结果返回给 LLM 以生成自然语言响应（类似于 SQLChatAgent 的工作方式）。 请参阅使用该代理回答关于 Python 包依赖关系问题的 示例脚本。
    • 支持 .doc 文件解析（除 .docx 外）。
    • 在 OpenAIGPTConfig 中指定可选的 formatter 参数 ，以确保本地 LLM 的聊天格式准确。
  • 0.1.157：DocChatAgentConfig 新增了一个参数：add_fields_to_content，用于指定要插入到主 content 字段中的其他文档字段，以帮助提高检索效果。
  • 0.1.156：新增任务控制信号 PASS_TO、SEND_TO；VectorStore：对文档进行 Pandas 表达式计算；LanceRAGTaskCreator 创建一个由查询规划师、评论员和 RAG 代理组成的三代理 RAG 系统。

• 2023年12月：

  • 0.1.154：（详情请参见 0.1.149 和 0.1.154 的发布说明）。
    • DocChatAgent：导入 Pandas 数据框并进行筛选。
    • LanceDocChatAgent 利用 LanceDB 向量数据库进行高效的向量搜索、全文搜索和筛选。
    • 改进了任务和多代理控制机制。
    • LanceRAGTaskCreator 可创建一个由 LanceFilterAgent 组成的两代理系统，该代理负责决定过滤条件并改写查询发送给 RAG 代理。
  • 0.1.141： API 简化以减少样板代码：自动选择可用的 OpenAI 模型（优先 gpt-4o），简化默认设置。 简化 Task 初始化，使用默认的 ChatAgent。

• 2023年11月：

  • 0.1.126： OpenAIAssistant 代理：支持缓存。

  • 0.1.117：支持 OpenAI Assistant API 工具：函数调用、代码解释器和检索器（RAG）、文件上传。这些功能可与 Langroid 的任务编排无缝集成。 在文档准备就绪之前，建议查看以下使用示例：

    • 测试：
      • test_openai_assistant.py
      • test_openai_assistant_async.py

• 示例脚本： - 最基础的聊天应用 - 与代码解释器聊天 - 带检索功能的聊天（RAG） - 双代理RAG聊天

  • 0.1.112: OpenAIAssistant 是 ChatAgent 的子类，它利用了全新的 OpenAI Assistant API。它可以作为 ChatAgent 的直接替代品使用，并依赖 Assistant API 来维护对话状态，同时借助持久化的线程和助手，在需要时重新连接到它们。示例：test_openai_assistant.py，test_openai_assistant_async.py
  • 0.1.111: 支持最新的 OpenAI 模型：GPT4_TURBO （示例用法参见 test_llm.py）
  • 0.1.110: 从 OpenAI v0.x 升级到 v1.1.1（为迎接 Assistants API 等做准备）；由于 OpenAI 版本冲突，litellm 暂时被禁用。

• 2023年10月：

  • 0.1.107: DocChatAgent 重排序器：rank_with_diversity、rank_to_periphery（避免居中）。
  • 0.1.102: DocChatAgentConfig.n_neighbor_chunks > 0 允许返回匹配内容周围的上下文块。
  • 0.1.101: DocChatAgent 使用 RelevanceExtractorAgent，让 LLM 通过句子编号提取片段中的相关部分，相比 LangChain 在其 LLMChainExtractor 中采用的“逐句复述”方式（即完整写出所有相关句子），这种方法大大提升了速度并降低了成本。
  • 0.1.100: API 更新：现在只需一次导入即可访问 Langroid 的所有功能，例如 import langroid as lr。使用方法请参阅文档。
  • 0.1.99: 提供便捷的批处理函数，可在异步模式下同时对输入列表执行任务和代理方法。示例参见 test_batch.py。
  • 0.1.95: 新增对 Momento Serverless Vector Index 的支持。
  • 0.1.94: 新增对 LanceDB 向量存储的支持——支持向量搜索、全文搜索和 SQL 查询。
  • 0.1.84: 新增 LiteLLM，现在 Langroid 可以与超过 100 家远程或本地 LLM 提供商一起使用！ 使用指南请参见这里。

• 2023年9月：

  • 0.1.78: 多个 Task、Agent 和 LLM 方法的异步版本；现在支持用于 LLM 函数调用、工具和结构化输出的嵌套 Pydantic 类。
  • 0.1.76: DocChatAgent：初步支持加载 docx 文件。
  • 0.1.72: 对 DocChatAgent 进行多项改进：采用更好的嵌入模型、混合搜索提升检索效果、优化 PDF 解析，并使用交叉编码器对检索结果进行重排序。
  • 与本地 Llama 模型一起使用： 请参阅教程这里。
  • Langroid 博客/通讯上线！ 第一篇文章在此——欢迎订阅以获取最新动态。
  • 0.1.56: 支持 Azure OpenAI。
  • 0.1.55: 改进了 SQLChatAgent，该代理在将自然语言翻译成 SQL 时能够高效地检索相关的模式信息。

• 2023年8月：

  • 使用 Langroid 代理和任务编排的层次化计算示例。
  • 0.1.51: 支持全局状态，参见 test_global_state.py。
  • 🐳 Langroid Docker 镜像 已发布，具体说明见下文。
  • RecipientTool 能够使 LLM 在与两个或更多代理对话时指定目标接收者，并强制执行这一规则。 示例用法参见 此测试。
  • 示例： 使用 Google 搜索 + 从 URL 内容中进行向量数据库检索来回答问题。
  • 0.1.39: GoogleSearchTool，使代理及其 LLM 能够通过函数调用/工具的方式进行 Google 搜索。 示例聊天参见 此处，展示了将此工具添加到代理中是多么简单。
  • Colab 笔记本 可用于尝试快速入门示例：
  • 0.1.37: 新增了 SQLChatAgent——感谢我们最新的贡献者 Rithwik Babu!
  • 多代理示例：自动纠错聊天

• 2023年7月：

  • 0.1.30: 新增了 TableChatAgent，用于与表格数据集（数据框、文件、URL）进行[聊天]：LLM 生成 Pandas 代码，然后通过 Langroid 的工具/函数调用机制执行代码。
  • 演示： 面向受众的定位三代理系统。
  • 0.1.27: 新增对 Momento Serverless Cache 的支持，作为 Redis 的替代方案。
  • 0.1.24: DocChatAgent 现在可以接受 PDF 文件或 URL。

如果您正在使用 SQLChatAgent（例如脚本 examples/data-qa/sql-chat/sql_chat.py），并且连接的是 PostgreSQL 数据库，您需要：

• 为您的平台安装 PostgreSQL 开发库，例如：
  • 在 Ubuntu 上运行 sudo apt-get install libpq-dev，
  • 在 Mac 上运行 brew install postgresql 等。
• 安装带有 postgres 附加组件的 Langroid，例如 pip install langroid[postgres] 或 poetry add "langroid[postgres]" 或 poetry install -E postgres， （或者使用相应的 uv 版本，例如 uv add "langroid[postgres]" 或 uv pip install langroid[postgres]）。 如果出现错误，请尝试在您的虚拟环境中运行 pip install psycopg2-binary。

以下所有环境变量设置均为可选，其中一些仅在使用特定功能时才需要（如下所述）。

• Qdrant 向量存储 API 密钥、URL。这仅在您想使用 Qdrant 云服务时才需要。 或者，目前也支持 Chroma 和 LanceDB。 我们使用 Chroma 的本地存储版本，因此无需 API 密钥。
• Redis 密码、主机、端口：这是可选的，仅在使用 Redis Cloud 缓存 LLM API 响应时才需要。 Redis 提供 一个免费的 30MB Redis 账户， 这足以试用 Langroid，甚至超出其需求。 如果您不进行这些设置，Langroid 将使用纯 Python 的 Redis 内存缓存， 通过 Fakeredis 库实现。
• Momento 用于缓存 LLM API 响应的无服务器服务（作为 Redis 的替代方案）。 若要使用 Momento 而不是 Redis：
  • 在 .env 文件中输入您的 Momento 令牌，作为 MOMENTO_AUTH_TOKEN 的值（见下方示例文件），
  • 在 .env 文件中将 CACHE_TYPE=momento（而不是默认的 CACHE_TYPE=redis）。
• GitHub 个人访问令牌（对于需要分析 git 仓库的应用程序是必需的； 基于令牌的 API 调用速率限制较少）。请参阅此 GitHub 页面。
• Google 自定义搜索 API 凭证： 仅在启用代理使用 GoogleSearchTool 时才需要。 要将 Google 搜索作为 LLM 工具/插件/函数调用使用， 您需要先设置 Google API 密钥， 然后 设置 Google 自定义搜索引擎 (CSE) 并获取 CSE ID。 （这些文档可能比较复杂，建议向 GPT4 请求逐步指南。） 获取这些凭证后，将其作为 GOOGLE_API_KEY 和 GOOGLE_CSE_ID 的值存储在您的 .env 文件中。 关于如何使用此类“无状态”工具的完整文档即将发布，但在此期间，您可以查看此 聊天示例，其中展示了如何轻松地为代理配备 GoogleSearchtool。

如果您添加了所有这些可选变量，您的 .env 文件应如下所示：

OPENAI_API_KEY=your-key-here-without-quotes
GITHUB_ACCESS_TOKEN=your-personal-access-token-no-quotes
CACHE_TYPE=redis # 或 momento
REDIS_PASSWORD=your-redis-password-no-quotes
REDIS_HOST=your-redis-hostname-no-quotes
REDIS_PORT=your-redis-port-no-quotes
MOMENTO_AUTH_TOKEN=your-momento-token-no-quotes # 替代 REDIS* 变量
QDRANT_API_KEY=your-key
QDRANT_API_URL=https://your.url.here:6333 # 注意必须包含端口号
GOOGLE_API_KEY=your-key
GOOGLE_CSE_ID=your-cse-id

在使用 Azure OpenAI 时，.env 文件中需要额外的环境变量。 此页面 Microsoft Azure OpenAI 提供了更多信息，您可以按如下方式设置每个环境变量：

• AZURE_OPENAI_API_KEY，来自 API_KEY 的值
• AZURE_OPENAI_API_BASE 来自 ENDPOINT 的值，通常看起来像 https://your.domain.azure.com。
• 对于 AZURE_OPENAI_API_VERSION，您可以使用 .env-template 中的默认值， 最新版本可在 这里 找到。
• AZURE_OPENAI_DEPLOYMENT_NAME 是已部署模型的名称，由用户在模型设置过程中定义。
• AZURE_OPENAI_MODEL_NAME Azure OpenAI 允许在部署模型时指定特定的模型名称。 您需要准确填写所选的模型名称。例如，GPT-4（应为 gpt-4-32k 或 gpt-4）。
• AZURE_OPENAI_MODEL_VERSION 是必需的，如果 AZURE_OPENAI_MODEL_NAME = gpt-4， 这将帮助 Langroid 确定模型的成本。

import langroid.language_models as lm

mdl = lm.OpenAIGPT(
    lm.OpenAIGPTConfig(
        chat_model=lm.OpenAIChatModel.GPT4o, # 或者，例如  "ollama/qwen2.5"
    ),
)

messages = [
  lm.LLMMessage(content="You are a helpful assistant",  role=lm.Role.SYSTEM), 
  lm.LLMMessage(content="What is the capital of Ontario?",  role=lm.Role.USER),
]

response = mdl.chat(messages, max_tokens=200)
print(response.message)

请参阅相关指南以了解如何使用 (本地/开源 LLM 或 远程/商用 LLM)。

cfg = lm.OpenAIGPTConfig(
  chat_model="local/localhost:8000", 
  chat_context_length=4096
)
mdl = lm.OpenAIGPT(cfg)
# 现在可以像上面一样与其交互，或者按照下方所示创建 Agent + Task。

import langroid as lr

agent = lr.ChatAgent()

# 获取智能体 LLM 的响应，并将其放入交互式循环中...
# answer = agent.llm_response("What is the capital of Ontario?")
  # ... 或者，改为设置一个任务（内置循环），并运行它
task = lr.Task(agent, name="Bot") 
task.run() # ... 每轮都会向 LLM 或用户寻求响应的循环

一个简单的数字游戏，当给定一个数字 n 时：

• repeater_task 的 LLM 只需返回 n，
• even_task 的 LLM 如果 n 是偶数则返回 n/2，否则返回 “DO-NOT-KNOW”；
• odd_task 的 LLM 如果 n 是奇数则返回 3*n+1，否则返回 “DO-NOT-KNOW”。

每个 Task 都会自动配置一个默认的 ChatAgent。

import langroid as lr
from langroid.utils.constants import NO_ANSWER

repeater_task = lr.Task(
    name = "Repeater",
    system_message="""
    Your job is to repeat whatever number you receive.
    """,
    llm_delegate=True, # LLM 负责处理任务
    single_round=False, 
)

even_task = lr.Task(
    name = "EvenHandler",
    system_message=f"""
    You will be given a number. 
    If it is even, divide by 2 and say the result, nothing else.
    If it is odd, say {NO_ANSWER}
    """,
    single_round=True,  # 任务在收到有效响应后完成
)

odd_task = lr.Task(
    name = "OddHandler",
    system_message=f"""
    You will be given a number n. 
    If it is odd, return (n*3+1), say nothing else. 
    If it is even, say {NO_ANSWER}
    """,
    single_round=True,  # 任务在收到有效响应后完成
)

然后将 even_task 和 odd_task 添加为 repeater_task 的子任务， 并运行 repeater_task，以一个数字作为输入：

repeater_task.add_sub_task([even_task, odd_task])
repeater_task.run("3")

Langroid 利用 Pydantic 支持 OpenAI 的 函数调用 API 以及其自身的原生工具。这样做的好处是，你无需编写任何 JSON 来指定模式；此外，如果 LLM 生成了格式错误的工具调用语法，Langroid 会将经过适当清理的 Pydantic 验证错误发送回 LLM，以便其进行修正！

简单示例：假设智能体有一个秘密数字列表， 我们希望 LLM 找到该列表中的最小数字。我们想为 LLM 提供一个名为 probe 的工具/函数，该工具接受一个数字 n 作为参数。智能体中的工具处理方法会返回其列表中小于等于 n 的数字数量。

首先使用 Langroid 的 ToolMessage 类定义该工具：

import langroid as lr

class ProbeTool(lr.agent.ToolMessage):
  request: str = "probe" # 指定由哪个智能体方法处理此工具
  purpose: str = """
        To find how many numbers in my list are less than or equal to  
        the <number> you specify.
        """ # 描述用于指导 LLM 何时以及如何使用该工具
  number: int  # 工具所需的参数

然后定义一个 SpyGameAgent 类，作为 ChatAgent 的子类， 并添加一个名为 probe 的方法来处理该工具：

class SpyGameAgent(lr.ChatAgent):
  def __init__(self, config: lr.ChatAgentConfig):
    super().__init__(config)
    self.numbers = [3, 4, 8, 11, 15, 25, 40, 80, 90]

  def probe(self, msg: ProbeTool) -> str:
    # 返回 self.numbers 中小于或等于 msg.number 的数字数量
    return str(len([n for n in self.numbers if n <= msg.number]))

接下来实例化该智能体，并启用其使用和响应工具的功能：

spy_game_agent = SpyGameAgent(
    lr.ChatAgentConfig(
        name="间谍",
        vecdb=None,
        use_tools=False, # 不使用 Langroid 原生工具
        use_functions_api=True, # 使用 OpenAI 函数调用 API
    )
)
spy_game_agent.enable_message(ProbeTool)

完整的工作示例请参阅 langroid-examples 仓库中的脚本 chat-agent-tool.py。

假设您希望代理从租赁文件中提取租赁的关键条款，并将其表示为嵌套的 JSON 结构。首先，通过 Pydantic 模型定义所需的结构：

from pydantic import BaseModel
class LeasePeriod(BaseModel):
    start_date: str
    end_date: str


class LeaseFinancials(BaseModel):
    monthly_rent: str
    deposit: str

class Lease(BaseModel):
    period: LeasePeriod
    financials: LeaseFinancials
    address: str

然后，将 LeaseMessage 工具定义为 Langroid 的 ToolMessage 子类。请注意，该工具有一个名为 terms 的必填参数，类型为 Lease：

import langroid as lr

class LeaseMessage(lr.agent.ToolMessage):
    request: str = "lease_info"
    purpose: str = """
        收集商业租赁的相关信息。
        """
    terms: Lease

接下来，定义一个 LeaseExtractorAgent 类，其中包含处理此工具的方法 lease_info，实例化该代理，并启用其使用和响应此工具的功能：

class LeaseExtractorAgent(lr.ChatAgent):
    def lease_info(self, message: LeaseMessage) -> str:
        print(
            f"""
        完成！成功提取了租赁信息：
        {message.terms}
        """
        )
        return json.dumps(message.terms.dict())
    
lease_extractor_agent = LeaseExtractorAgent()
lease_extractor_agent.enable_message(LeaseMessage)

完整的工作示例请参阅 langroid-examples 仓库中的脚本 chat_multi_extract.py。

Langroid 提供了一个专门的代理类 DocChatAgent 用于此目的。它集成了文档分片、嵌入、向量数据库存储以及检索增强的问答生成功能。使用此类与一组文档进行对话非常简单。首先创建一个 DocChatAgentConfig 实例，并设置 doc_paths 字段来指定要与之对话的文档。

import langroid as lr
from langroid.agent.special import DocChatAgentConfig, DocChatAgent

config = DocChatAgentConfig(
  doc_paths = [
    "https://en.wikipedia.org/wiki/Language_model",
    "https://en.wikipedia.org/wiki/N-gram_language_model",
    "/path/to/my/notes-on-language-models.txt",
  ],
  vecdb=lr.vector_store.QdrantDBConfig(),
)

然后实例化 DocChatAgent（这会将文档摄入向量数据库）：

agent = DocChatAgent(config)

之后，我们可以向代理提出一次性问题：

agent.llm_response("什么是语言模型？")

或者将其包装在一个 Task 中，并与用户进行交互式循环：

task = lr.Task(agent)
task.run()

完整的可运行脚本请参阅 langroid-examples 仓库中 docqa 文件夹下的相关脚本。

使用 Langroid，您可以设置一个 TableChatAgent 并为其提供数据集（文件路径、URL 或数据框），然后对其进行查询。代理的 LLM 会通过函数调用（或工具/插件）生成 Pandas 代码来回答查询，而代理的函数处理方法则会执行这些代码并返回答案。

以下是具体操作步骤：

import langroid as lr
from langroid.agent.special import TableChatAgent, TableChatAgentConfig

为数据文件、URL 或数据框设置一个 TableChatAgent（确保数据表有标题行；分隔符会自动检测）：

dataset =  "https://archive.ics.uci.edu/ml/machine-learning-databases/wine-quality/winequality-red.csv"


# 或者 dataset = "/path/to/my/data.csv"
# 或者 dataset = pd.read_csv("/path/to/my/data.csv")
agent = TableChatAgent(
    config=TableChatAgentConfig(
        data=dataset,
    )
)

设置一个任务，并像这样提出一次性问题：

task = lr.Task(
  agent, 
  name = "DataAssistant",
  default_human_response="", # 避免等待用户输入
)
result = task.run(
  "质量评分高于 7 的葡萄酒的平均酒精含量是多少？",
  turns=2 # 在用户提问、LLM 函数调用/工具响应、代理代码执行结果后返回
) 
print(result.content)

或者，您也可以设置一个任务，并与用户进行交互式循环：

task = lr.Task(agent, name="DataAssistant")
task.run()

完整的工作示例请参阅 langroid-examples 仓库中的脚本 table_chat.py。