Claude Platform Docs

取消訊息批次

messages.batches.cancel(message_batch_id, **kwargs) -> MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

批次可在處理結束前隨時取消。一旦啟動取消，批次便會進入 canceling 狀態，此時系統可能會先完成任何進行中且不可中斷的請求，然後才完成取消。

已取消的請求數量會在 request_counts 中指明。若要判斷哪些請求已被取消，請檢查批次內的個別結果。請注意，若請求皆不可中斷，取消作業可能不會產生任何已取消的請求。

在我們的使用者指南中進一步瞭解 Message Batches API

Parameters
message_batch_id: String⁠Path parameter

ID of the Message Batch.

workspace_id: String⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
class MessageBatch { type: :message_batch, id, archived_at, 7 more }
取消訊息批次
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

message_batch = anthropic.messages.batches.cancel("message_batch_id")

puts(message_batch)
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "archived_at": "2024-08-20T18:37:24.100435Z",
  "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
  "created_at": "2024-08-20T18:37:24.100435Z",
  "ended_at": "2024-08-20T18:37:24.100435Z",
  "expires_at": "2024-08-20T18:37:24.100435Z",
  "processing_status": "in_progress",
  "request_counts": {
    "canceled": 10,
    "errored": 30,
    "expired": 10,
    "processing": 100,
    "succeeded": 50
  },
  "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
  "type": "message_batch"
}