提示词模板化
通过识别和提取变量来将提示词模板化
提示词工具 API 目前处于封闭研究预览阶段。申请加入封闭研究预览。
开始之前
提示词工具是一组用于生成和改进提示词的 API。与我们的其他 API 不同，这是一个实验性 API：您需要申请访问权限，并且它不像其他 API 那样对长期支持有相同程度的承诺。
这些 API 与 Anthropic Workbench 中提供的功能类似，旨在供其他提示词工程平台和实验环境使用。
开始使用提示词改进器
要使用提示词生成 API，您需要：
- 已加入提示词工具 API 的封闭研究预览
- 直接使用 API，而不是 SDK
- 添加测试版标头
prompt-tools-2025-04-02
此 API 在 SDK 中不可用
提示词模板化
Headers
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.
Body
The prompt to templatize, structured as a list of message objects.
Each message in the messages array must:
- Contain only text-only content blocks
- Not include tool calls, images, or prompt caching blocks
Example of a simple text prompt:
[
{
"role": "user",
"content": [
{
"type": "text",
"text": "Translate hello to German"
}
]
}
]
Note that only contiguous user messages with text content are allowed. Assistant prefill is permitted, but other content types will cause validation errors.
The existing system prompt to templatize.
{
"system": "You are a professional English to German translator",
[...]
}
Note that this differs from the Messages API; it is strictly a string.
Response
The templatized prompt with variable placeholders.
The response includes the input messages with specific values replaced by variable placeholders. These messages maintain the original message structure but contain uppercase variable names in place of concrete values.
For example, an input message content like "Translate hello to German" would be transformed to "Translate {{WORD_TO_TRANSLATE}} to {{TARGET_LANGUAGE}}".
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "Translate {{WORD_TO_TRANSLATE}} to {{TARGET_LANGUAGE}}"
}
]
}
]
}
The input system prompt with variables identified and replaced.
If no system prompt was provided in the original request, this field will be an empty string.
Usage information
A mapping of template variable names to their original values, as extracted from the input prompt during templatization. Each key represents a variable name identified in the templatized prompt, and each value contains the corresponding content from the original prompt that was replaced by that variable.
Example:
"variable_values": {
"WORD_TO_TRANSLATE": "hello",
"TARGET_LANGUAGE": "German"
}
In this example response, the original prompt – Translate hello to German – was templatized to Translate WORD_TO_TRANSLATE to TARGET_LANGUAGE, with the variable values extracted as shown.
Was this page helpful?