本指南展示如何在 LlamaIndex 中执行自动检索。

许多流行的向量数据库除了语义搜索的查询字符串外，还支持一组元数据过滤器。给定自然语言查询，我们首先使用 LLM 推断一组元数据过滤器以及要传给向量数据库的正确查询字符串（两者都可以为空）。然后，这个整体查询包会针对向量数据库执行。

这允许超越 top-k 语义搜索，实现更动态、更具表现力的检索形式。给定查询的相关上下文可能只需要对元数据标签进行过滤，或者需要在过滤集内进行过滤 + 语义搜索的联合组合，或者只需要原始语义搜索。

我们以 Elasticsearch 为例进行演示，但自动检索也在许多其他向量数据库中实现（例如 Pinecone、Weaviate 等）。

设置

我们首先定义导入。

如果你在 Colab 中打开这个 Notebook，可能需要先安装 LlamaIndex 🦙。

%pip install llama-index-vector-stores-elasticsearch

!pip install llama-index

import logging
import sys

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

# set up 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"]

定义一些示例数据

我们向向量数据库中插入一些包含文本分块的示例节点。请注意，每个 TextNode 不仅包含文本，还包含元数据，例如 category 和 country。这些元数据字段将按原样转换/存储在底层向量数据库中。

from llama_index.core import VectorStoreIndex, StorageContext
from llama_index.vector_stores.elasticsearch import ElasticsearchStore

from llama_index.core.schema import TextNode

nodes = [
    TextNode(
        text=(
            "A bunch of scientists bring back dinosaurs and mayhem breaks"
            " loose"
        ),
        metadata={"year": 1993, "rating": 7.7, "genre": "science fiction"},
    ),
    TextNode(
        text=(
            "Leo DiCaprio gets lost in a dream within a dream within a dream"
            " within a ..."
        ),
        metadata={
            "year": 2010,
            "director": "Christopher Nolan",
            "rating": 8.2,
        },
    ),
    TextNode(
        text=(
            "A psychologist / detective gets lost in a series of dreams within"
            " dreams within dreams and Inception reused the idea"
        ),
        metadata={"year": 2006, "director": "Satoshi Kon", "rating": 8.6},
    ),
    TextNode(
        text=(
            "A bunch of normal-sized women are supremely wholesome and some"
            " men pine after them"
        ),
        metadata={"year": 2019, "director": "Greta Gerwig", "rating": 8.3},
    ),
    TextNode(
        text="Toys come alive and have a blast doing so",
        metadata={"year": 1995, "genre": "animated"},
    ),
]

使用 Elasticsearch 向量存储构建向量索引

在这里，我们将数据加载到向量存储中。如上所述，每个节点的文本和元数据都将转换为 Elasticsearch 中的相应表示。现在，我们可以对此数据运行语义查询，并在 Elasticsearch 上执行元数据过滤。

vector_store = ElasticsearchStore(
    index_name="auto_retriever_movies", es_url="http://localhost:9200"
)
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 import MetadataInfo, VectorStoreInfo

vector_store_info = VectorStoreInfo(
    content_info="Brief summary of a movie",
    metadata_info=[
        MetadataInfo(
            name="genre",
            description="The genre of the movie",
            type="string or list[string]",
        ),
        MetadataInfo(
            name="year",
            description="The year the movie was released",
            type="integer",
        ),
        MetadataInfo(
            name="director",
            description="The name of the movie director",
            type="string",
        ),
        MetadataInfo(
            name="rating",
            description="A 1-10 rating for the movie",
            type="float",
        ),
    ],
)
retriever = VectorIndexAutoRetriever(
    index, vector_store_info=vector_store_info
)

在一些示例数据上运行

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

retriever.retrieve(
    "What are 2 movies by Christopher Nolan were made before 2020?"
)

retriever.retrieve("Has Andrei Tarkovsky directed any science fiction movies")

INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using query str: science fiction
Using query str: science fiction
INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using filters: {'director': 'Andrei Tarkovsky'}
Using filters: {'director': 'Andrei Tarkovsky'}
INFO:llama_index.indices.vector_store.retrievers.auto_retriever.auto_retriever:Using top_k: 2
Using top_k: 2
INFO:elastic_transport.transport:POST http://localhost:9200/auto_retriever_movies/_search [status:200 duration:0.042s]
POST http://localhost:9200/auto_retriever_movies/_search [status:200 duration:0.042s]

[]