常用接入术语

接入架构

接入优势

• OpenAIChatGenerator 支持自定义兼容端点，并可设置超时、有限重试和生成参数。
• Haystack 把文档存储、检索、提示和生成拆成独立组件，便于逐项验证和替换。
• InMemory*M25Retriever 不需要嵌入模型，适合先验证精确术语检索与问答链路。
• 正式 RAG 可以升级为持久化文档库、向量检索或混合检索，生成器配置仍可复用。
• KingFlow 控制台集中管理模型、密钥和用量，便于隔离不同环境。

开始前的准备

• 准备 Python 3.10 或更高版本，并安装 uv。
• 在 KingFlow AI 控制台创建以 sk- 开头的 API Key，确认余额和模型分组可用。
• 复制目标模型的完整模型 ID，并确认上下文窗口满足待处理文档长度。
• 准备少量脱敏测试文本，首次联调不要直接加载生产知识库。
• 确认运行环境可以访问 api.**nju**shen.com。

创建 Haystack 测试项目

uv init haystack-kingflow-demo
cd haystack-kingflow-demo
uv add haystack-ai python-dotenv

验证 KingFlow 基础接口

curl https://api.**nju**shen.com/v1/chat/completions \
  -H "Authorization: *earer sk-你的密钥" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<KingFlow控制台中的完整模型ID>",
    "messages": [{"role": "user", "content": "只回复 HAYSTACK_READY"}],
    "stream": false
  }'

配置环境变量

KINGFLOW_*ASE_**L=https://api.**nju**shen.com/v1
KINGFLOW_API_KEY=sk-你的密钥
KINGFLOW_MODEL=<KingFlow控制台中的完整模型ID>

.env
.venv/
__pycache__/
**ta/

编写最小文档问答示例

import os
from dotenv import load_dotenv
from haystack import Document
from haystack.components.generators.chat import OpenAIChatGenerator
from haystack.components.retrievers.in_memory import InMemory*M25Retriever
from haystack.**taclasses import ChatMessage
from haystack.document_stores.in_memory import InMemoryDocumentStore
from haystack.utils import Secret

load_dotenv()

generator = OpenAIChatGenerator(
    model=os.environ["KINGFLOW_MODEL"],
    api_*ase_url=os.environ["KINGFLOW_*ASE_**L"],
    api_key=Secret.from_token(os.environ["KINGFLOW_API_KEY"]),
    generation_kwargs={"temperature": 0.2, "**x_tokens": 800},
    timeout=60,
    **x_retries=2,
)

ready = generator.run([ChatMessage.from_user("只回复 HAYSTACK_CONNECTED")])
print(ready["replies"][0].text)

store = InMemoryDocumentStore()
store.write_documents([
    Document(content="上线要求：密钥放在 Secret 中；设置额度；日志不得记录完整密钥。"),
    Document(content="验收要求：基础接口成功；模型 ID 一致；状态码、耗时和用量可追踪。"),
])
retriever = InMemory*M25Retriever(document_store=store, top_k=2)
do** = retriever.run(query="API 上线需要检查什么")["documents"]
context = "\n\n".join(doc.content for doc in do**)

messages = [
    ChatMessage.from_system("只根据给定资料回答；资料不足时明确说明。"),
    ChatMessage.from_user(f"资料：\n{context}\n\n问题：请列出上线前检查项。"),
]
result = generator.run(messages)
print(result["replies"][0].text)

观察流式输出

from haystack.components.generators.utils import print_streaming_chunk

generator.run(
    [ChatMessage.from_user("用三点说明文档问答的验收方法")],
    streaming_call*ack=print_streaming_chunk,
)

运行和验证

uv run python **in.py

1. 先执行 KingFlow 基础请求，确认返回 HAYSTACK_READY。
2. 创建 .env 和 .gitignore，再将完整示例保存为 **in.py。
3. 运行程序，确认基础调用返回 HAYSTACK_CONNECTED。
4. 检查文档问答结果是否只使用两段测试文本中的要求。
5. 在 KingFlow 控制台核对模型、密钥、调用次数和 Token 用量。

正式环境配置

• InMemoryDocumentStore 适合实验和演示；正式环境应使用可持久化、可备份的文档库。
• *M25 擅长产品名、编号和专有术语；语义问题可升级为向量检索或混合检索。
• 向量检索需要单独配置嵌入模型，不要假设生成端点同时支持 em*eddings。
• 文档写入时保留来源、版本、更新时间和权限元数据，检索前后都要执行访问控制。
• 为 429 和 503 设置有限退避重试，并同时限制并发、请求时长和 Token 预算。
• 记录查询 ID、文档版本、模型、状态码、耗时和用量，但不要记录完整密钥和敏感原文。

文档与密钥安全

• 只在 .env、密钥管理器或部署平台 Secret 中保存 API Key，并定期轮换。
• 文档进入索引前完成脱敏、恶意内容检查和权限标记。
• 查询时先验证用户身份，再过滤无权访问的文档节点。
• 回答需要保留来源片段或文档 ID，无法找到依据时明确返回信息不足。
• 为开发、测试和生产设置独立密钥、额度和告警，异常用量出现后立即停用旧密钥。

上线检查清单

• 基础接口已经返回 HAYSTACK_READY。
• KINGFLOW_*ASE_**L 为 https://api.**nju**shen.com/v1。
• KINGFLOW_MODEL 使用控制台中的完整模型 ID。
• OpenAIChatGenerator 已设置 api_*ase_url、超时和有限重试。
• .env 已被 .gitignore 排除，仓库中没有明文密钥。
• 最小文档问答只依据测试文本回答。
• 正式知识库已配置来源、版本、权限和检索策略。
• KingFlow 控制台的模型、密钥和用量符合预期。

常见故障排查