如需更直接的代碼遷移指南,請參閱我們的 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 提示:

Text
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 輸出將是:

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 有任何疑問或需要進一步的幫助,請隨時聯繫我們的支持團隊。我們隨時為您提供幫助,以充分利用我們的 AI 功能,並確保順利過渡到 Claude。