Skip to content

使用模式#

快速开始#

从索引构建查询引擎：

query_engine = index.as_query_engine()

Tip

要了解如何构建索引，请参阅索引

对数据进行提问：

response = query_engine.query("Who is Paul Graham?")

配置查询引擎#

高级API#

您可以直接用一行代码从索引构建并配置查询引擎：

query_engine = index.as_query_engine(
    response_mode="tree_summarize",
    verbose=True,
)

注意：虽然高级API优化了易用性，但它_不会_暴露全部的可配置选项。

完整响应模式列表及其功能请见响应模式。

低级组合API#

如果需要更细粒度的控制，可以使用低级组合API。具体来说，您需要显式构造一个QueryEngine对象，而不是调用index.as_query_engine(...)。

注意：您可能需要查看API参考或示例笔记本。

from llama_index.core import VectorStoreIndex, get_response_synthesizer
from llama_index.core.retrievers import VectorIndexRetriever
from llama_index.core.query_engine import RetrieverQueryEngine

# 构建索引
index = VectorStoreIndex.from_documents(documents)

# 配置检索器
retriever = VectorIndexRetriever(
    index=index,
    similarity_top_k=2,
)

# 配置响应合成器
response_synthesizer = get_response_synthesizer(
    response_mode="tree_summarize",
)

# 组装查询引擎
query_engine = RetrieverQueryEngine(
    retriever=retriever,
    response_synthesizer=response_synthesizer,
)

# 查询
response = query_engine.query("What did the author do growing up?")
print(response)

流式传输#

要启用流式传输，只需传入streaming=True标志：

query_engine = index.as_query_engine(
    streaming=True,
)
streaming_response = query_engine.query(
    "What did the author do growing up?",
)
streaming_response.print_response_stream()

定义自定义查询引擎#

您也可以定义自定义查询引擎。只需继承CustomQueryEngine类，定义所需的任何属性（类似于定义Pydantic类），并实现一个返回Response对象或字符串的custom_query函数。

from llama_index.core.query_engine import CustomQueryEngine
from llama_index.core.retrievers import BaseRetriever
from llama_index.core import get_response_synthesizer
from llama_index.core.response_synthesizers import BaseSynthesizer


class RAGQueryEngine(CustomQueryEngine):
    """RAG查询引擎"""

    retriever: BaseRetriever
    response_synthesizer: BaseSynthesizer

    def custom_query(self, query_str: str):
        nodes = self.retriever.retrieve(query_str)
        response_obj = self.response_synthesizer.synthesize(query_str, nodes)
        return response_obj

更多详情请参阅自定义查询引擎指南。