使用 MyScale 进行自查询

MyScale 是一个集成的向量数据库。您可以通过 SQL 访问您的数据库，也可以通过这里的 LangChain 访问。MyScale 可以利用[各种数据类型和过滤器函数](https://blog.myscale.com/2023/06/06/why-integrated-database- solution-can-boost-your-llm-apps/#filter-on-anything-without-constraints)。无论您是扩展数据还是将系统扩展到更广泛的应用程序，它都可以提升您的 LLM 应用程序的性能。

在笔记本中，我们将演示围绕 MyScale 向量存储器包装的 SelfQueryRetriever，其中包含我们为 LangChain 贡献的一些额外功能。简而言之，可以总结为以下 4 点：

添加 contain 比较器以匹配列表中的任何元素（如果有多个元素匹配）
添加 timestamp 数据类型以进行日期时间匹配（ISO 格式或 YYYY-MM-DD）
添加 like 比较器以进行字符串模式搜索
添加任意函数功能

创建 MyScale 向量存储器

MyScale 已经与 LangChain 集成了一段时间。因此，您可以按照此笔记本创建自己的向量存储器以进行自查询检索。

注意：所有自查询检索器都需要您安装 lark（pip install lark）。我们使用 lark 进行语法定义。在继续下一步之前，我们还想提醒您，您还需要安装 clickhouse-connect 以与 MyScale 后端进行交互。

pip install lark clickhouse-connect

在本教程中，我们遵循其他示例的设置并使用 OpenAIEmbeddings。请记得获取有效访问 LLM 的 OpenAI API 密钥。

import os  
import getpass  
  
os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API 密钥：")  
os.environ["MYSCALE_HOST"] = getpass.getpass("MyScale URL：")  
os.environ["MYSCALE_PORT"] = getpass.getpass("MyScale 端口：")  
os.environ["MYSCALE_USERNAME"] = getpass.getpass("MyScale 用户名：")  
os.environ["MYSCALE_PASSWORD"] = getpass.getpass("MyScale 密码：")  



from langchain.schema import Document  
from langchain.embeddings.openai import OpenAIEmbeddings  
from langchain.vectorstores import MyScale  
  
embeddings = OpenAIEmbeddings()  

API 参考：

Document 来自 langchain.schema
OpenAIEmbeddings 来自 langchain.embeddings.openai
MyScale 来自 langchain.vectorstores

创建一些示例数据

正如您所见，我们创建的数据与其他自查询检索器有所不同。我们将关键字 year 替换为 date，这样您就可以更精细地控制时间戳。我们还将关键字 gerne 的类型更改为字符串列表，LLM 可以使用新的 contain 比较器构建过滤器。我们还提供了 like 比较器和任意函数支持的过滤器，这将在接下来的几个单元格中介绍。

现在让我们先看一下数据。

docs = [  
    Document(  
        page_content="一群科学家带回了恐龙，然后混乱不堪",  
        metadata={"date": "1993-07-02", "rating": 7.7, "genre": ["科幻"]},  
    ),  
    Document(  
        page_content="莱昂纳多·迪卡普里奥迷失在一个梦中的梦中的梦中的...",  
        metadata={"date": "2010-12-30", "director": "克里斯托弗·诺兰", "rating": 8.2},  
    ),  
    Document(  
        page_content="一位心理学家/侦探迷失在一系列梦境中，而《盗梦空间》重新使用了这个想法",  
        metadata={"date": "2006-04-23", "director": "今敏", "rating": 8.6},  
    ),  
    Document(  
        page_content="一群普通大小的女人非常健康，一些男人对她们倾心",  
        metadata={"date": "2019-08-22", "director": "格蕾塔·葛韦格", "rating": 8.3},  
    ),  
    Document(  
        page_content="玩具们活了起来，并且玩得很开心",  
        metadata={"date": "1995-02-11", "genre": ["动画"]},  
    ),  
    Document(  
        page_content="三个人走进区域，三个人走出区域",  
        metadata={  
            "date": "1979-09-10",  
            "rating": 9.9,  
            "director": "安德烈·塔可夫斯基",  
            "genre": ["科幻", "冒险"],  
            "rating": 9.9,  
        },  
    ),  
]  
vectorstore = MyScale.from_documents(  
    docs,  
    embeddings,  
)  

创建我们的自查询检索器

就像其他检索器一样... 简单而美好。

from langchain.llms import OpenAI  
from langchain.retrievers.self_query.base import SelfQueryRetriever  
from langchain.chains.query_constructor.base import AttributeInfo  
  
metadata_field_info = [  
    AttributeInfo(  
        name="genre",  
        description="电影的类型",  
        type="list[string]",  
    ),  
    # 如果您想包含列表的长度，只需将其定义为新列
    # 这将教会 LLM 在构建过滤器时将其用作列。
    AttributeInfo(  
        name="length(genre)",  
        description="电影类型的长度",  
        type="integer",  
    ),  
    # 现在您可以将列定义为时间戳。只需将类型设置为 timestamp。
    AttributeInfo(  
        name="date",  
        description="电影发布日期",  
        type="timestamp",  
    ),  
    AttributeInfo(  
        name="director",  
        description="电影导演的姓名",  
        type="string",  
    ),  
    AttributeInfo(  
        name="rating", description="电影的 1-10 评分", type="float"  
    ),  
]  
document_content_description = "电影的简要摘要"  
llm = OpenAI(temperature=0)  
retriever = SelfQueryRetriever.from_llm(  
    llm, vectorstore, document_content_description, metadata_field_info, verbose=True  
)  

API 参考：

OpenAI 来自 langchain.llms
SelfQueryRetriever 来自 langchain.retrievers.self_query.base
AttributeInfo 来自 langchain.chains.query_constructor.base

使用自查询检索器的现有功能进行测试

现在我们可以尝试实际使用我们的检索器了！

# 此示例仅指定相关查询
retriever.get_relevant_documents("有关恐龙的电影有哪些")  

# 此示例仅指定过滤器
retriever.get_relevant_documents("我想看一部评分高于 8.5 的电影")  

# 此示例指定查询和过滤器
retriever.get_relevant_documents("格蕾塔·葛韦格导演过任何关于女性的电影吗")  

# 此示例指定复合过滤器
retriever.get_relevant_documents(  
    "有一部评分很高（超过 8.5）的科幻电影是什么？"  
)  

# 此示例指定查询和复合过滤器
retriever.get_relevant_documents(  
    "1990 年后但在 2005 年前的关于玩具的电影，最好是动画的"  
)  

等一下... 还有什么其他功能吗？

使用 MyScale 的自查询检索器还可以做更多！让我们来看看。

# 您可以使用 length(genres) 做任何您想做的事情
retriever.get_relevant_documents("有多于 1 个类型的电影是什么？")  

# 精确到秒的日期时间？您已经有了。
retriever.get_relevant_documents("哪部电影是在 1995 年 2 月之后发布的？")  

# 不知道确切的过滤器应该是什么？使用字符串模式匹配！
retriever.get_relevant_documents("电影名字类似于安德烈的是什么？")  

# contain 适用于列表：因此，您可以使用 contain 比较器匹配列表！
retriever.get_relevant_documents(  
    "哪部电影同时具有科幻和冒险两种类型？"  
)  

过滤器 k

我们还可以使用自查询检索器来指定 k：要获取的文档数量。

我们可以通过将 enable_limit=True 传递给构造函数来实现这一点。

retriever = SelfQueryRetriever.from_llm(  
    llm,  
    vectorstore,  
    document_content_description,  
    metadata_field_info,  
    enable_limit=True,  
    verbose=True,  
)  


# 此示例仅指定相关查询
retriever.get_relevant_documents("有关恐龙的两部电影")

使用 MyScale 进行自查询

创建 MyScale 向量存储器​

API 参考：​

创建一些示例数据​

创建我们的自查询检索器​

API 参考：​

使用自查询检索器的现有功能进行测试​

等一下... 还有什么其他功能吗？

过滤器 k​

创建 MyScale 向量存储器

API 参考：

创建一些示例数据

创建我们的自查询检索器

API 参考：

使用自查询检索器的现有功能进行测试

过滤器 k