レガシーAPI

Text Completions APIはレガシーAPIです。将来のモデルと機能ではMessages APIの使用が必要となり、可能な限り早期の移行を推奨します。

Text Completionを作成する際、"stream": trueを設定することで、server-sent events (SSE)を使用してレスポンスを段階的にストリーミングできます。クライアントライブラリを使用している場合、これらのイベントの解析は自動的に処理されます。ただし、直接API統合を構築している場合は、これらのイベントを自分で処理する必要があります。

​
例

Shell
curl https://api.anthropic.com/v1/complete \
     --header "anthropic-version: 2023-06-01" \
     --header "content-type: application/json" \
     --header "x-api-key: $ANTHROPIC_API_KEY" \
     --data '
{
  "model": "claude-2",
  "prompt": "\n\nHuman: Hello, world!\n\nAssistant:",
  "max_tokens_to_sample": 256,
  "stream": true
}
'
Response
event: completion
data: {"type": "completion", "completion": " Hello", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": "!", "stop_reason": null, "model": "claude-2.0"}

event: ping
data: {"type": "ping"}

event: completion
data: {"type": "completion", "completion": " My", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": " name", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": " is", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": " Claude", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": ".", "stop_reason": null, "model": "claude-2.0"}

event: completion
data: {"type": "completion", "completion": "", "stop_reason": "stop_sequence", "model": "claude-2.0"}

​
イベント

各イベントには、名前付きイベントタイプと関連するJSONデータが含まれます。

イベントタイプ：completion、ping、error。

​
エラーイベントタイプ

イベントストリーム内でエラーを送信することがあります。例えば、使用量が多い期間中に、非ストリーミングコンテキストでは通常HTTP 529に対応するoverloaded_errorを受信する場合があります：

Example error
event: completion
data: {"completion": " Hello", "stop_reason": null, "model": "claude-2.0"}

event: error
data: {"error": {"type": "overloaded_error", "message": "Overloaded"}}

​
古いAPIバージョン

2023-06-01より前のAPIバージョンを使用している場合、レスポンスの形状が異なります。詳細についてはバージョニングを参照してください。