Claude Platform Docs

메시지 배치 취소

client.Messages.Batches.Cancel(ctx, messageBatchID, body) (*MessageBatch, error)
POST/v1/messages/batches/{message_batch_id}/cancel

배치는 처리가 종료되기 전까지 언제든지 취소할 수 있습니다. 취소가 시작되면 배치는 canceling 상태로 전환되며, 이 시점에서 시스템은 취소를 최종 완료하기 전에 진행 중이며 중단할 수 없는 요청을 먼저 완료할 수 있습니다.

취소된 요청의 수는 request_counts에 명시됩니다. 어떤 요청이 취소되었는지 확인하려면 배치 내의 개별 결과를 확인하세요. 요청이 중단할 수 없는 경우 취소를 수행해도 실제로 취소된 요청이 없을 수 있습니다.

Message Batches API에 대한 자세한 내용은 사용자 가이드를 참조하세요.

Parameters
messageBatchID string⁠Path parameter

ID of the Message Batch.

body MessageBatchCancelParams
WorkspaceID param.Opt[string] OptionalHeader 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
type MessageBatch struct { Type: "message_batch"; ID; ArchivedAt; /* 7 more */ }
메시지 배치 취소
package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	messageBatch, err := client.Messages.Batches.Cancel(
		context.TODO(),
		"message_batch_id",
		anthropic.MessageBatchCancelParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", messageBatch.ID)
}
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"
}