使用LlamaIndex进行自动检索

这篇文章将介绍如何使用LlamaIndex进行自动检索。许多流行的向量数据库支持在查询字符串之外的元数据过滤，用于语义搜索。给定一个自然语言查询，首先我们使用大语言模型（LLM）推断一组元数据过滤器以及适当的查询字符串（两者都可以为空）。然后，这个整体查询包被执行到向量数据库中。

通过这种方式，可以实现比Top-k语义搜索更动态、更具表现力的检索形式。给定查询的相关上下文可能只需要在元数据标签上进行过滤，或者需要在筛选集内进行过滤+语义搜索的组合，或者只是原始语义搜索。

我们将通过Chroma演示一个示例，但自动检索也在许多其他向量数据库（如Pinecone，Weaviate等）中实现。

设置

我们首先定义导入并定义一个空的Chroma集合。

如果你在Colab上打开这个笔记本，可能需要安装LlamaIndex 🦙。

%pip install llama-index-vector-stores-chroma
!pip install llama-index

import logging
import sys

logging.basicConfig(stream=sys.stdout, level=logging.INFO)
logging.getLogger().addHandler(logging.StreamHandler(stream=sys.stdout))

# 设置OpenAI
import os
import getpass

os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:")
import openai

openai.api_key = os.environ["OPENAI_API_KEY"]

import chromadb

chroma_client = chromadb.EphemeralClient()
chroma_collection = chroma_client.create_collection("quickstart")

定义一些示例数据

我们将一些包含文本块的示例节点插入到向量数据库中。注意，每个TextNode不仅包含文本，还包含元数据，例如类别和国家/地区。这些元数据字段将在底层向量数据库中进行转换和存储。

from llama_index.core import VectorStoreIndex, StorageContext
from llama_index.vector_stores.chroma import ChromaVectorStore

from llama_index.core.schema import TextNode

nodes = [
    TextNode(
        text=(
            "Michael Jordan is a retired professional basketball player,"
            " widely regarded as one of the greatest basketball players of all"
            " time."
        ),
        metadata={
            "category": "Sports",
            "country": "United States",
        },
    ),
    TextNode(
        text=(
            "Angelina Jolie is an American actress, filmmaker, and"
            " humanitarian. She has received numerous awards for her acting"
            " and is known for her philanthropic work."
        ),
        metadata={
            "category": "Entertainment",
            "country": "United States",
        },
    ),
    TextNode(
        text=(
            "Elon Musk is a business magnate, industrial designer, and"
            " engineer. He is the founder, CEO, and lead designer of SpaceX,"
            " Tesla, Inc., Neuralink, and The Boring Company."
        ),
        metadata={
            "category": "Business",
            "country": "United States",
        },
    ),
    TextNode(
        text=(
            "Rihanna is a Barbadian singer, actress, and businesswoman. She"
            " has achieved significant success in the music industry and is"
            " known for her versatile musical style."
        ),
        metadata={
            "category": "Music",
            "country": "Barbados",
        },
    ),
    TextNode(
        text=(
            "Cristiano Ronaldo is a Portuguese professional footballer who is"
            " considered one of the greatest football players of all time. He"
            " has won numerous awards and set multiple records during his"
            " career."
        ),
        metadata={
            "category": "Sports",
            "country": "Portugal",
        },
    ),
]

用Chroma向量存储构建向量索引

这里我们将数据加载到向量存储中。正如上面提到的，每个节点的文本和元数据将被转换成Chroma中的相应表示。我们现在可以在Chroma中的数据上运行语义查询和元数据过滤。

vector_store = ChromaVectorStore(chroma_collection=chroma_collection)
storage_context = StorageContext.from_defaults(vector_store=vector_store)

index = VectorStoreIndex(nodes, storage_context=storage_context)

定义VectorIndexAutoRetriever

我们定义我们的核心VectorIndexAutoRetriever模块。该模块接受VectorStoreInfo，其中包含向量存储集合的结构化描述及其支持的元数据过滤器信息。此信息将在自动检索提示中使用，LLM将在其中推断元数据过滤器。

from llama_index.core.retrievers import VectorIndexAutoRetriever
from llama_index.core.vector_stores.types import MetadataInfo, VectorStoreInfo

vector_store_info = VectorStoreInfo(
    content_info="brief biography of celebrities",
    metadata_info=[
        MetadataInfo(
            name="category",
            type="str",
            description=(
                "Category of the celebrity, one of [Sports, Entertainment,"
                " Business, Music]"
            ),
        ),
        MetadataInfo(
            name="country",
            type="str",
            description=(
                "Country of the celebrity, one of [United States, Barbados,"
                " Portugal]"
            ),
        ),
    ],
)
retriever = VectorIndexAutoRetriever(
    index, vector_store_info=vector_store_info
)

运行一些示例数据

我们尝试运行一些示例数据。注意如何推断元数据过滤器——这有助于更精确的检索！

retriever.retrieve("Tell me about two celebrities from United States")

INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using query str: celebrities
Using query str: celebrities
INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using filters: {'country': 'United States'}
Using filters: {'country': 'United States'}
INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using top_k: 2
Using top_k: 2

[NodeWithScore(node=TextNode(id_='b2ab3b1a-5731-41ec-b884-405016de5a34', embedding=None, metadata={'category': 'Entertainment', 'country': 'United States'}, excluded_embed_metadata_keys=[], excluded_llm_metadata_keys=[], relationships={}, hash='28e1d0d600908a5e9f0c388f0d49b0cd58920dc13e4f2743becd135ac0f18799', text='Angelina Jolie is an American actress, filmmaker, and humanitarian. She has received numerous awards for her acting and is known for her philanthropic work.', start_char_idx=None, end_char_idx=None, text_template='{metadata_str}\n\n{content}', metadata_template='{key}: {value}', metadata_seperator='\n'), score=0.32621567877748514),
 NodeWithScore(node=TextNode(id_='e0104b6a-676a-4c83-95b7-b018cb8b39b2', embedding=None, metadata={'category': 'Sports', 'country': 'United States'}, excluded_embed_metadata_keys=[], excluded_llm_metadata_keys=[], relationships={}, hash='7456e8d70b089c3830424e49b2a03c8d6d3f5cd0de42b0669a8ee518eca01012', text='Michael Jordan is a retired professional basketball player, widely regarded as one of the greatest basketball players of all time.', start_char_idx=None, end_char_idx=None, text_template='{metadata_str}\n\n{content}', metadata_template='{key}: {value}', metadata_seperator='\n'), score=0.3734030955060519)]
retriever.retrieve("Tell me about Sports celebrities from United States")

参考资料

• LlamaIndex Documentation
• Chroma Documentation

可能遇到的错误

1. API Key错误：确保正确设置了OPENAI_API_KEY环境变量。
2. 模块未安装错误：如果缺少任何模块，请使用pip install进行安装。
3. 数据格式错误：确保插入到向量数据库的数据格式正确。

如果你觉得这篇文章对你有帮助,请点赞,关注我的博客,谢谢!