DeepLake自查询
DeepLake是一个用于构建AI应用程序的多模态数据库。
在笔记本中,我们将演示围绕DeepLake向量存储器的SelfQueryRetriever
。
创建DeepLake向量存储器
首先,我们需要创建一个DeepLake向量存储器,并使用一些数据进行初始化。我们已经创建了一组包含电影摘要的小型演示文档。
注意:自查询检索器需要您安装lark
(pip install lark
)。我们还需要deeplake
包。
#!pip install lark
#!pip install 'deeplake[enterprise]'
我们想要使用OpenAIEmbeddings
,因此我们需要获取OpenAI API密钥。
import os
import getpass
os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:")
from langchain.schema import Document
from langchain.embeddings.openai import OpenAIEmbeddings
from langchain.vectorstores import DeepLake
embeddings = OpenAIEmbeddings()
API参考:
- Document 来自
langchain.schema
- OpenAIEmbeddings 来自
langchain.embeddings.openai
- DeepLake 来自
langchain.vectorstores
docs = [
Document(
page_content="一群科学家带回恐龙,然后造成了混乱",
metadata={"year": 1993, "rating": 7.7, "genre": "科幻"},
),
Document(
page_content="莱昂纳多·迪卡普里奥迷失在一个梦中的梦中的梦中的...",
metadata={"year": 2010, "director": "克里斯托弗·诺兰", "rating": 8.2},
),
Document(
page_content="一位心理学家/侦探迷失在一系列梦境中,而《盗梦空间》重新利用了这个想法",
metadata={"year": 2006, "director": "今敏", "rating": 8.6},
),
Document(
page_content="一群普通大小的女人非常纯真,一些男人对她们心生渴望",
metadata={"year": 2019, "director": "格蕾塔·葛韦格", "rating": 8.3},
),
Document(
page_content="玩具们活了起来,并且玩得很开心",
metadata={"year": 1995, "genre": "动画"},
),
Document(
page_content="三个人走进区域,三个人走出区域",
metadata={
"year": 1979,
"rating": 9.9,
"director": "安德烈·塔可夫斯基",
"genre": "科幻",
},
),
]
username_or_org = "<USER_NAME_OR_ORG>"
vectorstore = DeepLake.from_documents(
docs, embeddings, dataset_path=f"hub://{username_or_org}/self_queery"
)
Your Deep Lake dataset has been successfully created!
-
Dataset(path='hub://adilkhan/self_queery', tensors=['embedding', 'id', 'metadata', 'text'])
tensor htype shape dtype compression
------- ------- ------- ------- -------
embedding embedding (6, 1536) float32 None
id text (6, 1) str None
metadata json (6, 1) str None
text text (6, 1) str None
创建我们的自查询检索器
现在我们可以实例化我们的检索器。为此,我们需要提前提供一些关于我们的文档支持的元数据字段的信息以及文档内容的简短描述。
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="字符串或字符串列表",
),
AttributeInfo(
name="year",
description="电影的发行年份",
type="整数",
),
AttributeInfo(
name="director",
description="电影导演的姓名",
type="字符串",
),
AttributeInfo(
name="rating",
description="电影的评分(1-10)",
type="浮点数",
),
]
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("有关恐龙的电影有哪些")
/Users/adilkhansarsen/Documents/work/LangChain/langchain/langchain/chains/llm.py:275: UserWarning: The predict_and_parse method is deprecated, instead pass an output parser directly to LLMChain.
warnings.warn(
query='dinosaur' filter=None limit=None
[Document(page_content='一群科学家带回恐龙,然后造成了混乱', metadata={'year': 1993, 'rating': 7.7, 'genre': '科幻'}),
Document(page_content='玩具们活了起来,并且玩得很开心', metadata={'year': 1995, 'genre': '动画'}),
Document(page_content='三个人走进区域,三个人走出区域', metadata={'year': 1979, 'rating': 9.9, 'director': '安德烈·塔可夫斯基', 'genre': '科幻'}),
Document(page_content='一位心理学家/侦探迷失在一系列梦境中,而《盗梦空间》重新利用了这个想法', metadata={'year': 2006, 'director': '今敏', 'rating': 8.6})]
# 这个例子只指定了一个过滤器
retriever.get_relevant_documents("我想看一部评分高于8.5的电影")
query=' ' filter=Comparison(comparator=<Comparator.GT: 'gt'>, attribute='rating', value=8.5) limit=None
[Document(page_content='一位心理学家/侦探迷失在一系列梦境中,而《盗梦空间》重新利用了这个想法', metadata={'year': 2006, 'director': '今敏', 'rating': 8.6}),
Document(page_content='三个人走进区域,三个人走出区域', metadata={'year': 1979, 'rating': 9.9, 'director': '安德烈·塔可夫斯基', 'genre': '科幻'})]
# 这个例子指定了一个查询和一个过滤器
retriever.get_relevant_documents("格蕾塔·葛韦格导演过关于女性的电影吗")
query='women' filter=Comparison(comparator=<Comparator.EQ: 'eq'>, attribute='director', value='Greta Gerwig') limit=None
[Document(page_content='一群普通大小的女人非常纯真,一些男人对她们心生渴望', metadata={'year': 2019, 'director': '格蕾塔·葛韦格', 'rating': 8.3})]
# 这个例子指定了一个复合过滤器
retriever.get_relevant_documents(
"有没有一部评分很高(超过8.5)的科幻电影?"
)
query=' ' filter=Operation(operator=<Operator.AND: 'and'>, arguments=[Comparison(comparator=<Comparator.GTE: 'gte'>, attribute='rating', value=8.5), Comparison(comparator=<Comparator.EQ: 'eq'>, attribute='genre', value='science fiction')]) limit=None
[Document(page_content='三个人走进区域,三个人走出区域', metadata={'year': 1979, 'rating': 9.9, 'director': '安德烈·塔可夫斯基', 'genre': '科幻'})]
# 这个例子指定了一个查询和复合过滤器
retriever.get_relevant_documents(
"1990年后但2005年前的关于玩具的电影,最好是动画片"
)
query='toys' filter=Operation(operator=<Operator.AND: 'and'>, arguments=[Comparison(comparator=<Comparator.GT: 'gt'>, attribute='year', value=1990), Comparison(comparator=<Comparator.LT: 'lt'>, attribute='year', value=2005), Comparison(comparator=<Comparator.EQ: 'eq'>, attribute='genre', value='animated')]) limit=None
[Document(page_content='玩具们活了起来,并且玩得很开心', metadata={'year': 1995, 'genre': 'animated'})]
过滤器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("有关恐龙的两部电影")
query='dinosaur' filter=None limit=2
[Document(page_content='一群科学家带回恐龙,然后造成了混乱', metadata={'year': 1993, 'rating': 7.7, 'genre': '科幻'}),
Document(page_content='玩具们活了起来,并且玩得很开心', metadata={'year': 1995, 'genre': '动画'})]