批处理

创建消息批次

client.beta.messages.batches.create(params, options?): BetaMessageBatch

POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次

client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch

GET/v1/messages/batches/{message_batch_id}

此端点是幂等的，可用于轮询消息批次是否完成。要访问消息批次的结果，请向响应中的 results_url 字段发起请求。

列出消息批次

client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>

GET/v1/messages/batches

列出工作区内的所有消息批次。最近创建的批次最先返回。

取消消息批次

client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch

POST/v1/messages/batches/{message_batch_id}/cancel

批次可在处理结束前的任何时间取消。一旦发起取消，批次将进入 canceling 状态，此时系统可能会先完成任何正在进行的、不可中断的请求，然后再最终完成取消。

删除消息批次

client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch

DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果

client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>

GET/v1/messages/batches/{message_batch_id}/results

以 .jsonl 文件的形式流式传输消息批次的结果。

Models

interface BetaDeletedMessageBatch { type: "message_batch_deleted"; id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: string

ID of the Message Batch.

interface BetaMessageBatch { type: "message_batch"; id; archived_at; /* 7 more */ }

interface BetaMessageBatchCanceledResult { type: "canceled" }

type: "canceled"

defaultcanceled

interface BetaMessageBatchErroredResult { type: "errored"; error }

type: "errored"

defaulterrored

error: BetaErrorResponse { type: "error"; error; request_id }

type: "error"

defaulterror

error: BetaError

One of the following:

request_id: string | null

interface BetaMessageBatchExpiredResult { type: "expired" }

type: "expired"

defaultexpired

interface BetaMessageBatchIndividualResponse { custom_id; result }

This is a single line in the response .jsonl file and does not represent the response as a whole.

custom_id: string

Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

Must be unique for each request within the Message Batch.

result: BetaMessageBatchResult

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:

interface BetaMessageBatchRequestCounts { canceled; errored; expired; /* 2 more */ }

canceled: number

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

default0

errored: number

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

default0

expired: number

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

default0

processing: number

Number of requests in the Message Batch that are processing.

default0

succeeded: number

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

default0

type BetaMessageBatchResult = BetaMessageBatchSucceededResult | BetaMessageBatchErroredResult | BetaMessageBatchCanceledResult | BetaMessageBatchExpiredResult

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:

interface BetaMessageBatchSucceededResult { type: "succeeded"; message }

type: "succeeded"

defaultsucceeded

message: BetaMessage { type: "message"; id; container; /* 10 more */ }