创建文本补全

post /v1/complete

[旧版] 创建文本补全。

文本补全 API 是旧版 API。我们建议今后使用 Messages API。

未来的模型和功能将不兼容文本补全。请参阅我们的迁移指南，了解从文本补全迁移到 Messages 的指导。

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

请求体参数

• max_tokens_to_sample: number

  停止前要生成的最大 token 数量。

  请注意，我们的模型可能会在达到此最大值_之前_停止。此参数仅指定要生成的绝对最大 token 数量。

• model: Model

  将完成您的提示的模型。

  详见模型了解更多信息和选项。

  • "claude-opus-4-7" or "claude-mythos-preview" or "claude-opus-4-6" or 14 more

    将完成您的提示的模型。

    详见模型了解更多信息和选项。

    • "claude-opus-4-7"

      用于长时间运行的智能体和编程的前沿智能

    • "claude-mythos-preview"

      新一代智能，在编程和网络安全方面最强

    • "claude-opus-4-6"

      用于长时间运行的智能体和编程的前沿智能

    • "claude-sonnet-4-6"

      速度与智能的最佳组合

    • "claude-haiku-4-5"

      具有接近前沿智能的最快模型

    • "claude-haiku-4-5-20251001"

      具有接近前沿智能的最快模型

    • "claude-opus-4-5"

      结合最高智能与实用性能的高级模型

    • "claude-opus-4-5-20251101"

      结合最高智能与实用性能的高级模型

    • "claude-sonnet-4-5"

      用于智能体和编程的高性能模型

    • "claude-sonnet-4-5-20250929"

      用于智能体和编程的高性能模型

    • "claude-opus-4-1"

      用于专业复杂任务的卓越模型

    • "claude-opus-4-1-20250805"

      用于专业复杂任务的卓越模型

    • "claude-opus-4-0"

      用于复杂任务的强大模型

    • "claude-opus-4-20250514"

      用于复杂任务的强大模型

    • "claude-sonnet-4-0"

      具有扩展思考能力的高性能模型

    • "claude-sonnet-4-20250514"

      具有扩展思考能力的高性能模型

    • "claude-3-haiku-20240307"

      快速且经济高效的模型

  • string

• prompt: string

  您希望 Claude 补全的提示。

  为了正确生成响应，您需要使用交替的 Human: 和 Assistant: 对话轮次来格式化您的提示。例如：

  "
  
  Human: {userQuestion}
  
  Assistant:"
  

  详见提示验证和我们的提示设计指南了解更多详情。

• metadata: optional Metadata

  描述请求元数据的对象。

  • user_id: optional string

    与请求关联的用户的外部标识符。

    这应该是 uuid、哈希值或其他不透明标识符。Anthropic 可能会使用此 ID 来帮助检测滥用行为。请勿包含任何可识别信息，如姓名、电子邮件地址或电话号码。

• stop_sequences: optional array of string

  将导致模型停止生成的序列。

  我们的模型会在 "Human:" 处停止，并且将来可能会包含额外的内置停止序列。通过提供 stop_sequences 参数，您可以包含额外的字符串来使模型停止生成。

• stream: optional boolean

  是否使用服务器发送事件增量式地流式传输响应。

  详见流式传输了解更多详情。

• temperature: optional number

  注入响应的随机性程度。

  默认为 1.0。范围从 0.0 到 1.0。对于分析/多选任务使用接近 0.0 的 temperature，对于创意和生成任务使用接近 1.0 的 temperature。

  请注意，即使 temperature 为 0.0，结果也不会完全确定性。

• top_k: optional number

  仅从每个后续 token 的前 K 个选项中采样。

  用于消除"长尾"低概率响应。在此了解更多技术细节。

  仅建议高级用例使用。

• top_p: optional number

  使用核采样。

  在核采样中，我们按概率递减顺序计算所有选项的累积分布，并在达到 top_p 指定的特定概率时截断。

  仅建议高级用例使用。

返回值

• Completion object { id, completion, model, 2 more }

  • id: string

    唯一对象标识符。

    ID 的格式和长度可能会随时间变化。

  • completion: string

    生成的补全结果，直到停止序列但不包含停止序列。

  • model: Model

    将完成您的提示的模型。

    详见模型了解更多信息和选项。

    • "claude-opus-4-7" or "claude-mythos-preview" or "claude-opus-4-6" or 14 more

      将完成您的提示的模型。

      详见模型了解更多信息和选项。

      • "claude-opus-4-7"

        用于长时间运行的智能体和编程的前沿智能

      • "claude-mythos-preview"

        新一代智能，在编程和网络安全方面最强

      • "claude-opus-4-6"

        用于长时间运行的智能体和编程的前沿智能

      • "claude-sonnet-4-6"

        速度与智能的最佳组合

      • "claude-haiku-4-5"

        具有接近前沿智能的最快模型

      • "claude-haiku-4-5-20251001"

        具有接近前沿智能的最快模型

      • "claude-opus-4-5"

        结合最高智能与实用性能的高级模型

      • "claude-opus-4-5-20251101"

        结合最高智能与实用性能的高级模型

      • "claude-sonnet-4-5"

        用于智能体和编程的高性能模型

      • "claude-sonnet-4-5-20250929"

        用于智能体和编程的高性能模型

      • "claude-opus-4-1"

        用于专业复杂任务的卓越模型

      • "claude-opus-4-1-20250805"

        用于专业复杂任务的卓越模型

      • "claude-opus-4-0"

        用于复杂任务的强大模型

      • "claude-opus-4-20250514"

        用于复杂任务的强大模型

      • "claude-sonnet-4-0"

        具有扩展思考能力的高性能模型

      • "claude-sonnet-4-20250514"

        具有扩展思考能力的高性能模型

      • "claude-3-haiku-20240307"

        快速且经济高效的模型

    • string

  • stop_reason: string

    停止的原因。

    这可能是以下值之一：

    • "stop_sequence"：我们到达了停止序列 -- 由您通过 stop_sequences 参数提供，或模型内置的停止序列
    • "max_tokens"：我们超过了 max_tokens_to_sample 或模型的最大值

  • type: "completion"

    对象类型。

    对于文本补全，始终为 "completion"。

    • "completion"

示例

curl https://api.anthropic.com/v1/complete \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    --max-time 600 \
    -d '{
          "max_tokens_to_sample": 256,
          "model": "claude-2.1",
          "prompt": "\\n\\nHuman: Hello, world!\\n\\nAssistant:",
          "temperature": 1,
          "top_k": 5,
          "top_p": 0.7
        }'

响应

{
  "id": "compl_018CKm6gsux7P8yMcwZbeCPw",
  "completion": " Hello! My name is Claude.",
  "model": "claude-2.1",
  "stop_reason": "stop_sequence",
  "type": "completion"
}