使用模式

开始使用

从索引构建查询引擎

query_engine = index.as_query_engine()

提示

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

就您的数据提问

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

# build index
index = VectorStoreIndex.from_documents(documents)

# configure retriever
retriever = VectorIndexRetriever(
    index=index,
    similarity_top_k=2,
)

# configure response synthesizer
response_synthesizer = get_response_synthesizer(
    response_mode="tree_summarize",
)

# assemble query engine
query_engine = RetrieverQueryEngine(
    retriever=retriever,
    response_synthesizer=response_synthesizer,
)

# query
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 Query Engine."""

    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

有关更多详细信息，请参阅自定义查询引擎指南。