升级到 Messages API

如需更直接的代码迁移指南，请参阅我们的 API 参考迁移指南。

随着我们不断改进和扩展我们的 AI 能力，我们很高兴地推出了新的 Messages API，它相比我们旧的 Text Completions API 有几个优势。

本指南将帮助您将现有的应用程序从 Text Completions API 迁移到 Messages API，确保平稳过渡并解锁访问我们最新的功能和改进。

​

为什么要升级到 Messages API？

Messages API 提供了几个关键优势：

1. 图像处理：Messages API 是使用 Claude 处理图像的唯一方式，使您能够利用我们先进的计算机视觉功能进行图像分类、对象检测等任务。
2. 使用 Claude 3 模型构建：我们最新和最强大的 Claude 3 模型（Haiku、Sonnet 和 Opus）只能通过 Messages API 调用。通过升级，您将能够利用它们增强的性能和功能。
3. 改进的错误处理：Messages API 允许我们返回更多信息和有用的错误消息，使您更容易诊断和解决请求中的问题。
4. 更好的请求验证：使用 Messages API，我们可以更有效地验证您的 API 请求，确保您获得最高质量的结果和我们模型的最佳性能。

​

如何升级到 Messages API

从 Text Completions API 升级到 Messages API 的最简单方法是使用我们的网页 Console 来转换您的提示。通过使用 Console，您可以快速轻松地将提示和请求迁移到 Messages API，而无需手动重写代码。

只需按照以下步骤操作：

​

1. 转到 Console 并选择要使用的模型

在 Console 中，消息区域右下角有一个模型设置面板。该面板包含一个下拉菜单，您可以在其中选择迁移提示的正确模型。

这也是您根据需要调整任何其他参数的地方，例如 temperature 和要采样的最大 tokens。有关我们的参数的更多信息，请参阅 Messages API 文档。

​

2. 将提示转移到适当的 Console 消息字段中

Text Completions API 提示是包含提示所有部分的多行字符串，例如系统提示和用户轮次。Messages API 将提示的各个部分（如系统提示和用户轮次）拆分为单独的字段。

例如，让我们看看这个 Text Completions API 提示：

Today is March 4, 2024.

H: What are 3 ways to cook apples?

A:

如果不使用 Console，过渡这个提示需要您将代码完全重写为 Messages API。但是，将提示的各个部分（系统提示和用户提示）放入相应的 Console 字段中，可以让您开箱即用地提取正确的预格式化代码。

在 Console 中，上面的提示将如下所示：

请注意，没有 Human: 或 Assistant: 文本，并且系统提示和用户提示属于不同的消息字段。

​

3. 复制预格式化的代码

一旦提示的所有部分都就位并且参数已调整，请单击右上角的 </> Get Code 按钮以查看和复制相应的 Messages API 代码片段，适用于 Python 和 TypeScript。

对于我们的示例提示，</> Get Code 菜单中自动生成的 Python 输出将是：

import anthropic

client = anthropic.Anthropic(
    # defaults to os.environ.get("ANTHROPIC_API_KEY")
    api_key="my_api_key",
)
message = client.messages.create(
    model="claude-3-opus-20240229",
    max_tokens=1000,
    temperature=0,
    system="Today is March 4, 2024.",
    messages=[
        {
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": "What are 3 ways to cook apples?"
                }
            ]
        }
    ]
)
print(message.content)

注意：Console 尚不允许您预填 Claude 的响应（即在 Assistant 轮次中预填文本），但底层的 Messages API 允许。有关如何使用此技术格式化 Messages API 请求的示例，请参阅我们的预填 Claude 响应指南。

​

从其他模型迁移

如果您目前正在使用其他 AI 平台或模型，并希望使用 Messages API 切换到 Claude，我们已经创建了一个全面的指南来帮助您完成这个过程。有关如何使您的提示和代码适应我们的平台的详细说明，请参阅从其他模型迁移。

​

API 文档

有关 Messages API 及其功能的更多信息，请参阅我们的 API 文档：

• Messages API 文档
• [旧版] Text Completions API 文档

如果您在升级到 Messages API 时有任何问题或需要进一步的帮助，请随时联系我们的支持团队。我们随时为您提供帮助，以充分利用我们的 AI 功能，并确保您顺利过渡到 Claude。