Claude Platform Docs

バッチ

メッセージバッチを作成
messages.batches.create(**kwargs) -> MessageBatch
POST/v1/messages/batches

メッセージ作成リクエストのバッチを送信します。

メッセージバッチを取得
messages.batches.retrieve(message_batch_id, **kwargs) -> MessageBatch
GET/v1/messages/batches/{message_batch_id}

このエンドポイントはべき等であり、メッセージバッチの完了をポーリングするために使用できます。メッセージバッチの結果にアクセスするには、レスポンス内のresults_urlフィールドに対してリクエストを行ってください。

メッセージバッチの一覧
messages.batches.list(**kwargs) -> Page<MessageBatch>
GET/v1/messages/batches

ワークスペース内のすべてのメッセージバッチを一覧表示します。最も新しく作成されたバッチが最初に返されます。

メッセージバッチをキャンセル
messages.batches.cancel(message_batch_id, **kwargs) -> MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

バッチは処理が終了する前であればいつでもキャンセルできます。キャンセルが開始されると、バッチはcanceling状態になり、この間にシステムはキャンセルを確定する前に、進行中の中断不可能なリクエストを完了させる場合があります。

メッセージバッチを削除
messages.batches.delete(message_batch_id, **kwargs) -> DeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

メッセージバッチを削除します。

メッセージバッチの結果を取得
messages.batches.results_streaming(message_batch_id, **kwargs) -> JsonLStream<MessageBatchIndividualResponse>
GET/v1/messages/batches/{message_batch_id}/results

メッセージバッチの結果を.jsonlファイルとしてストリーミングします。

Models
class DeletedMessageBatch { type: :message_batch_deleted, id }
type: :message_batch_deleted

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: String

ID of the Message Batch.

class MessageBatch { type: :message_batch, id, archived_at, 7 more }
class MessageBatchCanceledResult { type: :canceled }
type: :canceled
class MessageBatchErroredResult { type: :errored, error }
type: :errored
error: ErrorResponse { type: :error, error, request_id }
type: :error
error: ErrorObject
One of the following:
request_id: String
class MessageBatchExpiredResult { type: :expired }
type: :expired
class MessageBatchIndividualResponse { 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: MessageBatchResult

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 MessageBatchRequestCounts { canceled, errored, expired, 2 more }
canceled: Integer

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

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

errored: Integer

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

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

expired: Integer

Number of requests in the Message Batch that have expired.

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

processing: Integer

Number of requests in the Message Batch that are processing.

succeeded: Integer

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

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

type MessageBatchResult = MessageBatchSucceededResult | MessageBatchErroredResult | MessageBatchCanceledResult | MessageBatchExpiredResult

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 MessageBatchSucceededResult { type: :succeeded, message }
type: :succeeded
message: Message { type: :message, id, container, 8 more }