一个用于与大型语言模型协作编码的轻量级库。请查看 MiniChain Zoo，以了解其工作方式。

编码

• 代码（math_demo.py）：为调用语言模型的 Python 函数添加注解。

@prompt(OpenAI(), template_file="math.pmpt.tpl")
def math_prompt(model, question):
    "使用 Jinja 模板调用 GPT 的提示"
    return model(dict(question=question))

@prompt(Python(), template="import math\n{{code}}")
def python(model, code):
    "调用 Python 解释器的提示"
    code = "\n".join(code.strip().split("\n")[1:-1])
    return model(dict(code=code))

def math_demo(question):
    "将它们串联起来"
    return python(math_prompt(question))

• 链条（Space）：MiniChain 会构建一张图（类似于 PyTorch），记录你所有的调用操作，便于调试和错误处理。

show(math_demo,
     examples=["小于 100 的 3 的幂之和是多少？",
               "前 10 个正整数的和是多少？"],
     subprompts=[math_prompt, python],
     out_type="markdown").queue().launch()

• 模板（math.pmpt.tpl）：提示与代码分离。

...
问题：
一件长袍需要 2 匹蓝色纤维和一半数量的白色纤维。总共需要多少匹纤维？
代码：
2 + 2/2

问题：
{{question}}
代码：

• 安装

pip install minichain
export OPENAI_API_KEY="sk-***"

示例

借助这个库，我们可以在几行代码中实现几种流行的方法。

• 检索增强问答
• 带记忆的聊天
• 信息抽取
• 交错代码（PAL） - (Gao 等人 2022)
• 搜索增强（Self-Ask） - (Press 等人 2022)
• 思维链 - (Wei 等人 2022)

它支持当前主流的后端服务。

• OpenAI（补全 / 嵌入）
• Hugging Face 🤗
• Google 搜索
• Python
• Manifest-ML（AI21、Cohere、Together）
• Bash

为什么选择 Mini-Chain？

目前有许多非常流行的提示链库，例如：LangChain、Promptify 和 GPTIndex。这些库确实很有用，但它们体积庞大且复杂。MiniChain 的目标是用一个轻量级、易于理解的库来实现核心的提示链功能。

教程

Mini-Chain 的核心思想是将函数标注为提示。

@prompt(OpenAI())
def color_prompt(model, input):
    return model(f"如果这是颜色，请回答‘是’，{input}。答案：")

提示函数的行为类似于普通的 Python 函数，但它们是惰性的；你需要调用 run() 才能获取结果。

if color_prompt("blue").run() == "Yes":
    print("这是一种颜色")

你也可以将多个提示串联起来。由于提示是惰性的，如果你想对它们进行操作，需要在函数上添加 @transform() 装饰器。例如：

@transform()
def said_yes(input):
    return input == "Yes"

@prompt(OpenAI())
def adjective_prompt(model, input):
    return model(f"请给出一个形容词来描述 {input}。答案：")

adjective = adjective_prompt("彩虹")
if said_yes(color_prompt(adjective)).run():
    print("这是一种颜色")

我们还提供了一个 template_file 参数，假设模型使用来自 Jinja 语言的模板。这使得我们可以将提示文本与 Python 代码分离。

@prompt(OpenAI(), template_file="math.pmpt.tpl")
def math_prompt(model, question):
    return model(dict(question=question))

可视化

MiniChain 内置了基于 Gradio 的提示可视化系统。如果你构建了一个调用提示链的函数，可以通过调用 show 和 launch 来可视化整个流程。这也可以直接在笔记本中完成。

show(math_demo,
     examples=["小于 100 的 3 的幂之和是多少？",
               "前 10 个正整数的和是多少？"],
     subprompts=[math_prompt, python],
     out_type="markdown").queue().launch()

内存

MiniChain 并没有内置显式的有状态内存类。我们建议将其实现为一个队列。

以下是一个可能对你跟踪响应有用的类。

@dataclass
class State:
    memory: List[Tuple[str, str]]
    human_input: str = ""

    def push(self, response: str) -> "State":
        memory = self.memory 如果长度未超过 MEMORY_LIMIT，则保留全部；否则只保留最近的记录。
        return State(memory + [(self.human_input, response)])

请参阅完整的聊天示例。它会记录最近两次收到的回复。

工具与智能体

MiniChain 不提供“智能体”或“工具”。如果你需要这些功能，可以使用模型的 tool_num 参数，允许你在多个不同的后端之间进行选择。你也可以轻松添加自己的后端（参见 GradioExample）。

@prompt([Python(), Bash()])
def math_prompt(model, input, lang):
    return model(input, tool_num= 0 if lang == "python" else 1)

文档与嵌入

MiniChain 不管理文档和嵌入。我们建议使用 Hugging Face Datasets 库，并结合 FAISS 索引功能。

以下是实现方法。

加载并索引数据集

olympics = datasets.load_from_disk("olympics.data") olympics.add_faiss_index("embeddings")

@prompt(OpenAIEmbed()) def get_neighbors(model, inp, k): embedding = model(inp) res = olympics.get_nearest_examples("embeddings", np.array(embedding), k) return res.examples["content"]

这会创建一个 K 近邻（KNN）提示，它会根据所提问题的嵌入向量查找最接近的 3 个文档。
请参阅完整的 [检索增强型问答](https://srush.github.io/MiniChain/examples/qa/) 示例。


我们建议使用 datasets 库的批处理映射功能离线生成这些嵌入。

```python
def embed(x):
    emb = openai.Embedding.create(input=x["content"], engine=EMBEDDING_MODEL)
    return {"embeddings": [np.array(emb['data'][i]['embedding'])
                           for i in range(len(emb["data"]))]}
x = dataset.map(embed, batch_size=BATCH_SIZE, batched=True)
x.save_to_disk("olympics.data")

还有其他方法可以实现这一点，例如 sqllite 或 Weaviate。

类型化提示

MiniChain 可以自动为你生成一个提示头，旨在确保输出符合给定的类型规范。例如，如果你运行以下代码，MiniChain 将生成一个返回 Player 对象列表的提示。

class StatType(Enum):
    POINTS = 1
    REBOUNDS = 2
    ASSISTS = 3

@dataclass
class Stat:
    value: int
    stat: StatType

@dataclass
class Player:
    player: str
    stats: List[Stat]


@prompt(OpenAI(), template_file="stats.pmpt.tpl", parser="json")
def stats(model, passage):
    out = model(dict(passage=passage, typ=type_to_prompt(Player)))
    return [Player(**j) for j in out]

具体来说，它会为你的模板提供一个字符串 typ，你可以使用它。对于这个示例，该字符串将如下所示：

你是一个高度智能且准确的信息提取系统。你以段落作为输入，任务是找出段落中回答问题的部分。

你需要输出一个 JSON 编码的值列表。

你需要将“color”键分类到以下类型：

RED
GREEN
BLUE


只能从上述列表或“Other”中选择。⏎


你需要将“object”键分类到以下类型：⏎

String



你需要将“explanation”键分类到以下类型：⏎

String

[{ "color" : "color" ,  "object" : "object" ,  "explanation" : "explanation"}, ...]

请确保每个输出都与文档中的内容完全一致。尽可能多地找到它们。

然后，这段文本会被自动转换为你所需的对象。

MiniChain 快速上手指南

MiniChain 是一个轻量级的 Python 库，专为使用大型语言模型（LLM）进行编程而设计。它通过装饰器将函数标注为提示词（Prompt），支持构建复杂的调用链、可视化调试以及类型化输出，旨在以极简的代码实现 LangChain 等大型库的核心功能。

环境准备

• 系统要求：Python 3.8+
• 前置依赖：
  • OpenAI API Key（用于调用 GPT 模型）
  • 可选：Hugging Face 账号（用于本地模型或数据集）、Google Search API 等
• 网络环境：由于需要连接 OpenAI 或其他海外模型服务，请确保网络通畅或配置好代理。

安装步骤

1. 使用 pip 安装 MiniChain：

   pip install minichain
   

2. 配置 OpenAI API 密钥（Linux/macOS）：

   export OPENAI_API_KEY="sk-***"
   

   (Windows PowerShell 用户请使用 $env:OPENAI_API_KEY="sk-***")

基本使用

MiniChain 的核心理念是将函数装饰为 Prompt。以下是两个最基础的使用场景。

1. 最简单的 Prompt 调用

使用 @prompt 装饰器定义一个函数，该函数在调用时是“惰性”的（lazy），需要执行 .run() 才能获取结果。

from minichain import prompt, OpenAI

@prompt(OpenAI())
def color_prompt(model, input):
    return model(f"Answer 'Yes' if this is a color, {input}. Answer:")

# 调用并运行
if color_prompt("blue").run() == "Yes":
    print("It's a color")

2. 构建提示词链 (Chaining)

你可以将多个 Prompt 函数串联起来。如果需要处理中间结果，可以使用 @transform 装饰器。

from minichain import prompt, transform, OpenAI

@transform()
def said_yes(input):
    return input == "Yes"

@prompt(OpenAI())
def adjective_prompt(model, input):
    return model(f"Give an adjective to describe {input}. Answer:")

@prompt(OpenAI())
def color_prompt(model, input):
    return model(f"Answer 'Yes' if this is a color, {input}. Answer:")

# 链式调用：先生成形容词，再判断是否为颜色
adjective = adjective_prompt("rainbow")
if said_yes(color_prompt(adjective)).run():
    print("It's a color")

3. 使用模板分离代码与提示词

为了保持代码整洁，MiniChain 支持使用 Jinja2 模板文件来管理提示词内容。

模板文件 (math.pmpt.tpl)：

Question:
{{question}}
Code:

Python 代码：

from minichain import prompt, OpenAI

@prompt(OpenAI(), template_file="math.pmpt.tpl")
def math_prompt(model, question):
    return model(dict(question=question))

# 运行
result = math_prompt("What is 2 + 2?").run()
print(result)

4. 可视化调试 (可选)

MiniChain 内置基于 Gradio 的可视化系统，可以直观地看到 Prompt 链的执行图和结果。

from minichain import show

# 假设 math_demo 是你定义的一个组合函数
show(math_demo,
     examples=["What is the sum of the powers of 3 (3^i) that are smaller than 100?"],
     subprompts=[math_prompt],
     out_type="markdown").queue().launch()