创建和编辑提示

本指南将引导您完成在 MLflow 提示词注册表中创建新提示词和管理其版本的流程。

创建新提示词

您可以通过两种主要方式在 MLflow 提示词注册表中启动新提示词：通过 MLflow UI 或以编程方式使用 Python SDK。

UI

1. 导航到 MLflow 实例中的“提示词注册表”部分。
2. 单击“创建提示词”（或类似）按钮。
3. 填写提示词详细信息，例如名称、提示词模板文本和提交消息（可选）

Python

要以编程方式创建新提示词，请使用 mlflow.genai.register_prompt() 函数。这对于自动化提示词创建或将提示词作为大型脚本的一部分进行管理特别有用。

import mlflow

# Use double curly braces for variables in the template
initial_template = """\
Summarize content you are provided with in {{ num_sentences }} sentences.

Sentences: {{ sentences }}
"""

# Chat Style template
initial_template = [
    {
        "role": "system",
        "content": "Summarize content you are provided with in {{ num_sentences }} sentences.",
    },
    {"role": "user", "content": "Sentences: {{ sentences }}"},
]

# Optional Response Format
from pydantic import BaseModel, Field


class ResponseFormat:
    summary: str = Field(..., description="Summary of the content")


# Register a new prompt
prompt = mlflow.genai.register_prompt(
    name="summarization-prompt",
    template=initial_template,
    # Optional: Provide Response Format to get structured output
    response_format=ResponseFormat,
    # Optional: Provide a commit message to describe the changes
    commit_message="Initial commit",
    # Optional: Set tags applies to the prompt (across versions)
    tags={
        "author": "author@example.com",
        "task": "summarization",
        "language": "en",
    },
)

# The prompt object contains information about the registered prompt
print(f"Created prompt '{prompt.name}' (version {prompt.version})")

编辑现有提示词（创建新版本）

提示词版本创建后，其模板和初始元数据是**不可变的**。编辑现有提示词意味着使用您的更改创建该提示词的*新版本*。这种类似 Git 的行为确保了完整的历史记录，并允许您在需要时回滚到以前的版本。

UI

1. 导航到您希望在提示词注册表中编辑的特定提示词。
2. 选择您希望作为新版本基础的版本（通常是最新版本）。
3. 查找“编辑提示词”或“创建新版本”按钮。
4. 根据需要修改模板、更新元数据或更改标签。
5. 提供一条新的**提交消息**，描述您为这个新版本所做的更改。

Python

要创建现有提示词的新版本，您再次使用 mlflow.genai.register_prompt() 函数，但这次，您提供现有提示词的 name。MLflow 将自动递增版本号。

import mlflow

new_template = """\
You are an expert summarizer. Condense the following content into exactly {{ num_sentences }} clear and informative sentences that capture the key points.

Sentences: {{ sentences }}

Your summary should:
- Contain exactly {{ num_sentences }} sentences
- Include only the most important information
- Be written in a neutral, objective tone
- Maintain the same level of formality as the original text
"""

# Register a new version of an existing prompt
updated_prompt = mlflow.genai.register_prompt(
    name="summarization-prompt",  # Specify the existing prompt name
    template=new_template,
    commit_message="Improvement",
    tags={
        "author": "author@example.com",
    },
)

理解不变性

务必记住，MLflow 提示词注册表中的提示词版本是不可变的。一旦调用 mlflow.genai.register_prompt() 并创建了版本（或创建了现有提示词的新版本），该*特定版本*的模板、初始提交消息和初始元数据就无法更改。这种设计选择为可重现性和沿袭跟踪提供了强有力的保证。

如果您需要更改提示词，您总是创建一个新版本。

比较提示词版本

MLflow UI 提供了比较提示词不同版本的工具。这通常包括并排的差异视图，允许您轻松查看版本之间模板文本、元数据或标签中的变化。