批处理

创建消息批次

BetaMessageBatch beta().messages().batches().create(params, requestOptions = RequestOptions.none())

POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次

BetaMessageBatch beta().messages().batches().retrieve(params = BatchRetrieveParams.none(), requestOptions = RequestOptions.none())

GET/v1/messages/batches/{message_batch_id}

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

列出消息批次

BatchListPage beta().messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())

GET/v1/messages/batches

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

取消消息批次

BetaMessageBatch beta().messages().batches().cancel(params = BatchCancelParams.none(), requestOptions = RequestOptions.none())

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

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

删除消息批次

BetaDeletedMessageBatch beta().messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())

DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果

StreamResponse<BetaMessageBatchIndividualResponse> beta().messages().batches().resultsStreaming(params = BatchResultsParams.none(), requestOptions = RequestOptions.none())

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

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

Models

class BetaDeletedMessageBatch { type = "message_batch_deleted"; id; }

JsonValue type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

String id

ID of the Message Batch.

class BetaMessageBatch { type = "message_batch"; id; archivedAt; /* 7 more */ }

class BetaMessageBatchCanceledResult { type = "canceled"; }

JsonValue type = "canceled"

class BetaMessageBatchErroredResult { type = "errored"; error; }

JsonValue type = "errored"

BetaErrorResponse error

JsonValue type = "error"

BetaError error

One of the following:

Optional<String> requestId

class BetaMessageBatchExpiredResult { type = "expired"; }

JsonValue type = "expired"

class BetaMessageBatchIndividualResponse { customId; result; }

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

String customId

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.

BetaMessageBatchResult result

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:

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

long canceled

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

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

long errored

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

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

long expired

Number of requests in the Message Batch that have expired.

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

long processing

Number of requests in the Message Batch that are processing.

long succeeded

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

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

class BetaMessageBatchResult: union

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.

class BetaMessageBatchSucceededResult { type = "succeeded"; message; }

JsonValue type = "succeeded"

BetaMessage message