Claude API
  1. 消息批次
Claude API
  • API 参考
    • 入门指南
    • IP 地址
    • 版本
    • 错误
    • 速率限制
    • 客户端 SDK
    • 支持地区
    • 获取帮助
    • 亚马逊 BEDROCK API
      • Amazon Bedrock API
    • Vertex AI
      • Vertex AI API
    • 消息
      • 流式消息
      • 从文本补全迁移
      • 消息示例
      • 消息
      • 计算消息令牌数
    • 模型
      • 列出模型
      • 获取模型
    • 消息批次
      • 消息批次示例
      • 创建消息批次
        POST
      • 检索消息批次
        GET
      • 获取消息批次结果
        GET
      • 列出消息批次
        GET
      • 取消消息批次
        POST
      • 删除消息批次
        DELETE
    • 文本补全(传统)
      • 流式文本补全
      • 提示验证
      • 创建文本补全
    • 管理员 API
      • 组织成员管理
        • 获取用户
        • 列出用户
        • 更新用户
        • 移除用户
      • 组织邀请
        • 获取邀请
        • 列出邀请
        • 创建邀请
        • 删除邀请
      • 工作区管理
        • 获取工作区
        • 列出工作区
        • 更新工作区
        • 创建工作区
        • 归档工作区
      • 工作区成员管理
        • 获取工作区成员
        • 列出工作空间成员
        • 添加工作区成员
        • 更新工作空间成员
        • 删除工作区成员
      • API 密钥
        • 获取API密钥
        • 列出API密钥
        • 更新API密钥
  1. 消息批次

消息批次示例

消息批次 API 的使用示例
消息批次 API 支持与消息 API 相同的功能集。虽然本页重点介绍如何使用消息批次 API,但有关消息 API 功能集的示例,请参阅消息 API 示例。

创建消息批次#

Python#

JSON#

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "in_progress",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": null,
  "results_url": null
}

轮询消息批次完成情况#

要轮询消息批次,您需要其 id,该 id 在创建请求时的响应中提供,或通过列出批次获得。示例 id:msgbatch_013Zva2CMHLNnXjNJJKqJ2EF。

Python#

列出工作区中的所有消息批次#

Python#

Output#

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  ...
}
{
  "id": "msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d",
  "type": "message_batch",
  ...
}

获取消息批次结果#

一旦您的消息批次状态为 ended,您就可以查看批次的 results_url 并以 .jsonl 文件的形式获取结果。

Python#

Output#

{
  "id": "my-second-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_018gCsTGsXkYJVqYPxTgDHBU",
      "type": "message",
      ...
    }
  }
}
{
  "custom_id": "my-first-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_01XFDUDYJgAACzvnptvVoYEL",
      "type": "message",
      ...
    }
  }
}

取消消息批次#

在取消后立即,批次的 processing_status 将变为 canceling。您可以使用相同的轮询批次完成技术来轮询取消何时完成,因为被取消的批次最终也会变为 ended 状态,并可能包含结果。

Python#

JSON#

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": "2024-09-24T18:39:03.114875Z",
  "results_url": null
}
修改于 2025-02-25 09:23:11
上一页
获取模型
下一页
创建消息批次
Built with